华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 en-us：英文 zh-cn：中文 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 备份迁移任务名称。 description 否 String 备份迁移任务描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 en-us：英文 zh-cn：中文

响应示例 状态码： 200 OK { "id" : "0667845a-6291-4e2a-95b0-190c0abjb703", "status" : "SUC CES S", "create_time" : "2024-08-19T02:27:15Z", "finish_time" : "2024-08-19T02:29:03Z", "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "file_info" : [ { "file_name" : "1706510914000_1_Test_Database.bak", "file_size" : "704KB", "file_last_modify" : "1706511360000" } ] }, "base_info" : { "name" : "DRS-6813", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "目标RDS实例名称：rds-sqlserver2022-stand" }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04" }, "options" : { "is_cover" : true, "is_default_restore" : true, "is_last_backup" : false, "is_precheck" : true, "is_delete_backup_file" : false, "recovery_mode" : "full", "db_names" : [ ] }, "new_db_names" : "[]", "instance_name" : "" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job ID." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 备份迁移任务总数。 jobs Array of OfflineTaskInfo objects 备份迁移任务列表。 表5 OfflineTaskInfo 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务状态。 TRANSFERRING：恢复中 SUCCESS：成功 FAILED：失败 PRECHECK FAILED：预检查失败 engine_type String 数据库引擎。 sqlserver：RDS for SQL Server引擎 error_log String 错误日志。 description String 描述。 create_time String 任务创建时间。 finish_time String 任务完成时间。 enterprise_project_id String 企业项目。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK { "jobs" : [ { "id" : "0667845a-6291-4e2a-95b0-190c0abjb703", "name" : "DRS-6813", "status" : "SUCCESS", "description" : "目标RDS实例名称：rds-sqlserver2022-stand", "engine_type" : "sqlserver", "create_time" : "2024-08-19T02:27:15Z", "finish_time" : "2024-08-19T02:29:03Z", "enterprise_project_id" : "0" } ], "count" : 35 } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

URI GET /v5/{project_id}/backup-migration-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 任务名称，支持模糊搜索。 status 否 String 备份迁移任务状态。 TRANSFERRING：恢复中 SUCCESS：成功 FAILED：失败 PRECHECK FAILED：预检查失败 dbs_instance_ids 否 Array of strings 数据库实例ID，最大数量为10。 description 否 String 描述。 create_at 否 String 创建时间。 completed_at 否 String 完成时间。 enterprise_project_id 否 String 企业项目ID。 tags 否 String 标签。 limit 否 Integer 查询返回记录的数量限制，默认值为10。 offset 否 Integer 偏移量，默认值为0，表示查询该偏移量后面的记录。 sort_key 否 String 排序字段。 sort_dir 否 String 排序方法。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 en-us：英文 zh-cn：中文

