DescribeDLAService查看备份计划的DLA服务-数据管理 DMS-阿里云

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeDLAService

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID，您可以调用 DescribeBackupPlanList 查询。	dbstooi01exXXXX
ClientToken	string	否	任意字符串。	DBS

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID。	4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCode	string	错误码。	Param.NotFound
Success	boolean	是否请求成功。	true
State	string	备份计划的 DLA 服务状态，取值： Running：运行中 Closing：关闭中 Closed：已关闭	Running
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
AutoAdd	boolean	是否开启增量数据自动入湖，开启后，系统会自动将新产生的备份集添加入湖，取值： true：开启 false：不开启	true
HaveJobFailed	boolean	返回结果中是否存在失败的 DLA 任务，取值： true：存在 false：不存在	false

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "State": "Running",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "AutoAdd": true,
  "HaveJobFailed": false
}

错误码

HTTP status code	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

更多信息，参考变更详情。