Subnetリストの照会

Prev Next

VPC環境で利用できます。

使用可能な Subnetリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/cluster/getSubnetList (韓国リージョン)
POST /api/sgn-v1/cluster/getSubnetList (シンガポールリージョン)
POST /api/jpn-v1/cluster/getSubnetList (日本リージョン)

リクエストヘッダ

Cloud Data Streaming Service APIで共通して使用されるヘッダの詳細は、Cloud Data Streaming Serviceのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
softwareProductCode String Required OSタイプコード
vpcNo Integer Required VPC番号

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getSubnetList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "softwareProductCode": "SW.VCDSS.OS.LNX64.CNTOS.0708.B050",
  "vpcNo": 4***
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code Integer - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.error String - エラーメッセージ
result.content Array - Subnetリスト
requestId String - リクエスト ID
  • UUID形式

result.content

result.contentの説明は次の通りです。

フィールド タイプ 必須の有無 説明
isPublic Boolean - Public Subnetかどうか
  • true | false
    • true: Public Subnet
    • false: Private Subnet
subnet String - Subnetの IPv4 CIDRブロック
subnetName String - Subnet名
subnetNo Integer - Subnet番号
vpcName String - VPC名
vpcNo Integer - VPC番号
zoneName String - ゾーン名
zoneNo Integer - ゾーン番号
permission String - サブアカウントは使用可能かどうか
  • Allow | Deny
    • Allow: 使用可能
    • Deny: 使用不可
  • Denyの場合、サブアカウントにgetSubnetDetail権限を付与すると使用可能

レスポンスステータスコード

Cloud Data Streaming Service APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Data Streaming Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "error": null,
        "content": [
            {
                "isPublic": false,
                "subnet": "10.0.20.0/24",
                "subnetName": "sb2",
                "subnetNo": 3****,
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "permission": "Allow"
            },
            {
                "isPublic": true,
                "subnet": "10.0.10.0/24",
                "subnetName": "sb1",
                "subnetNo": 3****,
                "vpcName": "test-vpc2",
                "vpcNo": 4***,
                "zoneName": "KR-2",
                "zoneNo": 3,
                "permission": "Allow"
            }
        ]
    },
    "requestId": "62453978-****-****-****-507a08571383"
}