更新时间:2024-11-27 GMT+08:00
分享

推送共享存储文件

功能介绍

推送文件至共享存储目录中,该功能仅在支持共享存储的云手机规格上可实现。接口调用前请先确保已完成CPH服务操作OBS桶的委托授权。委托CPH操作OBS桶请参见委托CPH操作OBS桶

调试

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

URI

POST /v1/{project_id}/cloud-phone/phones/share-files

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

bucket_name

String

合法的OBS桶名,3-63个字符,只能由小写字母、数字、中划线(-)和小数点组成。仅推送共享存储接口使用。

object_path

String

合法的OBS对象路径,最大长度1024字符。仅支持大小写字母、数字、小数点(.)、斜线(/)、中划线(-)、下划线(_)、加号(+)、井号(#)、等号等这些字符。推送的文件只支持tar文件类型。推送时,按tar文件解压后的文件目录结构推送到手机。当前只支持/data和/cache目录推送。仅推送共享存储接口使用。

server_ids

Array of strings

云手机服务器ID列表。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

jobs

Array of ServerJob objects

任务列表。

表5 ServerJob

参数

参数类型

描述

server_id

String

云手机服务器的唯一标识ID,云手机服务器相关任务包含此字段。

job_id

String

任务的唯一标识。

error_code

String

错误码。

error_msg

String

错误说明。

请求示例

将共享存储文件推送到服务器列表中的服务器上,文件来自于obs桶

POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/share-files

{
  "bucket_name" : "bucketA",
  "object_path" : "my_apps/test.tar",
  "server_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}

响应示例

状态码: 200

OK

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "server_id" : "1234567b8bab40ffb711234cb80d0234",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  }, {
    "server_id" : "1678567b8bab40f93711234cb80d0764",
    "job_id" : "1564567b8bab40f34711234cb80d5678"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档