IRR Objects - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)
Download OpenAPI specification:Download
IRR オブジェクトリソース 申込 API
IRR オブジェクトリソース 申込 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
request body
customerNote | string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容) |
customerAsNumber required | integer OCN との接続に利用する, ユーザー自身のグローバル AS 番号. |
objectType required | string Enum: "aut-num" "as-set" OCN が参照すべき IRR オブジェクト の種別. |
objectName required | string OCN が参照すべき IRR オブジェクト の名称. |
sources required | Array of strings [ 1 .. 3 ] items Items Enum: "JPIRR" "RADB" "NTTCOM" "APNIC" "RIPE" "ARIN" "LACNIC" "AFRINIC" OCN が参照すべき IRR データベース.
|
Responses
Accepted
Request samples
- Payload
{- "customerNote": "IRR Object example",
- "customerAsNumber": 65001,
- "objectType": "as-set",
- "objectName": "AS-EXAMPLE-V4",
- "sources": [
- "RADB",
- "JPIRR",
- "NTTCOM"
]
}
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "irrObjectId": "ox0000000001",
- "resourceStatus": "inactive",
- "orderId": "097d4feec2f743f0873c3280b09e75be",
- "orderStatus": "applied",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-21T10:05:48+09:00",
- "customerNote": "IRR Object example",
- "customerAsNumber": 65001,
- "objectType": "asSet",
- "objectName": "AS-EXAMPLE-V4",
- "sources": [
- "RADB",
- "JPIRR",
- "NTTCOM"
]
}
IRR オブジェクトリソース 一覧 API
IRR オブジェクトリソース 一覧 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "irrObjects": [
- {
- "tenantId": "550e8400e29b41d4a716446655440000",
- "irrObjectId": "ox0000000000",
- "resourceStatus": "inactive",
- "orderId": "62ec2b62646740b5809f695dea7b2bbf",
- "orderStatus": "applied",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-21T10:05:48+09:00",
- "serviceStartDate": "2020-01-15",
- "customerNote": "project-A 用のリソース",
- "customerAsNumber": 65001,
- "objectType": "as-set",
- "objectName": "AS-EXAMPLE-V4",
- "sources": [
- "JPIRR"
]
}
]
}
IRR オブジェクトリソース 参照 API
IRR オブジェクトリソース 参照 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "irrObjectId": "ox0000000001",
- "resourceStatus": "active",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-30T11:00:00+09:00",
- "serviceStartDate": "2020-05-30",
- "customerNote": "IRR Object example",
- "customerAsNumber": 65001,
- "objectType": "as-set",
- "objectName": "AS-EXAMPLE-V4",
- "sources": [
- "RADB",
- "JPIRR",
- "NTTCOM"
]
}
IRR オブジェクトリソース 変更 API
IRR オブジェクトリソース 変更 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
request body
customerNote | string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容) |
sources | Array of strings [ 1 .. 3 ] items Items Enum: "JPIRR" "RADB" "NTTCOM" "APNIC" "RIPE" "ARIN" "LACNIC" "AFRINIC" OCN が参照すべき IRR データベース.
|
Responses
Accepted
Request samples
- Payload
{- "customerNote": "IRR Object example with new sources",
- "sources": [
- "RIPE",
- "APNIC"
]
}
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "irrObjectId": "ox0000000001",
- "resourceStatus": "active",
- "orderId": "097d4feec2f743f0873c3280b09e75be",
- "orderStatus": "processing",
- "creationTime": "2019-05-21T10:05:48+09:00",
- "updateTime": "2019-05-30T11:00:00+09:00",
- "serviceStartDate": "2020-05-30",
- "customerNote": "IRR Object example with new sources",
- "customerAsNumber": 65001,
- "objectType": "asSet",
- "objectName": "AS-EXAMPLE-V4",
- "sources": [
- "RIPE",
- "APNIC"
]
}
IRR オブジェクトリソース 削除 API
IRR オブジェクトリソース 削除 API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Response samples
- 202
{- "tenantId": "550e8400e29b41d4a716446655440000",
- "irrObjectId": "ox0000000001",
- "resourceStatus": "active",
- "orderId": "097d4feec2f743f0873c3280b09e75be",
- "orderStatus": "processing"
}
申込履歴情報を一覧参照する API
申込履歴情報を一覧参照する API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{- "orders": [
- { }
]
}
指定の申込履歴情報を参照する API
指定の申込履歴情報を参照する API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
orderId required | string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Response samples
- 200
{ }
申込内容に変更を加える API
申込内容に変更を加える API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
orderId required | string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
request body
Responses
Accepted
Request samples
- Payload
{ }
Response samples
- 202
{ }
指定の申込を取り消す API
指定の申込を取り消す API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
orderId required | string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted
Response samples
- 202
{ }
AS 管理者確認プロセスのステータスを参照する API
AS 管理者確認プロセスのステータスを参照する API
path Parameters
tenantId required | string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式 |
irrObjectId required | string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁 |
header Parameters
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK