调用DescribeBackupPolicy接口查询MongoDB实例的备份策略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeBackupPolicy

要执行的操作，取值：DescribeBackupPolicy。

DBInstanceId String 是 dds-bpxxxxxxxx

实例ID。
RegionId String 否 cn-hangzhou

实例所属的地域ID，您可以通过调用DescribeDBInstanceAttribute进行查询。

AccessKeyId String 否 LTAIgbTGpxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
BackupRetentionPeriod String 7

备份保留天数。
PreferredBackupPeriod String Monday,Wednesday,Friday,Sunday

备份周期。

  • Monday：周一。
  • Tuesday：周二。
  • Thursday：周四。
  • Friday：周五。
  • Saturday：周六。
  • Sunday：周日。
PreferredBackupTime String 20:00Z-21:00Z

备份时间，格式为HH:mmZ-HH:mmZ（UTC时间）。

RequestId String C2C283A1-1CC4-4DD9-B985-3811E0244A45

请求ID。

示例

请求示例


http(s)://mongodb.aliyuncs.com/?Action=DescribeBackupPolicy
DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>

正常返回示例

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",
	"PreferredBackupTime":"20:00Z-21:00Z",
	"BackupRetentionPeriod":"7"
}

错误码

访问错误中心查看更多错误码。