getCloudMysqlTargetVpcList

Prev Next

Available in VPC

Get the list of VPCs available to use in Cloud DB for MySQL.

Request

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

Method URI
GET, POST /getCloudMysqlTargetVpcList

Request headers

For headers common to all Cloud DB for MySQL (VPC) APIs, see Cloud DB for MySQL (VPC) request headers.

Request parameter

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code
  • Region code of the VPC to view
  • Check through getRegionList
  • First Region of the getRegionList query result (default)
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlTargetVpcList
?regionCode=KR'
--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 TargetVpcList 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.

  • If responseFormatType=json
{
    "getCloudMysqlTargetVpcListResponse": {
        "totalRows": 3,
        "targetVpcList": [
            {
                "vpcNo": "****83",
                "vpcName": "test-***",
                "ipv4Cidr": "192.168.0.0/16",
                "regionCode": "KR",
                "createdDate": "2021-11-24T13:08:02+0900"
            }
        ],
        "requestId": "b9cf9a98-****-****-****-ba0d20cf0567",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • If responseFormatType=xml (default)
<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlTargetVpcListResponse>
    <requestId>b9cf9a98-****-****-****-ba0d20cf0567</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetVpcList>
        <targetVpc>
            <vpcNo>****83</vpcNo>
            <vpcName>test-***</vpcName>
            <ipv4Cidr>192.168.0.0/16</ipv4Cidr>
            <regionCode>KR</regionCode>
            <createdDate>2021-11-24T13:08:02+0900</createdDate>
        </targetVpc>
    </targetVpcList>
</getCloudMysqlTargetVpcListResponse>