首页 数据库备份 DBS API参考(2019-03-06) API目录 服务管理 GetDBListFromAgent - 通过备份网关获取数据库列表

GetDBListFromAgent - 通过备份网关获取数据库列表

调用GetDBListFromAgent接口,通过备份网关获取物理备份的库表数据。

接口说明

您需要调用CreateGetDBListFromAgentTask接口创建一个异步任务获取TaskId(异步任务ID)。将TaskId传入GetDBListFromAgent接口后,即可获取物理备份库表数据。

调试

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

调试

授权信息

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

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

请求参数

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

备份网关ID,可通过调用DescribeBackupGatewayList接口获取该参数的值。

说明此参数为必填项。
160***
SourceEndpointRegionstring

备份网关地域ID。

cn-hangzhou
TaskIdlong

异步任务ID,调用CreateGetDBListFromAgentTask获取该参数的值。

123456
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ETnLKlblzczshOTUbOCzxxxxxxxxxx

返回参数

名称类型描述示例值
object

返回值详情如下。

HttpStatusCodeinteger

错误码值。

400
RequestIdstring

请求ID。

EB4DFD5E-3618-498D-BE35-4DBEA0072122
ErrCodestring

错误码字符串。

InvalidParameter
Successboolean

请求成功状态。

true
ErrMessagestring

错误信息。

This backupPlan can't support this action
DbListarray

数据库列表。

string

数据库列表。

TaskDB

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 400,
  "RequestId": "EB4DFD5E-3618-498D-BE35-4DBEA0072122",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "This backupPlan can't support this action",
  "DbList": {
    "dbName": [
      "TaskDB"
    ]
  }
}

错误码

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

阿里云首页 数据库备份 相关技术圈