华为云用户手册

URI GET /v1/{project_id}/objectstorage/task?start={start}&limit={limit}&state={state} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 start 是 起始的任务序号。 limit 是 返回任务个数的最大值，最大不超过100，否则查询失败。 state 否 任务状态。 0：初始化 1：等待调度 2：正在执行 3：停止 4：失败 5：成功

示例 请求示例 PUT /v1/{project_id}/objectstorage/task/{task_id} { "operation": "change_bandwidthpolicy", "bandwidth_policy": [ { "start": "00:00", "end": "23:59", "max_bandwidth": 50000000 } ] } 响应示例 无。

请求消息 请求参数 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 operation 是 String 操作类型，本接口为start。 source_ak 是 String 源端节点AK（最大长度100个字符）。 source_sk 是 String 源端节点SK（最大长度100个字符）。 target_ak 是 String 目的端节点AK（最大长度100个字符）。 target_sk 是 String 目的端节点SK（最大长度100个字符）。 source_cdn_authentication_key 否 String CDN鉴权秘钥。 migration_failed_object 否 Boolean 迁移类型，标识是否为全量迁移。 值为true时表示重传失败对象。 值为空或者为false时表示全量迁移。

示例 请求示例 POST /v1/{project_id}/objectstorage/task { "src_node": { "region": "source_region", "ak": "source_ak", "sk": "source_sk", "list_file": { "obs_bucket": "oms-file", "list_file_key": "object-keys.txt" }, "bucket": "source_bucket", "cloud_type": XXX }, "thread_num": 50, "enableKMS": true, "description": "xxx", "dst_node": { "region": "target_region", "ak": "target_ak", "sk": "target_sk", "object_key": "targetkey", "bucket": "targetbucket", "cloud_type": XXX }, "smnInfo": { "topicUrn": "urn:smn:region:3cfb09080bd944d0b4cdd72ef26857bd: OMS ", "triggerConditions": ["SUC CES S", "FAIL"], "language": "en-us" }, "task_type": "list", "migrate_since": 123456789 } 或 POST /v1/{project_id}/objectstorage/task { "src_node": { "region": "source_region", "ak": "source_ak", "sk": "source_sk", "object_key": { "path": "", "keys": ["object1", "object2"] }, "bucket": "source_bucket", "cloud_type": "XXX" }, "thread_num": 50, "enableKMS": true, "description": "xxx", "dst_node": { "region": "target_region", "ak": "target_ak", "sk": "target_sk", "object_key": "targetkey", "bucket": "targetbucket", "cloud_type": "XXX" }, "smnInfo": { "topicUrn": "urn:smn:region:3cfb09080bd944d0b4cdd72ef26857bd:OMS", "triggerConditions": ["SUCCESS", "FAIL"], "language": "en-us" }, "source_cdn": { "protocol": "https", "domain": "xxx.xxx.xxx", "authentication_type": "NONE" }, "bandwidth_policy": [ { "start": "00:00", "end": "23:59", "max_bandwidth": 50000000 } ] }

