getCloudDBBackupDetailList
- 印刷する
- PDF
getCloudDBBackupDetailList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
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 | 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リクエスト時はフィールド名の大文字・小文字の区別が必要です。
パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
regionNo | N | String | リージョン番号 | |
dbKindCode | Y | String | MYSQL | DBタイプコード |
cloudDBInstanceNo | Y | String | getCloudDBInstanceListを通じて取得可能 | |
responseFormatType | N | String | xml, json | responseの結果format設定 |
regionNo
- Server APIのgetRegionListを通じて取得できます。
dbKindCode
- 照会するCloudDBの種類を選択します。MySQLのみ選択できます。
cloudDBInstanceNo
- 作成されているMySQLサーバのインスタンス番号です。getCloudDBInstanceListを通じて取得できます。
responseFormatType
- API実行結果のレスポンスを受けるformatを決めます。xmlとjsonの中から選択できます。
レスポンス
フィールド名 | タイプ | 説明 | 備考 |
---|---|---|---|
returnCode | Integer | レスポンスコード値 | |
returnMessage | String | レスポンスメッセージ | |
totalRows | Integer | レスポンス結果の行数 | |
cloudDBBackupDetailList[] | String | バックアップの詳細リスト | CloudDBBackupDetail |
- CloudDBBackupDetail
フィールド名 | タイプ | 説明 | 備考 |
---|---|---|---|
fileName | String | ファイル名 | |
startTime | Date | 開始日 | |
endTime | Date | 終了日 | |
backupSize | Long | バックアップサイズ |
例示
リクエスト例示
curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBBackupDetailList?regionNo=1&dbKindCode=MYSQL&cloudDBInstanceNo=2090164&responseFormatType=json"
-H "accept: application/json"
-H "Content-Type: application/x-www-form-urlencoded"
-H "x-ncp-iam-access-key: UhO0EH9R8Gts7PoPPz27"
-H "x-ncp-apigw-timestamp: 1644485285737"
-H "x-ncp-apigw-signature-v2: WK2nam8/iO4WfG9WTyfInTQJ9vqYLJXBlyhPpaOcr5E="
-H "cache-control: no-cache"
-H "pragma: no-cache"
https://ncloud.apigw.ntruss.com/clouddb/v2/getCloudDBBackupDetailList?regionNo=1&dbKindCode=MYSQL&cloudDBInstanceNo=2090164&responseFormatType=json
リクエストサンプル
- MySQLで作成されたinstance listの照会
{
"regionNo": "1",
"dbKindCode": "MYSQL",
"cloudDBInstanceNo": "2090164",
"responseFormatType": "json"
}
レスポンス例示
connection: keep-alive
content-type: application/json;charset=UTF-8
date: Thu, 10 Feb 2022 09:28:06 GMT
server: nginx
transfer-encoding: chunked
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 66cr470p68dhi3eo9lckom4cpn
{
"getCloudDBBackupDetailListResponse": {
"requestId": "3c723f22-270d-4a32-adec-5774bf9b3b46",
"returnCode": "0",
"returnMessage": "success",
"totalRows": 1,
"cloudDBBackupDetailList": [
{
"fileName": "20220210",
"startTime": "2022-02-10T12:30:08+0900",
"endTime": "2022-02-10T12:30:20+0900",
"backupSize": 584942472
}
]
}
}
エラーコード
Cloud DB APIのリクエストが間違っているか、処理中にエラーが発生する場合、HTTPステータスコードで成功/失敗を返却し、JSONの形式で詳細メッセージを返却します。
エラーコードはCloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の二つです。
エラーコード | レスポンスメッセージ | 説明 |
---|---|---|
200 | Ok | |
500 | Server Error |
この記事は役に立ちましたか?