json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 表1
调用说明 数据复制服务提供了REST(Representational State Transfer)风格API。 支持您通过HTTPS请求调用。 调用方法请参见如何调用API。 父主题: 使用前必读
约束限制 您能创建的数据复制任务的数量与配额有关系,具体请参见服务配额。 目前V3 API接口仅支持MySQL->MySQL迁移和同步,MongoDB->DDS迁移,MySQL->Kafka同步,TaurusDB->Kafka同步,GaussDB->GaussDB同步,Gauss
状态码 状态码如表1所示: 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
本小节以创建实时迁移任务为示例,介绍如何通过调用API创建任务。 涉及API IAM获取Token的API。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 创建DRS实时迁移任务的API。 具体步骤 Token认
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID(domain-id),所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 注册并登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面的项目列表中查看账号ID。 图1 获取账号ID
获取任务ID 在调用接口的时候,部分URL中需要填入任务ID,所以需要获取到任务ID。任务ID获取方法如下: 从控制台获取任务ID 登录数据复制服务管理控制台。 在任务管理界面,查看任务ID。 或单击任务名称,在“基本信息”页签,查看当前任务的ID。 图1 基本信息 通过API获取任务ID
引擎类型说明 DRS各引擎类型对应取值可参考引擎类型说明。 表1 引擎类型说明 引擎类型(engine_type) 说明 对应源数据库取值(db_type) 对应目标数据库取值(db_type) mysql MySQL到MySQL迁移、MySQL到MySQL同步场景使用。 mysql
任务创建流程 迁移任务创建流程 图1 实时迁移任务创建流程 获取用户token:通过调用IAM服务的API,获取用户的Token。 创建迁移实例:根据需要,创建迁移任务。 查询任务创建进度:查询任务当前具体状态 测试连接:测试与源库和目标库的连接,以便继续进行任务。 更新任务信息
项目ID。 调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{endpoint}/v3/projects/”,其中{endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
批量启动任务 场景描述 本章节指导用户通过调用批量启动任务接口,启动多个配置完成的任务。 操作步骤 参考认证鉴权,通过调用IAM服务的API,获取用户的Token。 参考获取任务ID,获取需要查询的任务ID。 URI格式: /v3/{project_id}/jobs/batch-starting
批量查询任务状态 场景描述 本章节指导用户通过调用批量查询任务状态,查询租户下所有任务状态。 操作步骤 参考认证鉴权,通过调用IAM服务的API,获取用户的Token。 参考获取任务ID,获取需要查询的任务ID。 URI格式: /v3/{project_id}/jobs/batch-status
异常响应要素说明 表1 异常响应要素说明 名称 参数类型 说明 error_code String 接口响应异常时返回的错误编码,详细错误码描述参考错误码。 error_msg String 接口响应异常时返回的错误描述信息。 响应样例 { "error_code": "DRS
批量查询任务详情 场景描述 本章节指导用户通过调用批量查询任务详情,查询租户下所有任务详情。 操作步骤 参考认证鉴权,通过调用IAM服务的API,获取用户的Token。 参考获取任务ID,获取需要查询的任务ID。 URI格式: /v3/{project_id}/jobs/batch-detail
AZ构建高可用性系统的需求。 图1阐明了区域和可用区之间的关系。 图1 区域和可用区 目前,华为云已在全球多个地域开放云服务,您可以根据需求选择适合自己的区域和可用区。更多信息请参见华为云全球站点。 如何选择区域? 选择区域时,您需要考虑以下几个因素: 地理位置 一般情况下,建议
终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询DRS服务的终端节点。 父主题: 使用前必读
通用请求Http Status Code 正常 表1 正常返回说明 返回值 说明 200 请求成功。 202 异步请求成功提交(任务执行等)。 异常 表2 异常返回说明 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。
DRS授权分类 “√”表示支持,“x”表示暂不支持。 表1 任务功能 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 批量创建任务 POST /v3/{project_id}/jobs/batch-creation
备AZ的实例,继续提供数据复制服务。 建议妥善管理认证凭证,减少因凭证泄露导致的数据泄露风险 通过代码调用OpenAPI接口或者使用API Explorer使用接口时,需要通过账户密码或AK/SK信息获取token,需要遵循安全编码规范,妥善管理认证凭证,编写代码不要明文硬编码认证信息。
您即将访问非华为云网站,请注意账号财产安全