操作步骤 获取 IAM 用户Token。 接口相关信息 URI格式：POST /v3/auth/tokens 详情请参见获取IAM用户Token（使用密码）。 请求示例 POST: https://{iam_endpoint}/v3/auth/tokens {endpoint}信息请从地区和终端节点获取。 Body： { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "domain": { "name": "domainname" }, "password": "******" } } }, "scope": { "project": { "id": "0215ef11e49d4743be23dd97a1561e91" } } } } 响应Header中“X-Subject-Token”的值即为Token： X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX... 调用创建任务接口创建迁移任务。 接口相关信息 URI格式：POST /v2/{project_id}/tasks 详情请参见创建迁移任务。 请求示例 POST: https://{oms_endpoint}/v2/{project_id}/tasks {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: "Token" Body： { "src_node" : { "region" : "source_bucket_region", "ak" : "sorce_ak", "sk" : "sorce_sk", "bucket" : "source_bucket", "cloud_type" : "cloud_type", "object_key" : ["01.png", "list.txt"] }, "enable_kms" : false, "description" : "", "dst_node" : { "region" : "destination_bucket_region", "ak" : "destination_ak", "sk" : "destination_sk", "bucket" : "destination_bucket" }, "enable_failed_object_recording" : true, "enable_restore" : false, "task_type" : "object" } 响应示例 { "id" : 200477729979132, "task_name" : "task_name" } 调用查看任务接口，查看任务状态。 接口相关信息 URI格式： GET /v2/{project_id}/tasks/{task_id} 详情请参见查询指定ID的任务详情。 请求示例 GET: https://{oms_endpoint}/v2/{project_id}/tasks/{task_id} {endpoint}信息请从地区和终端节点获取。 Header： Content-Type: application/json X-Auth-Token: “Token” 响应示例 { "bandwidth_policy" : [], "complete_size" : 2223728, "description" : "", "dst_node" : { "bucket" : "api-test-outline", "region" : "cn-north-7" }, "enable_failed_object_recording" : true, "enable_kms" : false, "enable_restore" : false, "error_reason" : null, "failed_num" : 0, "failed_object_record" : { "result" : null, "list_file_key" : null, "error_code" : null }, "group_id" : "", "id" : 200477729979132, "is_query_over" : true, "left_time" : 0, "migrate_since" : 0, "migrate_speed" : 71477, "name" : "task_name", "progress" : 1.0, "real_size" : 2223728, "skipped_num" : 0, "src_node" : { "bucket" : "a-test-1", "cloud_type" : "HuaweiCloud", "region" : "cn-north-7", "app_id" : "", "object_key" : ["01.png", "list.txt"], "list_file" : null }, "start_time" : 1589267678170, "status" : 5, "successful_num" : 2, "task_type" : "object", "total_num" : 2, "total_size" : 2223728, "total_time" : 31111, "smn_info" : null, "source_cdn" : null } status表示任务执行状态，5代表成功。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK既可以使用永久访问密钥中的AK/SK，也可以使用临时访问密钥中的AK/SK，但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段，字段值为临时访问密钥的security_token。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“管理员创建IAM用户”API的resource-path为“/v3.0/OS-USER/users”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint（比如“华北-北京四”区域的Endpoint：“iam.cn-north-4.myhuaweicloud.com”“），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 Content-Type 消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization 签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参加AK/SK认证。 X-Sdk-Date 请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参加AK/SK认证。 X-Auth-Token 用户Token，可选，当使用Token方式认证时，必须填充该字段。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID 子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID 账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。 对于管理员创建IAM用户接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 3 4 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

API概览 对象存储迁移 服务提供了版本查询接口和任务管理接口，如表1所示。 表1 对象存储迁移服务接口列表 类型 说明 获取项目ID和任务ID 查询用户的项目ID和任务ID。 查询API版本信息列表 查询对象存储迁移服务的API版本信息。 查询指定API版本信息 查询对象存储迁移服务指定API版本信息。 查询迁移任务列表 查询用户账户下的所有任务信息。 查询指定ID的任务详情 查询指定ID的任务详情。 创建迁移任务 创建迁移任务。 启动迁移任务 迁移任务暂停或失败后，调用该接口以启动任务。 暂停迁移任务 当任务正在运行中时，调用该接口停止任务。 删除迁移任务 根据迁移任务ID，删除迁移任务。 更新任务带宽策略 当迁移任务未执行完成时，修改迁移任务的流量控制策略。 批量更新任务 批量更新迁移任务，可指定单个迁移任务组下所有的迁移任务或通过迁移任务ID来执行。 创建同步事件 源端有对象需要进行同步时，调用该接口创建一个同步事件，系统将根据同步事件中包含的对象名称进行同步(目前只支持华北-北京四、华东-上海一地区)。 查询同步任务列表 查询用户名下所有同步任务信息。 创建同步任务 创建同步任务，创建成功后，任务会被自动启动，不需要额外调用启动任务命令。 查询指定ID的同步任务详情 查询指定ID的同步任务详情。 查询指定ID的同步任务统计数据 查询指定ID同步任务的接收同步请求对象数、同步成功对象数、同步失败对象数、同步跳过对象数、同步成功对象容量统计数据(目前只支持华北-北京四、华东-上海一地区)。 删除同步任务 调用该接口删除同步任务。 暂停同步任务 当同步任务处于同步中时，调用该接口停止任务(目前只支持华北-北京四、华东-上海一地区)。 启动同步任务 同步任务停止后，调用该接口以启动同步任务(目前只支持华北-北京四、华东-上海一地区)。 查询迁移任务组列表 查询用户账户下的任务组信息。 创建迁移任务组 创建迁移任务组，创建成功后，迁移任务组会自动创建迁移任务，不需要额外调用启动任务命令。 获取指定id的taskgroup信息 获取指定id的taskgroup信息。 删除指定id的迁移任务组 删除指定的迁移任务组。 暂停指定id的迁移任务组 当迁移任务组处于创建任务中或监控中时，调用该接口暂停指定迁移任务组。 恢复指定id的迁移任务组 当迁移任务组处于暂停状态时，调用该接口启动指定id的迁移任务组。 对已经失败的指定id迁移任务组进行重启 当迁移任务组处于迁移失败状态时，调用该接口重启指定id的迁移任务组。 更新指定id的迁移任务组的流控策略 当迁移任务组未执行完成时，修改迁移任务组的流量控制策略。 查询桶对象列表 查询桶对象列表。 查桶对应的CDN信息 查桶对应的CDN信息。 查询桶列表 查询桶列表。 查询桶对应的region 查询桶对应的region。 检查前缀是否在源端桶中存在 检查前缀是否在源端桶中存在。 查询所有支持的云厂商 查询所有支持的云厂商。 查询云厂商支持的reigon 查询云厂商支持的reigon。

