getVpcDetail

Available in VPC

View VPC details by specifying the VPC number.

Request

The following describes the request format for the endpoint. The request format is as follows:

Request headers

For headers common to all VPC APIs, see VPC common headers.

Request query parameters

The following describes the parameters.

Request example

The following is a sample request.

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getVpcDetail
?regionCode=KR
&vpcNo=***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}'

Response

The following describes the response format.

Response body

See VpcList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<getVpcDetailResponse>
  <requestId>13f37a8e-780f-4f32-9115-503a2026cf6d</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>
</getVpcDetailResponse>