CreateGetDBListFromAgentTask
该接口用于通过备份网关获取数据库列表任务
服务地址:
华东1 金融云
输入参数
只看必填
BackupGatewayId备份网关ID
DatabaseType数据库类型
SourceEndpointRegion备份网关地域ID
SourceEndpointIP数据库连接地址
SourceEndpointPort数据库连接端口
幂等性参数
ClientToken用于保证请求的幂等性
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

本 API 操作会返回 TaskId,您可以使用 GetDBListFromAgent 接口做结果查询。

请求参数

字段名称字段详情
BackupGatewayIdinteger<int64>

备份网关 ID,可通过调用 DescribeBackupPlanList 接口查看。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:160813参考取值来源:
    DescribeBackupGatewayList
DatabaseTypestring

数据库类型,取值:展开详情

示例值:MySQL
SourceEndpointRegionstring

备份网关地域 ID。

示例值:cn-hangzhou
SourceEndpointIPstring

数据库连接地址。

示例值:123.0.XX.XX参考取值来源:
    DescribeRestoreRangeInfo
SourceEndpointPortinteger<int32>

数据库连接端口。

示例值:3306
ClientTokenstring

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

示例值:ETnLKlblzczshOTUbOCzxxxxxxxxxx

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

错误码值。

示例值:400
RequestIdstring

请求 ID。

示例值:EB4DFD5E-3618-498D-BE35-4DBEA0072122
ErrCodestring

错误码字符串。

示例值:InvalidParameter
Successboolean

请求状态。

示例值:true
ErrMessagestring

错误信息。

示例值:This backupPlan can't support this action
TaskIdinteger<int64>

异步任务 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:123456
变更历史
暂无变更历史