请求示例 将task_id为xxxxxxxx的任务限速策略更新为00:01-23:59，限速值设置为50MB/s。 PUT /v2/{project_id}/taskgroup/xxxxxxxx/update { "bandwidth_policy" : [ { "start" : "00:01", "end" : "23:59", "max_bandwidth" : 50000000 } ] }

请求示例 将task_id为xxxxxxxx的任务的限速时段设置为00:01-23:59，限速值设置为50MB/s。 /v2/{project_id}/tasks/xxxxxxxx/bandwidth-policy { "bandwidth_policy" : [ { "start" : "00:01", "end" : "23:59", "max_bandwidth" : 50000000 } ] }

请求示例 输入源端、目的端的AK/SK，重试任务ID为2c11d99a-9596-4bc6-a6ad-2336455b149c的迁移任务组。 PUT https://{endpoint}/v2/{project_id}/taskgroups/00878453-3402-4a86-9e2a-5d5217cd35b2/start { "src_ak" : "src_AK", "src_sk" : "src_SK", "dst_ak" : "dst_AK", "dst_sk" : "dst_AK" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 src_ak 否 String 源端节点AK（最大长度100个字符）。URL列表迁移任务不需要填写此参数。 最小长度：1 最大长度：100 src_sk 否 String 源端节点SK（最大长度100个字符）。URL列表迁移任务不需要填写此参数。 最小长度：1 最大长度：100 json_auth_file 否 String 用于谷歌云Cloud Storage鉴权 最小长度：0 最大长度：65535 dst_ak 是 String 目的端节点AK（最大长度100个字符）。 最小长度：1 最大长度：100 dst_sk 是 String 目的端节点SK（最大长度100个字符）。 最小长度：1 最大长度：100 source_cdn_authentication_key 否 String CDN鉴权秘钥。 最小长度：0 最大长度：255

