getSubnetDetail

Available in VPC

Get the details of a subnet by specifying the subnet number.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET, POST	/getSubnetDetail

Request headers

For information about the headers common to all VPC APIs, see VPC common headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code where you want to query the subnet details First Region of the query result (default) Check through getRegionList.
`subnetNo`	String	Required	Query the subnet details with the subnet number. Check through getSubnetList.
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The request example is as follows:

curl --location 'https://ncloud.apigw.ntruss.com/vpc/v2/getSubnetDetail
?regionCode=KR
&subnetNo=***43'
--header 'x-ncp-apigw-timestamp: {Timestamp}'    
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

See SubnetList 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 response example is as follows:

<getSubnetDetailResponse>
  <requestId>5a8fd498-37e4-4d5a-9622-462c22fa01ac</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <subnetList>
    <subnet>
      <subnetNo>***43</subnetNo>
      <vpcNo>***04</vpcNo>
      <zoneCode>KR-1</zoneCode>
      <subnetName>test-***</subnetName>
      <subnet>***.***.1.0/24</subnet>
      <subnetStatus>
        <code>RUN</code>
        <codeName>run</codeName>
      </subnetStatus>
      <createDate>2020-05-04T11:49:52+0900</createDate>
      <subnetType>
        <code>PUBLIC</code>
        <codeName>Public</codeName>
      </subnetType>
      <usageType>
        <code>GEN</code>
        <codeName>General</codeName>
      </usageType>
      <networkAclNo>***31</networkAclNo>
    </subnet>
  </subnetList>
</getSubnetDetailResponse>