该接口用于通过备份网关获取数据库列表任务。
接口说明
本 API 操作会返回 TaskId，您可以使用 GetDBListFromAgent 接口做结果查询。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dbs:CreateGetDBListFromAgentTask | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BackupGatewayId | long | 否 | 备份网关 ID，可通过调用 DescribeBackupPlanList 接口查看。 说明
此参数为必填项。
| 160813 |
| DatabaseType | string | 否 | 数据库类型，取值：
| MySQL |
| SourceEndpointRegion | string | 否 | 备份网关地域 ID。 | cn-hangzhou |
| SourceEndpointIP | string | 否 | 数据库连接地址。 | 123.0.XX.XX |
| SourceEndpointPort | integer | 否 | 数据库连接端口。 | 3306 |
| ClientToken | string | 否 | 用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
返回参数
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 400,
"RequestId": "EB4DFD5E-3618-498D-BE35-4DBEA0072122",
"ErrCode": "InvalidParameter",
"Success": true,
"ErrMessage": "This backupPlan can't support this action",
"TaskId": 123456
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Request.Forbidden | Have no Permissions | 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史