请求示例 输入源端、目的端的AK/SK，启动已经暂停的非URL列表迁移任务。 POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/start { "src_ak" : "src_ak", "src_sk" : "src_sk", "dst_ak" : "dst_ak", "dst_sk" : "dst_sk", "migrate_failed_object" : false } 输入目的端桶的AK/SK，启动已暂停的URL列表迁移任务。 POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/start { "dst_ak" : "dst_ak", "dst_sk" : "dst_sk", "migrate_failed_object" : false }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 src_ak 否 String 源端节点AK（最大长度100个字符）。URL列表迁移任务不需要填写此参数。 最小长度：1 最大长度：100 src_sk 否 String 源端节点SK（最大长度100个字符）。URL列表迁移任务不需要填写此参数。 最小长度：1 最大长度：100 json_auth_file 否 String 用于谷歌云Cloud Storage鉴权 最小长度：0 最大长度：65535 src_security_token 否 String 源端节点临时Token 最小长度：0 最大长度：16384 dst_ak 是 String 目的端节点AK（最大长度100个字符）。 最小长度：1 最大长度：100 dst_sk 是 String 目的端节点SK（最大长度100个字符）。 最小长度：1 最大长度：100 dst_security_token 否 String 目标端节点临时Token 最小长度：0 最大长度：16384 source_cdn_authentication_key 否 String CDN鉴权秘钥。 最小长度：0 最大长度：255 migrate_failed_object 否 Boolean 迁移类型，标识是否为全量迁移，默认false（全量迁移）。 值为true时表示只重传失败对象。 值为空或者为false时表示全量迁移。 缺省值：false

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM鉴权Token。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 src_ak 是 String 源端节点AK（最大长度100个字符）。URL列表迁移任务不需要填写此参数。 最小长度：1 最大长度：100 src_sk 是 String 源端节点SK（最大长度100个字符）。URL列表迁移任务不需要填写此参数。 最小长度：1 最大长度：100 dst_ak 是 String 目的端节点AK（最大长度100个字符）。 最小长度：1 最大长度：100 dst_sk 是 String 目的端节点SK（最大长度100个字符）。 最小长度：1 最大长度：100 source_cdn_authentication_key 否 String CDN鉴权秘钥。 最小长度：0 最大长度：255

响应示例 状态码：200 OK { "group_id" : "9522a7e5-b4fc-44b9-93e1-4dbadbd86e67", "status" : 3, "error_reason" : null, "src_node" : { "bucket" : "dst-test-001", "cloud_type" : "HUAWEICLOUD", "region" : "cn-north-7", "app_id" : "", "object_key" : [ "" ], "list_file" : null }, "description" : "", "dst_node" : { "bucket" : "assess-bucket-1", "region" : "cn-north-7", "save_prefix" : "" }, "enable_metadata_migration" : false, "enable_failed_object_recording" : true, "enable_restore" : false, "enable_kms" : false, "task_type" : "PREFIX", "bandwidth_policy" : [ ], "smn_config" : null, "source_cdn" : null, "migrate_since" : 0, "migrate_speed" : 0, "total_time" : 7907369, "start_time" : 1659937788779, "total_task_num" : null, "create_task_num" : null, "failed_task_num" : null, "complete_task_num" : null, "paused_task_num" : null, "executing_task_num" : null, "waiting_task_num" : null, "total_num" : 4128588, "create_complete_num" : null, "success_num" : 0, "fail_num" : 0, "skip_num" : 0, "total_size" : 27814708666, "create_complete_size" : null, "complete_size" : 0, "failed_object_record" : { "result" : null, "list_file_key" : null, "error_code" : null }, "object_overwrite_mode" : "SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE", "consistency_check" : "size_last_modified", "enable_requester_pays" : false }

响应示例 状态码：200 OK { "bandwidth_policy" : [ { "end" : "23:59", "max_bandwidth" : 0, "start" : "00:00" } ], "complete_size" : 0, "description" : "test log", "dst_node" : { "bucket" : "dst_bucket", "region" : "cn-north-1" }, "enable_failed_object_recording" : true, "enable_kms" : true, "enable_restore" : false, "error_reason" : { "error_code" : "string", "error_msg" : "string" }, "failed_num" : 0, "failed_object_record" : { "result" : true, "list_file_key" : "string", "error_code" : "string" }, "group_id" : "string", "id" : 0, "is_query_over" : true, "left_time" : 0, "migrate_since" : 0, "migrate_speed" : 0, "name" : "string", "progress" : 0, "real_size" : 0, "skipped_num" : 0, "src_node" : { "bucket" : "src_bucket", "cloud_type" : "AWS", "region" : "cn-north-1", "app_id" : "string", "object_key" : [ "string", "string" ], "list_file" : { "list_file_key" : "object_list_file.txt", "obs_bucket" : "obs_bucket" } }, "start_time" : 0, "status" : 0, "successful_num" : 0, "task_type" : "list", "total_num" : 0, "total_size" : 0, "total_time" : 0, "smn_info" : { "notify_result" : true, "notify_error_message" : "string", "topic_name" : "string" }, "source_cdn" : { "domain" : "xxx.xxx.xxx", "protocol" : "http", "authentication_type" : "string" } }

