DescribeDLAService - 查看数据查询服务(DLA)

更新时间: 2024-08-30 21:39:30

该接口用于查看备份计划的数据查询服务(DLA)。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:DescribeDLAServiceRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
BackupPlanIdstring

备份计划 ID,您可以调用 DescribeBackupPlanList 查询。

dbstooi01exXXXX
ClientTokenstring

任意字符串。

DBS

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID。

4F1888AC-1138-4995-B9FE-D2734F61C058
ErrCodestring

错误码。

Param.NotFound
Successboolean

是否请求成功。

true
Statestring

备份计划的 DLA 服务状态, 取值:

  • Running:运行中
  • Closing:关闭中
  • Closed:已关闭
Running
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
AutoAddboolean

是否开启增量数据自动入湖,开启后,系统会自动将新产生的备份集添加入湖,取值:

  • true:开启
  • false:不开启
true
HaveJobFailedboolean

返回结果中是否存在失败的 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错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: DescribePreCheckProgressList - 查看预检查进度列表 下一篇: GetDBListFromAgent - 通过备份网关获取数据库列表
阿里云首页 数据管理 相关技术圈