全部产品
Search
文档中心

数据库备份 DBS:CreateGetDBListFromAgentTask - 创建数据库列表任务

更新时间:Mar 03, 2024

该接口用于通过备份网关获取数据库列表任务。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

说明 此参数为必填项。
160813
DatabaseTypestring

数据库类型,取值:

  • MySQL
  • MSSQL
  • Oracle
  • MariaDB
  • PostgreSQL
  • PPAS
  • DRDS
  • MongoDB
  • Redis
MySQL
SourceEndpointRegionstring

备份网关地域 ID。

cn-hangzhou
SourceEndpointIPstring

数据库连接地址。

123.0.XX.XX
SourceEndpointPortinteger

数据库连接端口。

3306
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
TaskIdlong

异步任务 ID。

123456

示例

正常返回示例

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史