VPCリストの照会

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://clouddatastreamingservice.apigw.ntruss.com/api/v1/cluster/getVpcList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

`result.content`

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

フィールド	タイプ	必須の有無	説明
`createdDate`	Object	-	作成日
`createdDate.formattedDate`	String	-	作成日 yyyy-MM-dd形式
`createdDate.formattedDateTime`	String	-	作成日時 yyyy-MM-dd HH:mm:ss SSSSSS形式
`createdDate.utc`	Integer	-	作成日時(ミリ秒) Unix Timestamp形式
`ipv4Cidr`	String	-	VPCの IPv4 CIDRブロック
`regionNo`	String	-	リージョン番号
`statusCode`	String	-	VPCの状態
`vpcName`	String	-	VPC名
`vpcNo`	Integer	-	VPC番号
`permission`	String	-	サブアカウントは使用可能かどうか `Allow` \| `Deny` `Allow`: 使用可能 `Deny`: 使用不可 `Deny`の場合、サブアカウントにgetVPCDetail権限を付与すると使用可能

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

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

レスポンス例

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "error": null,
        "content": [
            {
                "createdDate": {
                    "formattedDate": "2025-04-23",
                    "formattedDateTime": "2025-04-23 10:16:15 000723",
                    "utc": 1669166175723
                },
                "ipv4Cidr": "172.16.0.0/16",
                "regionNo": "1",
                "statusCode": "RUN",
                "vpcName": "vpc-123",
                "vpcNo": 6***,
                "permission": "Allow"
            },
            ...
        ]
    },
    "requestId": "bc097a35-****-****-****-a91032324b21"
}