getCloudMysqlTargetSubnetList
    • PDF

    getCloudMysqlTargetSubnetList

    • PDF

    Article summary

    Available in VPC

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

    Request

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

    MethodURI
    GET, POST/getCloudMysqlTargetSubnetList

    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.

    FieldTypeRequiredDescription
    regionCodeStringOptionalRegion code
    • Region code of the subnet to view
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    vpcNoStringRequiredFilter by VPC number
    cloudMysqlImageProductCodeStringRequiredFilter by Cloud DB for MySQL image product code
    isPublicBooleanOptionalFilter by public subnet status
    • true | false
    responseFormatTypeStringOptionalFormat 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/getCloudMysqlTargetSubnetList
    ?regionCode=KR
    &vpcNo=****83
    &cloudMysqlImageProductCode=SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8018.B050'
    --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 TargetSubnetList 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
    {
        "getCloudMysqlTargetSubnetListResponse": {
            "totalRows": 3,
            "targetSubnetList": [
                {
                    "subnetNo": "****91",
                    "subnetName": "test-***",
                    "vpcNo": "****83",
                    "vpcName": "test-***",
                    "zoneCode": "KR-1",
                    "subnet": "192.168.*.0/28",
                    "isPublic": true,
                    "createdDate": "2024-06-03T08:53:40+0900"
                },
                {
                    "subnetNo": "****93",
                    "subnetName": "test-***",
                    "vpcNo": "****83",
                    "vpcName": "test-***",
                    "zoneCode": "KR-2",
                    "subnet": "192.168.*.0/24",
                    "isPublic": true,
                    "createdDate": "2022-03-30T10:01:13+0900"
                }
            ],
            "requestId": "b9cf9a98-****-****-****-ba0d20cf0567",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • If responseFormatType=xml (default)
    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMysqlTargetSubnetListResponse>
        <requestId>b9cf9a98-****-****-****-ba0d20cf0567</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>3</totalRows>
        <targetSubnetList>
            <targetSubnet>
                <subnetNo>****83</subnetNo>
                <subnetName>test-***</subnetName>
                <vpcNo>****83</vpcNo>
                <vpcName>test-***</vpcName>
                <zoneCode>KR-1</zoneCode>
                <subnet>192.168.*.0/28</subnet>
                <isPublic>true</isPublic>
                <createdDate>2024-06-03T08:53:40+0900</createdDate>
            </targetSubnet>
            <targetSubnet>
                <subnetNo>****93</subnetNo>
                <subnetName>test-***</subnetName>
                <vpcNo>****83</vpcNo>
                <vpcName>test-***</vpcName>
                <zoneCode>KR-2</zoneCode>
                <subnet>192.168.*.0/24</subnet>
                <isPublic>true</isPublic>
                <createdDate>2022-03-30T10:01:13+0900</createdDate>
            </targetSubnet>
        </targetSubnetList>
    </getCloudMysqlTargetSubnetListResponse>

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.