批量主备倒换
功能介绍
批量主备倒换。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
接口约束
只有状态为灾备中、灾备异常的任务,且与灾备数据库连接正常时可以进行主备倒换,双主灾备不支持倒换。
URI
POST /v3/{project_id}/jobs/batch-switchover
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
指定类型为application/json。 缺省值:application/json |
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
X-Language |
否 |
String |
请求语言类型。 缺省值:en-us 取值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
jobs |
是 |
Array of strings |
批量主备调换的任务详情ID请求列表。 |
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
results |
Array of objects |
批量主备倒换任务返回列表。 详情请参见表5。 |
count |
Integer |
总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID。 |
updated_at |
String |
更新时间,格式yyyy-MM-dd'T'HH:mm:ss'Z'。 |
source_db |
Object |
源数据库。 详情请参见表6。 |
target_db |
Object |
目标数据库。 详情请参见表6。 |
job_direction |
String |
任务方向。取值:
|
is_target_readonly |
Boolean |
目标库是否只读。 |
error_msg |
String |
错误信息。 |
error_code |
String |
错误码。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
数据库ID。 |
obj_id |
String |
对象ID。 |
instance_name |
String |
RDS实例名称。 |
db_type |
String |
数据库类型。取值:
|
db_user |
String |
数据库用户。 |
db_password |
String |
数据库密码。 |
manage_ip |
String |
管理IP。 |
traffic_ip |
String |
流量IP。 |
db_port |
Integer |
数据库端口。 |
region |
String |
RDS实例所在Region。 |
created_at |
String |
创建日期,格式yyyy-MM-dd'T'HH:mm:ss'Z'。 |
updated_at |
String |
修改日期,格式yyyy-MM-dd'T'HH:mm:ss'Z'。 |
ip |
String |
迁移实例所在的私有IP。 |
public_ip |
String |
迁移实例所在的公网IP。 |
az_code |
String |
可用区azCode。 |
security_group_id |
String |
源库所在的安全组ID。 |
subnet_id |
String |
源库所在的子网ID。 |
vpc_id |
String |
源库所在的虚拟私有云ID。 |
volume_size |
Long |
迁移实例的磁盘大小。 |
full_trans_user_pwd |
String |
全量迁移用户密码,密文。 |
increment_trans_user_pwd |
String |
增量迁移用户密码,密文。 |
ssl_link |
Boolean |
是否SSL安全连接。 |
ssl_cert_key |
String |
SSL证书内容。 |
ssl_cert_name |
String |
SSL证书名字。 |
ssl_cert_check_sum |
String |
SSL证书内容checksum值。 |
ssl_cert_password |
String |
SSL证书密码,密文。 |
db_version |
String |
数据库版本。 |
mongo_ha_mode |
String |
mongoHa模式。取值:
|
project_id |
String |
RDS实例projectId。 |
cluster_mode |
String |
集群模式。取值:
|
instance_id |
String |
RDS实例ID。 |
db_name |
String |
Oracle服务名serviceName。 |
topic |
String |
mrskafka topic名称。 |
safe_mode |
Integer |
MRSkafka是否开启kerberos认证。取值:
|
kerberos_vo |
Object |
kerberos认证需要的信息。 详情请参见表7。 |
multi_write_db_id |
String |
多写数据库ID。 |
请求示例
批量进行主备倒换
https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-switchover { "jobs" : [ "8d0e8e36-a618-490d-8a46-8c61ac9jb502" ] }
响应示例
状态码: 202
Accepted
{ "count" : 1, "results" : [ { "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502", "updated_at" : "2020-12-18T06:38:37Z", "source_db" : { "id" : "2706a49b-6dd0-4b70-b2a8-36cf0034703d", "region" : "cn-xianhz-1", "ip" : "192.168.1.144", "topic" : null, "obj_id" : "0b51710fd4e54d6bb90ab91bf68f86efno01", "instance_name" : "rds-zw-source", "db_type" : "mysql", "db_user" : "root", "db_password" : "********", "manage_ip" : null, "traffic_ip" : "192.168.1.144", "db_port" : 3306, "created_at" : "2020-12-16T12:09:54Z", "updated_at" : "2020-12-18T06:33:09Z", "public_ip" : null, "az_code" : "az3xahz", "security_group_id" : "652cbe2d-d487-407e-b666-d01948b33879", "subnet_id" : "c6f66ccb-be7a-499e-aa8a-1389355e67a8", "vpc_id" : "7c73a425-885b-4e54-a0e6-ef9ee271a1db", "volume_size" : null, "full_trans_user_pwd" : "******", "increment_trans_user_pwd" : "******", "ssl_link" : false, "ssl_cert_key" : null, "ssl_cert_name" : null, "ssl_cert_check_sum" : null, "ssl_cert_password" : null, "db_version" : "5.7.31", "mongo_ha_mode" : null, "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "cluster_mode" : "Single", "instance_id" : "3efbb0f1241f429e8e1d8f99ab094c7ain01", "db_name" : null, "safe_mode" : null, "kerberos_vo" : null, "multi_write_db_id" : null }, "target_db" : { "id" : "81ca3c57-029b-4a37-8f2d-2ee5f128ef9d", "region" : "cn-xianhz-1", "ip" : "192.168.1.60", "topic" : null, "obj_id" : "b46e908dbbb44bb3b17f0a75c908d1d7no01", "instance_name" : "rds-zw-target", "db_type" : "mysql", "db_user" : "root", "db_password" : "********", "manage_ip" : null, "traffic_ip" : "192.168.1.60", "db_port" : 3306, "created_at" : "2020-12-16T12:09:55Z", "updated_at" : "2020-12-18T06:33:08Z", "public_ip" : null, "az_code" : "az3xahz", "security_group_id" : "652cbe2d-d487-407e-b666-d01948b33879", "subnet_id" : "c6f66ccb-be7a-499e-aa8a-1389355e67a8", "vpc_id" : "7c73a425-885b-4e54-a0e6-ef9ee271a1db", "volume_size" : 40, "full_trans_user_pwd" : "******", "increment_trans_user_pwd" : "******", "ssl_link" : false, "ssl_cert_key" : null, "ssl_cert_name" : null, "ssl_cert_check_sum" : null, "ssl_cert_password" : null, "db_version" : "5.7.31", "mongo_ha_mode" : null, "project_id" : "054ba152d480d55b2f5dc0069e7ddef0", "cluster_mode" : "Single", "instance_id" : "a3ab61173b1b4533b8c3dfc2bb3ec828in01", "db_name" : null, "safe_mode" : null, "kerberos_vo" : null, "multi_write_db_id" : null }, "job_direction" : "down", "is_target_readonly" : false } ] }
状态码
状态码 |
描述 |
---|---|
202 |
Accepted |
400 |
Bad Request |
错误码
请参见错误码。