exportBackupToObjectStorage
- 印刷する
- PDF
exportBackupToObjectStorage
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
バックアップファイルをObject Storageにエクスポートします。
リクエスト
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| 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タイプコード |
| fileName | Y | String | getCloudDBBackupDetailListを通じて取得可能 | |
| bucketName | Y | String | ||
| cloudDBInstanceNo | Y | String | getCloudDBInstanceListを通じて取得する値 | |
| responseFormatType | N | String | xml, json | responseの結果format設定 |
regionNo
- Server APIのgetRegionListを通じて取得できます。
dbKindCode
- 照会するCloudDBの種類を選択します。MySQLのみ入力できます。
fileName
- getCloudDBBackupDetailListを通じて取得できます。
bucketName
- コンソールに作成されたバケット名を入力します。
cloudDBInstanceNo
- 作成されているMySQLサーバのインスタンス番号です。getCloudDBInstanceListを通じて取得できます。
responseFormatType
- API実行結果のレスポンスを受けるformatを決めます。xmlとjsonの中から選択できます。
レスポンス
| フィールド名 | タイプ | 説明 | 備考 |
|---|---|---|---|
| returnCode | Integer | ||
| returnMessage | String |
例示
リクエスト例示
curl -X GET "https://ncloud.apigw.ntruss.com/clouddb/v2/exportBackupToObjectStorage?regionNo=1&dbKindCode=MYSQL&fileName=20220210&bucketName=mysql-b&cloudDBInstanceNo=2090164&cloudDBServerInstanceNo=2090166&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: 1644486011957"
-H "x-ncp-apigw-signature-v2: 2fvwJH5+4fpM3RMlR0qMEaDzucSkjnzmDizosMXkBSI="
-H "cache-control: no-cache"
-H "pragma: no-cache"
https://ncloud.apigw.ntruss.com/clouddb/v2/exportBackupToObjectStorage?regionNo=1&dbKindCode=MYSQL&fileName=20220210&bucketName=mysql-b&cloudDBInstanceNo=2090164&cloudDBServerInstanceNo=2090166&responseFormatType=json
リクエストサンプル
- MySQLで作成されたinstance listの照会
{
"regionNo": "1",
"dbKindCode": "MYSQL",
"fileName": "20220210",
"bucketName": "mysql-b",
"cloudDBInstanceNo": "2090164",
"responseFormatType": "json"
}
レスポンス例示
connection: keep-alive
content-type: application/json;charset=UTF-8
date: Thu, 10 Feb 2022 09:40:12 GMT
server: nginx
transfer-encoding: chunked
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 34opkc4q34o9g38d1mcdh32dr1
{
"exportBackupToObjectStorageResponse": {
"requestId": "b9e7d957-9981-4bd0-b134-ae89d4a6c1b0",
"returnCode": "0",
"returnMessage": "success"
}
}
エラーコード
Cloud DB APIのリクエストが間違っているか、処理中にエラーが発生する場合、HTTPステータスコードで成功/失敗を返却し、JSONの形式で詳細メッセージを返却します。
エラーコードはCloud DB APIの「共通エラーコード」と「API Gatewayエラーコード」の二つです。
| エラーコード | レスポンスメッセージ | 説明 |
|---|---|---|
| 200 | Ok | |
| 500 | Server Error |
この記事は役に立ちましたか?