getCloudMysqlInstanceList
- 인쇄
- PDF
getCloudMysqlInstanceList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
Cloud DB for MySQL 인스턴스 목록을 조회합니다.
요청
요청 파라미터
파라미터 | 타입 | 필수 여부 | 설명 | 제약 사항 |
---|---|---|---|---|
regionCode | String | N | Cloud DB for MySQL 인스턴스가 존재하는 리전 코드 - getRegionList 액션을 통해서 획득 가능 - default: getRegionList 조회 결과의 첫 번째 리전 | - |
zoneCode | String | N | ZONE 코드 - getZoneList 액션을 통해서 획득 가능 | - |
vpcNo | String | N | VPC 번호 - getCloudMysqlTargetVpcList 액션을 통해서 획득 가능 | - |
subnetNo | String | N | Subnet 번호 - getCloudMysqlTargetSubnetList 액션을 통해서 획득 가능 | - |
cloudMysqlServiceName | String | N | Cloud DB for MySQL 서비스 이름 - getCloudMysqlInstanceList 액션을 통해서 획득 가능 | - |
cloudMysqlInstanceNoList | List<String> | N | Cloud DB for MySQL 인스턴스 번호 목록 - getCloudMysqlInstanceList 액션을 통해서 획득 가능 - <예시> cloudMysqlInstanceNoList.1=1234&cloudMysqlInstanceNoList.2=2345 | - |
cloudMysqlServerName | String | N | Cloud DB for MySQL 서버 이름 - getCloudMysqlInstanceList 액션을 통해서 획득 가능 | - |
cloudMysqlServerInstanceNoList | List<String> | N | Cloud DB for MySQL 서버 인스턴스 번호 목록 getCloudMysqlInstanceList 액션을 통해서 획득 가능 - <예시> cloudMysqlServerInstanceNoList.1=1234&cloudMysqlServerInstanceNoList.2=2345 | - |
generationCode | String | N | 서버 세대 코드 - getCloudMysqlInstanceList 액션을 통해서 획득 가능 - options: G2 | G3 | - |
pageNo | Integer | N | 페이징 된 결과의 페이지 번호 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 | min: 0 |
pageSize | Integer | N | 페이징 시 보여줄 각 페이지 사이즈 - 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능 - pageNo 입력 시 반드시 입력 | min: 1 |
responseFormatType | String | N | 응답 결과의 포맷 타입 - options: xml | json - default: xml | - |
응답
응답 바디
응답 바디는 CloudMysqlInstanceList를 참고해 주십시오.
예시
요청 예시
요청 구문 예시는 다음과 같습니다.
GET {API_URL}/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
응답 예시
응답 구문 예시는 다음과 같습니다.
응답 결과 포맷 타입(responseFormatType)이 json 일 때
{
"getCloudMysqlInstanceListResponse": {
"requestId": "1ae10c76-412d-4050-8911-42fa19a60a31",
"returnCode": 0,
"returnMessage": "success",
"totalRows": 1,
"cloudMysqlInstanceList": {
"cloudMysqlInstance": {
"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": {
"cloudMysqlServerInstance": [
{
"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"
},
"privateIp": "***.***.***.***",
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "****83",
"subnetNo": "****91",
"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"
},
"privateIp": "***.***.***.***",
"regionCode": "KR",
"zoneCode": "KR-2",
"vpcNo": "****83",
"subnetNo": "****93",
"dataStorageSize": 10737418240,
"cpuCount": 2,
"memorySize": 8589934592
}
]
}
}
}
}
}
응답 결과 포맷 타입(responseFormatType)이 xml 일 때
<getCloudMysqlInstanceListResponse>
<requestId>1ae10c76-412d-4050-8911-42fa19a60a31</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>
<privateIp>***.***.***.***</privateIp>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****91</subnetNo>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
</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>
<privateIp>***.***.***.***</privateIp>
<regionCode>KR</regionCode>
<zoneCode>KR-2</zoneCode>
<vpcNo>****83</vpcNo>
<subnetNo>****93</subnetNo>
<dataStorageSize>10737418240</dataStorageSize>
<cpuCount>2</cpuCount>
<memorySize>8589934592</memorySize>
</cloudMysqlServerInstance>
</cloudMysqlServerInstanceList>
</cloudMysqlInstance>
</cloudMysqlInstanceList>
</getCloudMysqlInstanceListResponse>
이 문서가 도움이 되었습니까?