getCloudDBInstanceList
- 인쇄
- PDF
getCloudDBInstanceList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic 환경에서 이용 가능합니다.
개요
CloudDB 인스턴스 리스트 정보를 조회합니다.
요청
요청 헤더
헤더명 | 설명 |
---|---|
x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주x-ncp-apigw-timestamp:{Timestamp} |
x-ncp-apigw-api-key | APIGW에서 발급받은 키 값, v2를 사용할 경우 api-key는 사용하지 않음x-ncp-apigw-api-key:{API Gateway API Key} |
x-ncp-iam-access-key | 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값x-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Access Key ID 값과 Secret Key로 암호화한 서명x-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | Request body content type을 application/json으로 지정Content-Type: application/json |
요청 바디
API 요청 시 필드명의 대소문자 구분이 필요합니다
파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
cloudDBInstanceNoList | N | List<String> | 인스턴스 번호 | |
pageNo | N | Integer | 페이지 번호 | |
pageSize | N | Integer | 페이지 사이즈 | |
dbKindCode | Y | String | MYSQL | DB 유형 코드 |
searchFilterName | N | String | 검색필터 이름 | |
searchFilterValue | N | String | 검색필터 값 | |
regionNo | N | String | 리전 번호 | |
zoneNo | N | String | zone 번호 | |
responseFormatType | N | String | response의 결과 format 설정 |
cloudDBInstanceNoList
- 조회할 인스턴스 번호
pageNo
- 건수가 많을 경우 페이지 사이즈에 해당하는 페이지 번호
pageSize
- 한 페이지에서 조회할 페이지 사이즈
dbKindCode
- 조회할 CloudDB의 종류를 선택합니다. MySQL만 입력 가능합니다.
searchFilterName
- 검색할 필터 종류
searchFilterValue
- 검색할 필터 값
regionNo
- Server API인 getRegionList를 통해 얻을수 있습니다.
zoneNo
- Server API인 getZoneList를 통해 얻을수 있습니다.
responseFormatType
- API 실행 결과를 응답 받을 format을 정합니다. xml과 json 중에서 선택 가능합니다.
응답
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
returnCode | Integer | 응답 코드 값 | |
returnMessage | String | 응답 메시지 | |
totalRows | Integer | 응답 결과 row 수 | |
cloudDBInstanceList[] | String | 생성된 cloud DB Instance 정보 |
예시
요청 예시
GET {API_URL}/getCloudDBInstanceList
?pageNo=0
&pageSize=0
&dbKindCode=MYSQL
&responseFormatType=json
요청 샘플
- MySQL로 생성된 instance list 조회
{
"pageNo": 0,
"pageSize": 0,
"dbKindCode": "MYSQL",
"responseFormatType": "json"
}
응답 예시
connection: keep-alive
content-type: application/json;charset=UTF-8
date: Thu, 22 Sep 2022 02:18:35 GMT
server: nginx
transfer-encoding: chunked
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 3adj16dhm2d9h3gcr6c8s66eb2
{
"getCloudDBInstanceListResponse": {
"requestId": "0cd1e0ed-9492-42ed-8eee-ee8f3184b45b",
"returnCode": "0",
"returnMessage": "success",
"totalRows": 1,
"cloudDBInstanceList": [
{
"cloudDBInstanceNo": "553065",
"cloudDBServiceName": "testdb",
"dbKindCode": "MYSQL",
"engineVersion": "MYSQL8.0.18",
"cpuCount": 2,
"memorySize": 4294967296,
"dataStorageType": {
"code": "SSD",
"codeName": "SSD"
},
"licenseCode": "GPL",
"cloudDBPort": 3306,
"isHa": true,
"backupTime": "10:15",
"backupFileRetentionPeriod": 1,
"cloudDBInstanceStatusName": "running",
"collation": "",
"createDate": "2022-09-14T13:30:00+0900",
"cloudDBImageProductCode": "SPSWMYSQLLINUX09",
"cloudDBProductCode": "SPSVRDBAAS000001",
"isCloudDBConfigNeedReboot": false,
"isCloudDBNeedReboot": false,
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "평촌 zone",
"regionNo": "1"
},
"region": {
"regionNo": "1",
"regionCode": "KR",
"regionName": "KR-CENTRAL"
},
"cloudDBConfigList": [],
"cloudDBConfigGroupList": [],
"accessControlGroupList": [
{
"accessControlGroupConfigurationNo": "2073",
"accessControlGroupName": "cloud-db-buqx",
"accessControlGroupDescription": "Group for cloud DB service 'testdb' (automatically created)",
"isDefault": false,
"createDate": "2022-09-14T13:30:33+0900"
}
],
"cloudDBServerInstanceList": [
{
"cloudDBServerInstanceNo": "553066",
"cloudDBServerInstanceStatusName": "running",
"cloudDBServerName": "testdb-001",
"cloudDBServerRole": {
"code": "M",
"codeName": "Master"
},
"privateDnsName": "db-gs3a.beta-cdb.gov-ntruss.com",
"publicDnsName": "",
"dataStorageSize": 10737418240,
"usedDataStorageSize": 3221225472,
"createDate": "2022-09-14T13:36:00+0900"
},
{
"cloudDBServerName": "testdb-002",
"cloudDBServerRole": {
"code": "H",
"codeName": "Hidden Master"
}
}
]
}
]
}
}
오류 코드
Cloud DB API 요청이 잘못되었거나, 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다
오류 코드는 Cloud DB API의 '공통 오류 코드'와 'API Gateway 오류 코드' 두 가지입니다
오류 코드 | 응답 메시지 | 설명 |
---|---|---|
200 | Ok | |
500 | Server Error |
이 문서가 도움이 되었습니까?