getCloudMysqlInstanceDetail
    • PDF

    getCloudMysqlInstanceDetail

    • PDF

    Article summary

    Available in VPC

    Get Cloud DB for MySQL instance details.

    Request

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

    MethodURI
    GET, POST/getCloudMysqlInstanceDetail

    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 Cloud DB for MySQL server instance to view
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    cloudMysqlInstanceNoStringRequiredInstance number of Cloud DB for MySQL
    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/getCloudMysqlInstanceDetail
    ?regionCode=KR
    &cloudMysqlInstanceNo=****890'
    --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 CloudMysqlInstanceList 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
    {
        "getCloudMysqlInstanceDetailResponse": {
            "totalRows": 1,
            "cloudMysqlInstanceList": [
                {
                    "cloudMysqlInstanceNo": "****890",
                    "cloudMysqlServiceName": "test-****",
                    "cloudMysqlInstanceStatusName": "running",
                    "cloudMysqlInstanceStatus": {
                        "code": "CREAT",
                        "codeName": "CLOUD DATABASE(VPC) Created State"
                    },
                    "cloudMysqlInstanceOperation": {
                        "code": "NULL",
                        "codeName": "CLOUD DATABASE(VPC) Null OP"
                    },
                    "cloudMysqlImageProductCode": "SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8025.B050",
                    "engineVersion": "MYSQL8.0.25",
                    "license": {
                        "code": "GPL",
                        "codeName": "General Public License"
                    },
                    "cloudMysqlPort": 13306,
                    "isHa": true,
                    "isMultiZone": true,
                    "isBackup": true,
                    "backupFileRetentionPeriod": 10,
                    "backupTime": "02:00",
                    "generationCode": "G2",
                    "createDate": "2024-05-23T11:25:09+0900",
                    "accessControlGroupNoList": [
                        "****58"
                    ],
                    "cloudMysqlConfigList": [],
                    "cloudMysqlServerInstanceList": [
                        {
                            "cloudMysqlServerInstanceNo": "****891",
                            "cloudMysqlServerName": "test-****-001-e04",
                            "cloudMysqlServerRole": {
                                "code": "M",
                                "codeName": "Master"
                            },
                            "cloudMysqlServerInstanceStatusName": "running",
                            "cloudMysqlServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudMysqlServerInstanceOperation": {
                                "code": "NOOP",
                                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                            },
                            "cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
                            "regionCode": "KR",
                            "zoneCode": "KR-1",
                            "vpcNo": "****83",
                            "subnetNo": "****91",
                            "isPublicSubnet": true,
                            "privateDomain": "db-****.vpc-cdb.ntruss.com",
                            "privateIp": "***.***.***.***",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "isStorageEncryption": true,
                            "dataStorageSize": 10737418240,
                            "usedDataStorageSize": 2791728640,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "uptime": "2024-05-23T11:34:39+0900",
                            "createDate": "2024-05-23T11:25:09+0900"
                        },
                        {
                            "cloudMysqlServerInstanceNo": "****897",
                            "cloudMysqlServerName": "test-****-002-e05",
                            "cloudMysqlServerRole": {
                                "code": "H",
                                "codeName": "Standby Master"
                            },
                            "cloudMysqlServerInstanceStatusName": "running",
                            "cloudMysqlServerInstanceStatus": {
                                "code": "RUN",
                                "codeName": "CLOUD DATABASE(VPC) Server Running State"
                            },
                            "cloudMysqlServerInstanceOperation": {
                                "code": "NOOP",
                                "codeName": "CLOUD DATABASE(VPC) Server Null OP"
                            },
                            "cloudMysqlProductCode": "SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002",
                            "regionCode": "KR",
                            "zoneCode": "KR-2",
                            "vpcNo": "****83",
                            "subnetNo": "****93",
                            "isPublicSubnet": true,
                            "privateDomain": "db-****.vpc-cdb.ntruss.com",
                            "privateIp": "***.***.***.***",
                            "dataStorageType": {
                                "code": "SSD",
                                "codeName": "SSD"
                            },
                            "isStorageEncryption": true,
                            "dataStorageSize": 10737418240,
                            "usedDataStorageSize": 2791728640,
                            "cpuCount": 2,
                            "memorySize": 8589934592,
                            "uptime": "2024-05-23T11:34:05+0900",
                            "createDate": "2024-05-23T11:25:09+0900"
                        }
                    ]
                }
            ],
            "requestId": "2e543438-****-****-****-631436294458",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
    • If responseFormatType=xml (default)
    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMysqlInstanceDetailResponse>
        <requestId>2e543438-****-****-****-631436294458</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMysqlInstanceList>
            <cloudMysqlInstance>
                <cloudMysqlInstanceNo>****890</cloudMysqlInstanceNo>
                <cloudMysqlServiceName>test-****</cloudMysqlServiceName>
                <cloudMysqlInstanceStatusName>running</cloudMysqlInstanceStatusName>
                <cloudMysqlInstanceStatus>
                    <code>CREAT</code>
                    <codeName>CLOUD DATABASE(VPC) Created State</codeName>
                </cloudMysqlInstanceStatus>
                <cloudMysqlInstanceOperation>
                    <code>NULL</code>
                    <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
                </cloudMysqlInstanceOperation>
                <cloudMysqlImageProductCode>SW.VDBAS.DBAAS.LNX64.CNTOS.0708.MYSQL.8025.B050</cloudMysqlImageProductCode>
                <engineVersion>MYSQL8.0.25</engineVersion>
                <license>
                    <code>GPL</code>
                    <codeName>General Public License</codeName>
                </license>
                <cloudMysqlPort>13306</cloudMysqlPort>
                <isHa>true</isHa>
                <isMultiZone>true</isMultiZone>
                <isBackup>true</isBackup>
                <backupFileRetentionPeriod>10</backupFileRetentionPeriod>
                <backupTime>02:00</backupTime>
                <generationCode>G2</generationCode>
                <createDate>2024-05-23T11:25:09+0900</createDate>
                <accessControlGroupNoList>
                    <accessControlGroupNo>****58</accessControlGroupNo>
                </accessControlGroupNoList>
                <cloudMysqlConfigList/>
                <cloudMysqlServerInstanceList>
                    <cloudMysqlServerInstance>
                        <cloudMysqlServerInstanceNo>****891</cloudMysqlServerInstanceNo>
                        <cloudMysqlServerName>test-****-001-e04</cloudMysqlServerName>
                        <cloudMysqlServerRole>
                            <code>M</code>
                            <codeName>Master</codeName>
                        </cloudMysqlServerRole>
                        <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                        <cloudMysqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudMysqlServerInstanceStatus>
                        <cloudMysqlServerInstanceOperation>
                            <code>NOOP</code>
                            <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                        </cloudMysqlServerInstanceOperation>
                        <cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-1</zoneCode>
                        <vpcNo>***83</vpcNo>
                        <subnetNo>****91</subnetNo>
                        <isPublicSubnet>true</isPublicSubnet>
                        <privateDomain>db-****.vpc-cdb.ntruss.com</privateDomain>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <usedDataStorageSize>2791728640</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <uptime>2024-05-23T11:34:39+0900</uptime>
                        <createDate>2024-05-23T11:25:09+0900</createDate>
                    </cloudMysqlServerInstance>
                    <cloudMysqlServerInstance>
                        <cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
                        <cloudMysqlServerName>test-****-002-e05</cloudMysqlServerName>
                        <cloudMysqlServerRole>
                            <code>H</code>
                            <codeName>Standby Master</codeName>
                        </cloudMysqlServerRole>
                        <cloudMysqlServerInstanceStatusName>running</cloudMysqlServerInstanceStatusName>
                        <cloudMysqlServerInstanceStatus>
                            <code>RUN</code>
                            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                        </cloudMysqlServerInstanceStatus>
                        <cloudMysqlServerInstanceOperation>
                            <code>NOOP</code>
                            <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
                        </cloudMysqlServerInstanceOperation>
                        <cloudMysqlProductCode>SVR.VDBAS.STAND.C002.M008.NET.HDD.B050.G002</cloudMysqlProductCode>
                        <regionCode>KR</regionCode>
                        <zoneCode>KR-2</zoneCode>
                        <vpcNo>****83</vpcNo>
                        <subnetNo>****93</subnetNo>
                        <isPublicSubnet>true</isPublicSubnet>
                        <privateDomain>db-****.vpc-cdb.ntruss.com</privateDomain>
                        <privateIp>***.***.***.***</privateIp>
                        <dataStorageType>
                            <code>SSD</code>
                            <codeName>SSD</codeName>
                        </dataStorageType>
                        <isStorageEncryption>true</isStorageEncryption>
                        <dataStorageSize>10737418240</dataStorageSize>
                        <usedDataStorageSize>2791728640</usedDataStorageSize>
                        <cpuCount>2</cpuCount>
                        <memorySize>8589934592</memorySize>
                        <uptime>2024-05-23T11:34:05+0900</uptime>
                        <createDate>2024-05-23T11:25:09+0900</createDate>
                    </cloudMysqlServerInstance>
                </cloudMysqlServerInstanceList>
            </cloudMysqlInstance>
        </cloudMysqlInstanceList>
    </getCloudMysqlInstanceDetailResponse>
    

    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.