この API は、MongoDB インスタンスのバックアップポリシーをクエリする場合に呼び出すことができます。
デバッグ
OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。
リクエストパラメータ
| パラメータ | データ型 | 必須 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | はい | DescribeBackupPolicy |
実行する操作。 値を DescribeBackupPolicy に設定します。 |
| DBInstanceId | String | はい | dds-bpxxxxxxxx |
インスタンス ID。 |
| AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメータ
| パラメータ | タイプ | 例 | 説明 |
|---|---|---|---|
| BackupRetentionPeriod | String | 7 |
バックアップ保持期間。 単位：日 |
| PreferredBackupPeriod | String | Monday,Wednesday,Friday,Sunday |
バックアップの期間。 有効値：
|
| PreferredBackupTime | String | 20:00Z-21:00Z |
バックアップが実行される期間。 形式：HH:mmZ-HH:mmZ。 |
| RequestId | String | C2C283A1-1CC4-4DD9-B985-3811E0244A45 |
リクエスト ID。 |
例
リクエストの例
http(s)://mongodb.aliyuncs.com/? Action=DescribeBackupPolicy
DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
通常のレスポンスの例
XML 形式
<DescribeBackupPolicyResponse>
<PreferredBackupPeriod>Monday,Wednesday,Friday,Sunday</PreferredBackupPeriod>
<RequestId>C2C283A1-1CC4-4DD9-B985-3811E0244A45</RequestId>
<PreferredBackupTime>20:00Z-21:00Z</PreferredBackupTime>
<BackupRetentionPeriod>7</BackupRetentionPeriod>
</DescribeBackupPolicyResponse>
JSON 形式
{
"PreferredBackupPeriod":"Monday,Wednesday,Friday,Sunday",
"RequestId":"C2C283A1-1CC4-4DD9-B985-3811E0244A45",
"BackupRetentionPeriod":"7",
"PreferredBackupTime":"20:00Z-21:00Z"
}