URI GET /v2/{project_id}/sync-tasks/{sync_task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：1 最大长度：1024 sync_task_id 是 String 同步任务ID。 最小长度：0 最大长度：255 表2 Query参数 参数 是否必选 参数类型 描述 query_time 是 String 查询同步任务详情的时间（毫秒），依据该值返回所在月份的统计数据。 最小长度：1 最大长度：1024

响应示例 状态码：200 OK { "sync_task_id" : "d18befdd-eb82-41f3-8019-bbb593d74a3e", "src_cloud_type" : "HuaweiCloud", "src_region" : "cn-north-7", "src_bucket" : "oms-sdk-test-src", "create_time" : 1700639560751, "last_start_time" : 1700639560751, "dst_bucket" : "oms-sdk-test-dst", "dst_region" : "cn-north-7", "description" : "sync task test", "status" : "SYNCHRONIZING", "enable_kms" : false, "enable_metadata_migration" : false, "enable_restore" : false, "app_id" : null, "monthly_acceptance_request" : 11, "monthly_success_object" : 0, "monthly_failure_object" : 11, "monthly_skip_object" : 0, "monthly_size" : 0, "object_overwrite_mode" : "SIZE_LAST_MODIFIED_COMPARISON_OVERWRITE", "dst_storage_policy" : null, "consistency_check" : "size_last_modified" }

响应示例 状态码：200 查询Region信息响应体 [ { "service_name" : "AWS", "region_list" : [ { "cloud_type" : "AWS", "value" : "us-east-1", "description" : "US Standard (N. Virginia)" }, { "cloud_type" : "AWS", "value" : "us-west-1", "description" : "US West (N. California)" }, { "cloud_type" : "AWS", "value" : "us-west-2", "description" : "US West (Oregon)" }, { "cloud_type" : "AWS", "value" : "eu-west-1", "description" : "EU (Ireland)" }, { "cloud_type" : "AWS", "value" : "eu-central-1", "description" : "EU (Frankfurt)" }, { "cloud_type" : "AWS", "value" : "ap-northeast-1", "description" : "Asia Pacific (Tokyo)" }, { "cloud_type" : "AWS", "value" : "ap-northeast-2", "description" : "Asia Pacific (Seoul)" }, { "cloud_type" : "AWS", "value" : "ap-southeast-1", "description" : "Asia Pacific (Singapore)" }, { "cloud_type" : "AWS", "value" : "ap-southeast-2", "description" : "Asia Pacific (Sydney)" }, { "cloud_type" : "AWS", "value" : "ap-south-1", "description" : "Asia Pacific (Mumbai)" }, { "cloud_type" : "AWS", "value" : "sa-east-1", "description" : "South America (Sao Paulo)" }, { "cloud_type" : "AWS", "value" : "us-east-2", "description" : "US East (Ohio)" }, { "cloud_type" : "AWS", "value" : "eu-west-2", "description" : "EU (London)" }, { "cloud_type" : "AWS", "value" : "ca-central-1", "description" : "Canada (Central)" }, { "cloud_type" : "AWS", "value" : "ap-east-1", "description" : "Asia Pacific (Hong Kong)" } ] } ]

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of ShowRegionInfoResp objects 查询Region信息响应体 表4 ShowRegionInfoResp 参数 参数类型 描述 service_name String 服务名称 最小长度：0 最大长度：255 region_list Array of RegionInfo objects Region列表 数组长度：0 - 1024 表5 RegionInfo 参数 参数类型 描述 cloud_type String 云服务名称 最小长度：1 最大长度：255 value String region名称 最小长度：1 最大长度：255 description String region的描述信息 最小长度：0 最大长度：1024

响应示例 状态码：200 查询CDN信息响应体 { "is_same_cloud_type" : false, "is_download_available" : false, "checked_keys" : [ { "key" : "xxx", "is_etag_matching" : false, "is_object_existing" : false }, { "key" : "yyy", "is_etag_matching" : false, "is_object_existing" : false }, { "key" : "ccc", "is_etag_matching" : false, "is_object_existing" : false }, { "key" : "bbb", "is_etag_matching" : false, "is_object_existing" : false }, { "key" : "nnnn", "is_etag_matching" : false, "is_object_existing" : false } ] }

请求示例 用ALIYUN_OSS_B加密方式xcsad秘钥查询xxx桶的CDN信息 POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/cdn-info { "ak" : "xxx", "sk" : "xxx", "cloud_type" : "Aliyun", "region" : "cn-hangzhou", "bucket" : "xxx", "source_cdn" : { "protocol" : "https", "domain" : "xxx", "authentication_type" : "ALIYUN_OSS_B", "authentication_key" : "xcsad" } }

响应参数 状态码：200 表6 响应Body参数 参数 参数类型 描述 is_same_cloud_type Boolean 是否相同云类型 is_download_available Boolean 是否下载可用 checked_keys Array of CheckedKey objects 返回的已检查的对象数组 数组长度：0 - 1000 表7 CheckedKey 参数 参数类型 描述 key String 键 最小长度：0 最大长度：2048 is_etag_matching Boolean 是否电子标签匹配 is_object_existing Boolean 是否存在对象 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 error_code String 错误码。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token认证，需要确认Token中包含的Project ID与请求URI中修改资源的Project ID匹配。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 ak 是 String 源端桶的AK（最大长度100个字符），task_type为非url_list时，本参数为必选。 最小长度：0 最大长度：100 sk 是 String 源端桶的SK（最大长度100个字符），task_type为非url_list时，本参数为必选。 最小长度：0 最大长度：100 cloud_type 是 String 云类型 AWS：亚马逊 Aliyun：阿里云 Qiniu：七牛云 QingCloud：青云 Tencent：腾讯云 Baidu：百度云 KingsoftCloud：金山云 Azure：微软云 UCloud：优刻得 HuaweiCloud：华为云 URLSource：URL HEC：HEC 最小长度：0 最大长度：100 region 是 String 区域 最小长度：0 最大长度：100 app_id 否 String 当源端为腾讯云时，会返回此参数。 最小长度：0 最大长度：255 bucket 是 String 桶名 最小长度：0 最大长度：100 prefix 否 PrefixKeyInfo object 前缀 source_cdn 是 SourceCdnReq object 指定是否启用CDN迁移支持，若包含此字段则为支持，否则为不支持，启用CDN迁移支持后，迁移时将从CDN域名获取源端对象。 表4 PrefixKeyInfo 参数 是否必选 参数类型 描述 keys 是 Array of strings 键 最小长度：0 最大长度：2048 数组长度：0 - 100 表5 SourceCdnReq 参数 是否必选 参数类型 描述 authentication_key 否 String CDN鉴权秘钥，如果CDN需要进行鉴权，则此选项为必选。 无需授权：无需配置此项。 Qiniu：无需配置此项。 Aliyun：根据authentication_type指定的鉴权方式配置此项。 KingsoftCloud：无需配置此项。 最小长度：0 最大长度：255 authentication_type 是 String 鉴权类型: NONE, QINIU_PRIVATE_AUTHENTICATION, ALIYUN_OSS_A, ALIYUN_OSS_B, ALIYUN_OSS_C, KSYUN_PRIVATE_AUTHENTICATION, AZURE_SAS_TOKEN,TENCENT_COS_A,TENCENT_COS_B,TENCENT_COS_C,TENCENT_COS_D 缺省值：NONE 枚举值： NONE QINIU_PRIVATE_AUTHENTICATION ALIYUN_OSS_A ALIYUN_OSS_B ALIYUN_OSS_C KSYUN_PRIVATE_AUTHENTICATION AZURE_SAS_TOKEN TENCENT_COS_A TENCENT_COS_B TENCENT_COS_C TENCENT_COS_D domain 是 String 从指定域名获取对象。 最小长度：0 最大长度：1024 protocol 是 String 协议类型，支持http和https协议。 枚举值： http https

请求示例 查询桶对应的region POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/regions { "cloud_type" : "HuaweiCloud", "ak" : "xxxxak", "sk" : "xxxxsk", "app_id" : "apptest123", "bucket_name" : "xxx" }