Pushing Shared Storage Files

Function

This API is used to push files to the shared storage space. This function is available only on cloud phones that support storage sharing. Before calling this API, ensure that the CPH service has been authorized to operate OBS buckets. For details, see Delegating CPH to Operate OBS Buckets.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
bucket_name	Yes	String	Specifies the valid name of an OBS bucket, which can contain 3 to 63 characters, including only lowercase letters, digits, hyphens (-), and periods (.). This parameter is only used by the API for pushing shared storage.
object_path	Yes	String	Valid OBS object path. The maximum length is 1024 characters. The value can contain only uppercase letters, lowercase letters, digits, dots (.), slashes (/), hyphens (-), underscores (_), plus signs (+), number signs (#), and equal signs (=). Only .tar files can be pushed. The file is pushed to the cloud phone based on the directory structure of the decompressed .tar file. Currently, only the /data and /cache directories can be pushed. This parameter is used only by the interface for pushing shared storage.
server_ids	Yes	Array of strings	Specifies the ID list of cloud phone servers.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique request ID.
jobs	Array of ServerJob objects	Specifies the task list.

**Table 5** ServerJob
Parameter	Type	Description
server_id	String	Specifies the unique ID of a cloud phone server. This parameter is contained in tasks related to cloud phone servers.
job_id	String	Specifies the unique ID of a task.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Pushing shared storage files from the same OBS bucket to cloud servers listed in server_ids

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" ]
}

Example Responses

Status code: 200

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