getCloudMysqlInstanceList
- Print
- PDF
getCloudMysqlInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Get the list of Cloud DB for MySQL instances.Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
GET, POST | /getCloudMysqlInstanceList |
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
|
zoneCode | String | Optional | Filter by zone code
|
vpcNo | String | Optional | Filter by VPC number
|
subnetNo | String | Optional | Filter by subnet number
|
cloudMysqlServiceName | String | Optional | Filter by Cloud DB for MySQL service name
|
cloudMysqlInstanceNoList.N | List<String> | Optional | Cloud DB for MySQL instance number list
|
cloudMysqlServerName | String | Optional | Filter by Cloud DB for MySQL server name
|
cloudMysqlServerInstanceNoList.N | List<String> | Optional | Cloud DB for MySQL server instance number list
|
generationCode | String | Optional | Filter by server generation code
|
pageNo | Integer | Optional | Page numbers in paged results
|
pageSize | Integer | Conditional | Number of results to display on a page
|
responseFormatType | String | Optional | Format of the response result
|
Request example
The following is a sample request.
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmysql/v2/getCloudMysqlInstanceList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***83
&subnetNo=**91
&cloudMysqlServiceName=test-****
&cloudMysqlInstanceNoList.1=****890
&cloudMysqlServerName=test-****
&cloudMysqlServerInstanceNoList.1=****891
&generationCode=G2
&pageNo=0
&pageSize=10'
--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
{
"getCloudMysqlInstanceListResponse": {
"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"
},
"isHa": true,
"isMultiZone": true,
"generationCode": "G2",
"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"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"privateIp": "***.***.***.***",
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592
},
{
"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"
},
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "****83",
"subnetNo": "****91",
"privateIp": "***.***.***.***",
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592
}
]
}
],
"requestId": "8f728514-****-****-****-e56324aeb031",
"returnCode": "0",
"returnMessage": "success"
}
}
- If
responseFormatType=xml
(default)
<?xml version="1.0" encoding="UTF-8"?>
<getCloudMysqlInstanceListResponse>
<requestId>8f728514-****-****-****-e56324aeb031</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>
<isHa>true</isHa>
<isMultiZone>true</isMultiZone>
<generationCode>G2</generationCode>
<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>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****91</subnetNo>
<privateIp>***.***.***.***</privateIp>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
</cloudMysqlServerInstance>
<cloudMysqlServerInstance>
<cloudMysqlServerInstanceNo>****897</cloudMysqlServerInstanceNo>
<cloudMysqlServerName>test-****-002-4y1w</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>
<regionCode>KR</regionCode>
<zoneCode>KR-2</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****93</subnetNo>
<privateIp>***.***.***.***</privateIp>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
</cloudMysqlServerInstance>
</cloudMysqlInstanceList>
</getCloudMysqlInstanceListResponse>
Was this article helpful?