getVpcList
- 印刷する
- PDF
getVpcList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
ユーザーが指定した条件に基づいて VPCリストを検索します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET、POST | /getVpcList |
リクエストヘッダ
VPC APIで共通して使用されるヘッダの詳細は、VPCの共通ヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode | String | Optional | VPCリスト照会対象のリージョンコード |
vpcStatusCode | String | Optional | VPC状態コードで VPCリストを照会
|
vpcName | String | Optional | VPC名で VPCリストを照会 |
vpcNoList.N | List<String> | Optional | VPC番号で VPCリストを照会vpcNo はgetVpcListを通じて確認 |
responseFormatType | String | Optional | レスポンス結果の形式
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcList
?regionCode=KR
&vpcStatusCode=RUN
&vpcName=test-***
&vpcNoList.1=***04
&responseFormatType=xml'
--header 'x-ncp-apigw-timestamp:: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの詳細は、VpcListをご参照ください。
レスポンスステータスコード
NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
<getVpcListResponse>
<requestId>9b37ea3e-3ca9-462f-abad-6e23a35fcb76</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<vpcList>
<vpc>
<vpcNo>***04</vpcNo>
<vpcName>test-***</vpcName>
<ipv4CidrBlock>***.***.0.0/16</ipv4CidrBlock>
<vpcStatus>
<code>RUN</code>
<codeName>run</codeName>
</vpcStatus>
<regionCode>KR</regionCode>
<createDate>2020-07-16T22:23:50+0900</createDate>
</vpc>
</vpcList>
</getVpcListResponse>
この記事は役に立ちましたか?