DescribePrinsBackupPlan - 查询备份计划详情_云数据库专属集群(MyBase)-阿里云帮助中心

查询在 MyBase 实例纳管页创建的 DBS 备份计划详情，返回为空时说明纳管实例未创建备份计划。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cddc:DescribePrinsBackupPlan	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可查看地域信息获取。	cn-hangzhou
InstanceName	string	是	自建纳管实例名称	pr-22a21ac289e****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	D6E068C3-25BC-455A-85FE-45F0B22****
BackupPlan	object	备份计划详情列表。
BackupPlanId	string	备份计划 ID。	dbsrhm5j8rm****
BackupPlanName	string	备份计划名称。	test****
UserName	string	备份使用的数据库账号名。	test_user
EcsInstanceId	string	ECS 实例 ID。	i-bp1726beecvi8kak****
BackupStartTime	string	备份开始时间，格式为 HH:mm。	14:22
InstanceClass	string	规格，返回值如下： micro：入门型 small：低配型 medium：中配型 large：高配型 xlarge：高配型（无流量上限）	micro
BackupPeriod	string	全量备份周期，取值： Monday：周一 Tuesday：周二 Wednesday：周三 Thursday：周四 Friday：周五 Saturday：周六 Sunday：周日说明支持选择多个取值，用英文逗号（,）分开。	Monday
BackupPlanStatus	string	备份计划状态，返回值如下： wait：未配置 init：未启动（预检查失败） running：运行中 stop：失败 pause：暂停 locked：锁定中 check_pass：预检查通过	running
DatabaseType	string	数据库类型，取值如下： MYSQL	MySQL
BackupPlanCreateTime	string	备份计划创建时间戳。	1582527713000
ResourceGroupId	string	资源组 ID。	rg-aek3ckqdbgg****
OssHint	boolean	用户是否已开通 OSS 服务。注意若返回为 false 则无法正常创建备份计划，需要先开通 OSS 服务。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22****",
  "BackupPlan": {
    "BackupPlanId": "dbsrhm5j8rm****",
    "BackupPlanName": "test****",
    "UserName": "test_user",
    "EcsInstanceId": "i-bp1726beecvi8kak****",
    "BackupStartTime": "14:22",
    "InstanceClass": "micro",
    "BackupPeriod": "Monday",
    "BackupPlanStatus": "running",
    "DatabaseType": "MySQL",
    "BackupPlanCreateTime": 1582527713000,
    "ResourceGroupId": "rg-aek3ckqdbgg****"
  },
  "OssHint": true
}

错误码

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