更新时间:2023-09-13 GMT+08:00

批量修改源库/目标库密码

功能介绍

任务启动之后需要修改源库/目标库密码时调用此接口。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

接口约束

  • 任务状态为STARTJOBING、STARTJOB_FAILED、FULL_TRANSFER_STARTED、FULL_TRANSFER_FAILED、FULL_TRANSFER_COMPLETE、INCRE_TRANSFER_STARTED、INCRE_TRANSFER_FAILED、PAUSING时才能调用。
  • 双主灾备时父任务不支持调用。

URI

PUT /v3/{project_id}/jobs/batch-modify-pwd

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

取值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

Array of objects

批量修改数据库密码信息列表。

详情请参见表4

表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

db_password

String

数据库密码。

end_point_type

String

类型。so:源库;ta:目标库。

取值:

  • so
  • ta

job_id

String

任务ID。

kerberos

Object

kerberos认证需要的信息。

详情请参见表5

表5 kerberos字段数据结构说明

参数

是否必选

参数类型

描述

krb5_conf_file

String

krb5配置文件。

key_tab_file

String

key文件。

domain_name

String

域名。

user_principal

String

Kerberos用户对象。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

count

Integer

总数。

results

Array of objects

批量修改任务返回列表。

详情请参见表7

表7 results字段数据结构说明

参数

参数类型

描述

id

String

任务ID。

status

String

状态。取值:

  • success:成功。
  • failed:失败。

end_point_type

String

类型。so:源库;ta:目标库。

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

批量修改指定任务的源库和目标库密码

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modify-pwd

{
  "jobs" : [ {
    "db_password" : "********",
    "end_point_type" : "so",
    "job_id" : "25df459d-a37c-41b9-bc2b-8c00ba32jb52"
  }, {
    "db_password" : "********",
    "end_point_type" : "ta",
    "job_id" : "25df459d-a37c-41b9-bc2b-8c00ba32jb52"
  } ]
}

响应示例

状态码: 200

OK

{
  "results" : [ {
    "id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
    "status" : "success",
    "end_point_type" : "so"
  }, {
    "id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
    "status" : "success",
    "end_point_type" : "ta"
  } ],
  "count" : 2
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码