调用DescribeBackupPlan描述备份计划。

调试

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

请求参数

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

系统规定参数。取值：DescribeBackupPlan。
ClusterId String 是 cds-uf6m0bo****6158

备份集群ID。
DataCenterId String 是 cn-shanghai-e

备份集群数据中心ID。

返回数据

名称 类型 示例值 描述
BackupPlan Struct

备份计划详情列表。
Active Boolean true

备份计划是否激活。
BackupPeriod String Monday

备份周期。取值范围Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday。
BackupTime String 00:30Z

每天开始备份的时间，UTC 通用标准时，以Z来标识。
ClusterId String cds-uf6m0b****7v6159

备份集群ID。
CreatedTime String 2020-02-26T01:56Z

备份计划创建时间。UTC 通用标准时，以Z来标识。
DataCenterId String cn-shanghai-e

备份集群数据中心ID。
RetentionPeriod Integer 7

创建备份计划保留天数取值范围：1-7天。
RequestId String 0EA95AA2-860C-42CB-97CF-78CA3937E0D5

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupPlan
&ClusterId=cds-uf6m0bo****6158
&DataCenterId=cn-shanghai-e
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeBackupPlanResponse>
      <RequestId>0EA95AA2-860C-42CB-97CF-78CA3937E0D5</RequestId>
      <BackupPlan>
            <DataCenterId>cn-shanghai-e</DataCenterId>
            <BackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</BackupPeriod>
            <Active>true</Active>
            <CreatedTime>2020-02-26T01:56Z</CreatedTime>
            <ClusterId>cds-uf6m0bo****v6159</ClusterId>
            <BackupTime>00:30Z</BackupTime>
            <RetentionPeriod>7</RetentionPeriod>
      </BackupPlan>
</DescribeBackupPlanResponse>

JSON 格式 

{
  "RequestId": "0EA95AA2-860C-42CB-97CF-78CA3937E0D5",
  "BackupPlan": {
    "DataCenterId": "cn-shanghai-e",
    "BackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
    "Active": true,
    "CreatedTime": "2020-02-26T01:56Z",
    "ClusterId": "cds-uf6m0bo****v6159",
    "BackupTime": "00:30Z",
    "RetentionPeriod": 7
  }
}

错误码

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