flushCloudDBInstance
- 인쇄
- PDF
flushCloudDBInstance
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
개요
Redis Data Flush API입니다.
요청
요청 헤더
헤더명 | 설명 |
---|---|
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 요청 시 필드명의 대소문자 구분이 필요합니다
파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
---|---|---|---|---|
cloudDBInstanceNo | Y | String | CloudDB 인스턴스 번호 | |
responseFormatType | N | String | response의 결과 format 설정 |
- cloudDBInstanceNo
- 생성되어있는 Redis서버의 Instance 번호입니다.
- responseFormatType
- API 실행 결과를 응답받을 format을 정합니다. xml과 json 중에서 선택 가능합니다.
응답
필드명 | 타입 | 설명 | 비고 |
---|---|---|---|
returnCode | Integer | 응답 코드 값 | |
returnMessage | String | 응답 메시지 | |
totalRows | Integer | 응답 결과 row 수 | |
cloudDBInstanceList[] | String | 생성된 cloud DB Instance 정보 |
예시
요청 예시
curl
-X POST "https://ncloud.apigw.ntruss.com/clouddb/v2/flushCloudDBInstance" -H "accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-H "x-ncp-apigw-api-key: 25bpuog9sz"
-H "x-ncp-iam-access-key: Y0Z9EG0lKoeWAQCSHRtM"
-H "x-ncp-apigw-timestamp: 1546221796556"
-H "x-ncp-apigw-signature-v2: 5dTxKRpMotjN64uUixKVT2Vd4HuQsjIN1QihCxcYE8A="
-d "cloudDBInstanceNo=882689&responseFormatType=json"
https://ncloud.apigw.ntruss.com/clouddb/v2/flushCloudDBInstance
요청 샘플
- Redis Data Flush
{
"cloudDBInstanceNo": "882689",
"responseFormatType": "json"
}
응답 예시
connection: keep-alive
content-type: application/json;charset=UTF-8
date: Mon, 24 Dec 2018 08:59:40 GMT
server: nginx
transfer-encoding: chunked
x-ncp-trace-id: 6acpi6di6apj536ob5cksjcor2
{
"flushCloudDBInstanceResponse": {
"returnCode": "0",
"returnMessage": "success",
"totalRows": 1,
"cloudDBInstanceList": [
{
"cloudDBInstanceNo": "882689",
"cloudDBServiceName": "test",
"dbKindCode": "REDIS",
"engineVersion": "REDIS 4.0.2",
"cpuCount": 4,
"memorySize": 3221225472,
"licenseCode": "BSD",
"cloudDBPort": 6379,
"isHa": true,
"backupTime": "00:45",
"backupFileRetentionPeriod": 1,
"cloudDBInstanceStatusName": "settingup",
"collation": "",
"createDate": "2018-12-28T17:28:00+0900",
"cloudDBImageProductCode": "SPSWREDISLINUX01",
"cloudDBProductCode": "SPSVRDBAAS000008",
"isCloudDBConfigNeedReboot": false,
"isCloudDBNeedReboot": false,
"zone": {
"zoneNo": "2",
"zoneName": "KR-1",
"zoneCode": "KR-1",
"zoneDescription": "가산 zone",
"regionNo": "1"
},
"region": {
"regionNo": "1",
"regionCode": "KR",
"regionName": "Korea"
},
"cloudDBConfigList": [],
"cloudDBConfigGroupList": [],
"accessControlGroupList": [
{
"accessControlGroupConfigurationNo": "23953",
"accessControlGroupName": "cloud-redis-ix35",
"accessControlGroupDescription": "Group for cloud Redis service 'test' (automatically created)",
"isDefault": false,
"createDate": "2018-12-28T17:28:17+0900"
}
],
"cloudDBServerInstanceList": [
{
"cloudDBServerInstanceNo": "882690",
"cloudDBServerInstanceStatusName": "settingup",
"cloudDBServerName": "test123-001",
"cloudDBServerRole": {
"code": "M",
"codeName": "Master"
},
"privateDnsName": "redis-qu02.beta-cdb.ntruss.com",
"publicDnsName": "",
"dataStorageSize": 0,
"usedDataStorageSize": 0,
"createDate": "2018-12-28T17:28:00+0900",
"uptime": "2018-12-28T17:30:00+0900"
},
{
"cloudDBServerName": "test123-002",
"cloudDBServerRole": {
"code": "H",
"codeName": "Hidden Master"
}
}
]
}
]
}
}
오류 코드
Cloud DB API 요청이 잘못되었거나, 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다
오류 코드는 Cloud DB API의 '공통 오류 코드'와 'API Gateway 오류 코드' 두 가지입니다
오류 코드 | 응답 메시지 | 설명 |
---|---|---|
200 | Ok | |
500 | Server Error |
이 문서가 도움이 되었습니까?