请求示例 通过OBS备份文件进行全量备份恢复。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7526", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "目标RDS实例名称：rds-sqlserver-2022-stand", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "1706510914000_0_Test_Database.bak", "obs_path" : "" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "full", "is_default_restore" : true, "is_last_backup" : true, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } } RDS备份文件备份恢复。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7526", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "miao'shu", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "0d87037d934848999fdc10bbabb08e6fbr04" }, "backup_info" : { "file_source" : "RDS", "files" : [ { "name" : "", "obs_path" : "", "rds_version" : "2019_EE", "rds_source_instance_id" : "7fb189b57339473a929d41dabb3878a2in04" } ] }, "options" : { "is_precheck" : true, "recovery_mode" : "", "is_last_backup" : "", "reset_db_name_map" : { "db_test12" : "", "db_hailiang_schema" : "", "db_sqls2v5_01" : "" }, "db_names" : [ "db_test12", "db_hailiang_schema", "db_sqls2v5_01" ] } } 通过OBS桶备份文件进行全量+增量备份恢复。 首先进行一次全量迁移，is_last_backup选择“false”。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7527", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "描述", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "ims.bak", "obs_path" : "floder/" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "full", "is_default_restore" : true, "is_last_backup" : false, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } } 通过OBS桶备份文件进行全量+增量备份恢复。 全量迁移完成后，然后进行一次增量迁移。如果不止一个增量备份文件，is_last_backup依然选择“false”。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7527", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "描述", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "ims_log1.bak", "obs_path" : "floder/" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "incre", "is_default_restore" : true, "is_last_backup" : false, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } } 通过OBS桶备份文件进行全量+增量备份恢复。 停止数据库业务，进行最后一次增量迁移，is_last_backup选择“true”。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/backup-migration-jobs { "base_info" : { "name" : "DRS-7527", "engine_type" : "sqlserver", "enterprise_project_id" : "0", "description" : "描述", "tags" : [ ] }, "target_db_info" : { "target_instance_id" : "0a3182607bc549bcb46cc9a8755761a6in04", "ms_file_stream_status" : "off", "file_id" : "" }, "backup_info" : { "file_source" : "OBS", "bucket_name" : "zyy-obs", "files" : [ { "name" : "ims_log2.bak", "obs_path" : "floder/" } ] }, "options" : { "is_cover" : true, "recovery_mode" : "incre", "is_default_restore" : true, "is_last_backup" : true, "reset_db_name_map" : { }, "is_precheck" : true, "is_delete_backup_file" : true, "db_names" : [ "" ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 driver_name 是 String JDBC驱动文件名称，name的长度5-64，结尾以.jar结尾。 driver_type 是 String 指定待同步的驱动文件类型。取值范围： db2：DB2 for LUW informix：Informix

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 驱动文件总数。 items Array of DriverInfo objects 驱动文件列表。 表5 DriverInfo 参数 参数类型 描述 driver_name String 文件名称。 last_modified String 最后修改时间。 size Integer 文件大小，单位：byte

URI GET /v5/{project_id}/drivers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量。默认为10。 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0。 driver_type 是 String 指定待查询的驱动文件类型。取值范围： db2：DB2 for LUW informix：Informix

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 driver_type 是 String 指定待删除的驱动文件类型。取值范围： db2：DB2 for LUW informix：Informix driver_names 是 Array of strings JDBC驱动文件列表，列表长度1-20，driver_name的长度5-64，结尾以.jar结尾。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 表4 FormData参数 参数 是否必选 参数类型 描述 file 是 File 驱动文件，驱动文件名称长度5-64，以jar结尾，文件名相同会替换远程驱动文件。

URI POST /v5/{project_id}/driver 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 driver_type 是 String 指定待上传的驱动文件类型。取值范围： db2：DB2 for LUW informix：Informix

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

响应示例 状态码： 200 OK { "count" : 1, "ddl_list" : [ { "seqno" : 30, "checkpoint" : "mysql-bin.000006:431;200e3d00-4a57-11ef-8a76-fa163ef2208a:7;200e3d00-4a57-11ef-8a76-fa163ef2208a:1-7", "status" : 1, "ddl_timestamp" : 1721894317000, "ddl_text" : "/* sql from das */ALTER TABLE `test1`.`test1`\n\tADD COLUMN `gender` VARCHAR(32) NULL AFTER `name`", "exe_result" : true, "record_time" : 1721894318544, "clean_time" : 1721897321317 } ] } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 ddl_list Array of DdlAlarmResp objects DDL告警信息列表。 count Integer 列表中的项目总数，与分页无关。 表5 DdlAlarmResp 参数 参数类型 描述 seqno Long 记录唯一序号。 checkpoint String 数据源库位点。 status Integer DDL告警状态。0无告警，1告警中。 ddl_timestamp Long DDL在源库执行时间。 ddl_text String DDL内容。 exe_result Boolean DDL执行结果。false执行失败，true执行成功。 record_time Long 数据记录时间。 clean_time Long DDL告警清理时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v5/{project_id}/jobs/{job_id}/ddl 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，默认值为0，表示查询该偏移量后面的记录。 limit 否 Integer 查询返回记录的数量限制.默认值为10。 start_seq_no 否 Long DDL序列起始值。 end_seq_no 否 Long DDL序列结束值。 status 否 Integer DDL状态，0为无告警，1为告警中。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

请求示例 修改指定连接示例。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/connections/835e1d79-24ac-411d-a1c8-22c000280659 { "name" : "DRS-mysql-newName", "db_type" : "mysql", "description" : "description-new", "endpoint" : { "endpoint_name" : "mysql", "ip" : "127.0.0.1", "db_port" : "3306", "db_user" : "root", "db_password" : "password" }, "ssl" : { "ssl_link" : false }, "enterprise_project_id" : "0" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 连接名称。 db_type 否 String 数据库类型。 config 否 ConnectionConfig object 连接配置，不同类型的连接配置不同。 description 否 String 连接描述。 endpoint 否 BaseEndpoint object 数据库连接基本信息。 vpc 否 CloudVpcInfo object 数据库实例所在VPC，子网，安全组等信息。 ssl 否 EndpointSslConfig object 数据库SSL证书信息。 cloud 否 CloudBaseInfo object 数据库实例所在Region，项目等信息。 enterprise_project_id 否 String 企业项目ID。 表4 ConnectionConfig 参数 是否必选 参数类型 描述 driver_name 否 String 驱动程序名称。 表5 BaseEndpoint 参数 是否必选 参数类型 描述 id 否 String 数据库信息ID。 endpoint_name 是 String 数据库场景类型。取值： oracle：云下自建Oracle数据库。 ecs_oracle：华为云E CS 自建Oracle数据库。 cloud_gaussdbv5：华为云数据库 GaussDB 分布式。 mysql：他云/本地自建MySQL数据库。 ecs_mysql：华为云ECS自建MySQL数据库。 cloud_mysql：华为云数据库RDS for MySQL。 redis：云下自建Redis数据。 ecs_redis：华为云ECS自建Redis数据。 rediscluster：云下自建Redis集群数据库。 ecs_rediscluster：华为云ECS自建Redis集群数据库。 cloud_gaussdb_redis：华为云数据库GeminiDB Redis。 postgresql: 云下自建PostgreSQL数据库。 ecs_postgresql: 华为云ECS自建PostgreSQL数据库。 cloud_postgresql: 华为云数据库RDS for PostgreSQL。 mongodb: 云下自建MongoDB数据库。 ecs_mongodb: 华为云ECS自建MongoDB数据库。 cloud_mongodb: 华为云文档数据库服务DDS。 ip 否 String 数据库IP。约束：- 数据库为自建MongoDB时，数据库IP与端口之间用“:”英文冒号拼接，多个值之间请用“,”英文逗号隔开，最多支持填写3个IP地址或 域名 。- 数据库为DDS实例时，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔。- 数据库为Redis集群时，请填写源端Redis集群所有分片的IP地址和对应端口，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔，并且推荐填写集群分片的Slave节点的IP地址。最多支持填写32个IP地址或域名，多个值之间请用英文逗号隔开。示例：- MySQL：ip- MongoDB：ip:port,ip:port,ip:port- DDS：ip:port,ip:port - Redis集群：ip:port,ip:port db_port 否 String 数据库端口。 约束：输入范围为1-65535之间的整数。 db_user 是 String 数据库用户名。 db_password 是 String 数据库密码。 instance_id 否 String 华为云数据库实例ID。 instance_name 否 String 华为云数据库实例名称。 db_name 否 String 指定数据库名称。例如： oracle：serviceName.orcl。 source_sharding 否 Array of BaseEndpoint objects 物理源库信息。 表6 CloudVpcInfo 参数 是否必选 参数类型 描述 vpc_id 是 String 数据库实例所在的虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id 是 String 数据库实例所在子网ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id 否 String 数据库实例所在的安全组ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 表7 EndpointSslConfig 参数 是否必选 参数类型 描述 ssl_link 否 Boolean 是否SSL安全连接。如果数据库启用了SSL安全连接，参数值为true。 ssl_cert_name 否 String SSL证书名字。 ssl_cert_key 否 String SSL证书内容，用base64加密。 ssl_cert_check_sum 否 String SSL证书内容checksum值，后端校验，源库安全连接必选。 ssl_cert_password 否 String SSL证书密码，证书文件后缀为.p12时必填。 表8 CloudBaseInfo 参数 是否必选 参数类型 描述 region 是 String 区域ID，当数据库实例类型为ecs（华为云ECS自建数据库），cloud（华为云数据库）时为必填项。获取方法请参见地区和终端节点。 注意：当该Region下存在子项目时，Region ID为区域项目ID与子项目ID，由“_”下划线拼接，例如：cn-north-4_abc。 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 az_code 否 String 数据库所在可用分区（AZ）名称。

响应示例 状态码： 200 OK { "connections" : [ { "name" : "DRS-mysql", "db_type" : "mysql", "endpoint" : { "endpoint_name" : "mysql", "ip" : "127.0.0.1", "db_port" : "3306", "db_user" : "root" }, "description" : "description", "connection_id" : "835e1d79-24ac-411d-a1c8-22c000280659", "ssl" : { "ssl_link" : false }, "create_time" : 1716879012121, "enterprise_project_id" : "0" } ], "count" : 1 } 状态码： 400 Bad Request { "error_code" : "DRS.10000001", "error_msg" : "Failed." }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 connections Array of ConnectionResp objects 连接信息列表。 count Integer 列表中的项目总数，与分页无关。 表5 ConnectionResp 参数 参数类型 描述 connection_id String 连接ID。 name String 连接名称。 create_time Long 连接创建时间，格式为时间戳。 db_type String 连接类型。 config ConnectionConfig object 连接的配置项。 endpoint BaseEndpoint object 数据库基本信息。 vpc CloudVpcInfo object 数据库实例所在VPC，子网，安全组等信息。 ssl EndpointSslConfig object 数据库SSL证书信息。 enterprise_project_id String 企业项目ID。 description String 描述。 表6 ConnectionConfig 参数 参数类型 描述 driver_name String 驱动程序名称。 表7 BaseEndpoint 参数 参数类型 描述 id String 数据库信息ID。 endpoint_name String 数据库场景类型。取值： oracle：云下自建Oracle数据库。 ecs_oracle：华为云ECS自建Oracle数据库。 cloud_gaussdbv5：华为云数据库GaussDB分布式。 mysql：他云/本地自建MySQL数据库。 ecs_mysql：华为云ECS自建MySQL数据库。 cloud_mysql：华为云数据库RDS for MySQL。 redis：云下自建Redis数据。 ecs_redis：华为云ECS自建Redis数据。 rediscluster：云下自建Redis集群数据库。 ecs_rediscluster：华为云ECS自建Redis集群数据库。 cloud_gaussdb_redis：华为云数据库GeminiDB Redis。 postgresql: 云下自建PostgreSQL数据库。 ecs_postgresql: 华为云ECS自建PostgreSQL数据库。 cloud_postgresql: 华为云数据库RDS for PostgreSQL。 mongodb: 云下自建MongoDB数据库。 ecs_mongodb: 华为云ECS自建MongoDB数据库。 cloud_mongodb: 华为云文档数据库服务DDS。 ip String 数据库IP。约束：- 数据库为自建MongoDB时，数据库IP与端口之间用“:”英文冒号拼接，多个值之间请用“,”英文逗号隔开，最多支持填写3个IP地址或域名。- 数据库为DDS实例时，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔。- 数据库为Redis集群时，请填写源端Redis集群所有分片的IP地址和对应端口，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔，并且推荐填写集群分片的Slave节点的IP地址。最多支持填写32个IP地址或域名，多个值之间请用英文逗号隔开。示例：- MySQL：ip- MongoDB：ip:port,ip:port,ip:port- DDS：ip:port,ip:port - Redis集群：ip:port,ip:port db_port String 数据库端口。 约束：输入范围为1-65535之间的整数。 db_user String 数据库用户名。 db_password String 数据库密码。 instance_id String 华为云数据库实例ID。 instance_name String 华为云数据库实例名称。 db_name String 指定数据库名称。例如： oracle：serviceName.orcl。 source_sharding Array of BaseEndpoint objects 物理源库信息。 表8 CloudVpcInfo 参数 参数类型 描述 vpc_id String 数据库实例所在的虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id String 数据库实例所在子网ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id String 数据库实例所在的安全组ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 表9 EndpointSslConfig 参数 参数类型 描述 ssl_link Boolean 是否SSL安全连接。如果数据库启用了SSL安全连接，参数值为true。 ssl_cert_name String SSL证书名字。 ssl_cert_key String SSL证书内容，用base64加密。 ssl_cert_check_sum String SSL证书内容checksum值，后端校验，源库安全连接必选。 ssl_cert_password String SSL证书密码，证书文件后缀为.p12时必填。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

URI GET /v5/{project_id}/connections 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 connection_id 否 String 连接ID。 db_type 否 String 连接类型。 mysql oracle postgresql mongodb name 否 String 连接名称，忽略大小写。 inst_id 否 String 云上数据库实例ID。 ip 否 String 连接IP。 description 否 String 连接描述。 create_time 否 String 时间区间用“，”分隔。示例：2024-05-17T07:46:00.414Z,2024-05-20T07:46:00.999Z。 enterprise_project_id 否 String 企业项目ID。 offset 否 Integer 偏移量，默认值为0，表示查询该偏移量后面的记录。 limit 否 Integer 查询返回记录的数量限制.默认值为10。 fetch_all 否 Boolean 值为“true”时会使得offset和limit参数失效并返回所有记录。 sort_key 否 String 返回结果按该关键字排序，默认为“created_at”。 sort_dir 否 String 降序或升序（分别对应desc和asc，默认为“desc”）。

响应示例 状态码： 200 OK { "name" : "DRS-mysql", "db_type" : "mysql", "endpoint" : { "endpoint_name" : "mysql", "ip" : "127.0.0.1", "db_port" : "3306", "db_user" : "root" }, "description" : "description", "connection_id" : "835e1d79-24ac-411d-a1c8-22c000280659", "ssl" : { "ssl_link" : false }, "create_time" : 1716879012121, "enterprise_project_id" : "0" } 状态码： 400 Bad Request { "error_code" : "DRS.10010065", "error_msg" : "Connection manager name is already exists." }

请求示例 创建一个MySQL连接示例。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/connections { "name" : "DRS-mysql", "db_type" : "mysql", "description" : "description", "endpoint" : { "endpoint_name" : "mysql", "ip" : "127.0.0.1", "db_port" : "3306", "db_user" : "root", "db_password" : "password" }, "ssl" : { "ssl_link" : false }, "enterprise_project_id" : "0" }