この API は、MongoDB インスタンスを手動バックアップする場合に呼び出すことができます。
この API を呼び出す際に、インスタンスは実行中の状態にある必要があります。
デバッグ
OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。
リクエストパラメータ
| パラメータ | データ型 | 必須 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | はい | CreateBackup |
実行する操作。 値を CreateBackupに設定します。 |
| DBInstanceId | String | はい | d-bpxxxxxxxx |
インスタンス ID。 |
| BackupMethod | String | いいえ | Logical |
インスタンスのバックアップ方式。 有効値：
注 このパラメーターをサポートするのは、レプリカセットインスタンスとシャードクラスターインスタンスのみです。 スタンドアロンインスタンスの場合、このパラメーターを指定する必要はありません。
すべてのスタンドアロンインスタンスはスナップショットバックアップを使用します。
|
| AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメータ
| パラメータ | タイプ | 例 | 説明 |
|---|---|---|---|
| BackupId | String | 5664xxxx |
バックアップ ID。 |
| RequestId | String | 7016B12F-7F64-40A4-BAFF-013F02AC82FC |
リクエスト ID。 |
例
リクエストの例
http(s)://mongodb.aliyuncs.com/? Action=CreateBackup
DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
通常のレスポンスの例
XML 形式
<CreateBackupResponse>
<RequestId>7016B12F-7F64-40A4-BAFF-013F02AC82FC</RequestId>
<BackupId>5664xxxx</BackupId>
</CreateBackupResponse>
JSON 形式
{
"RequestId":"7016B12F-7F64-40A4-BAFF-013F02AC82FC",
"BackupId":"5664xxxx"
}