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 | Naverクラウドプラットフォームで発行された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 |
この記事は役に立ちましたか?