更新时间:2022-03-31 GMT+08:00
分享

快速入门

本节通过调用一系列云手机服务的API管理云手机。

通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。

涉及API

当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。

  • IAM获取token的API
  • 查询云手机列表的API
  • 重启云手机的API
  • 查询任务列表的API

具体步骤

  1. Token认证,具体操作请参考认证鉴权
  2. 查询云手机列表。发送“GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones?offset=0&limit=100”。
    1. 在Request Header中增加“X-Auth-Token”。

      请求响应成功后,返回request_id和phones。

      若请求失败,则会返回错误码及对应的错误描述信息,详细错误码请参考错误码

  3. 重启云手机。发送“POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-restart”。
    1. 在Request Header中增加“X-Auth-Token”。
    2. 在Request Body中传入参数如下:
      {
          "phones": [
              {
                  "phone_id": "a7f3a1c5258347d6b6f1def79e11f2bc"
              }
          ]
      }

      请求响应成功后,返回request_id和 jobs。

      若请求失败,则会返回错误码及对应的错误描述信息,详细错误码请参考错误码

  1. 查询任务列表。发送“GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/jobs?request_id={request_id}”。
    1. 在Request Header中增加“X-Auth-Token”。

      请求响应成功后,返回request_id和jobs状态列表。

      {
          "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",
          "jobs": [
              {
                  "phone_id": "1234567b8bab40ffb711234cb80d0234",
                  "server_id": "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
                  "node_id": "1e223c8e-3ad0-4bf0-a837-bc90d4f91d01",
                  "job_id": "1564567b8bab40f34711234cb80d0123",
                  "begin_time": "2017-10-25T00:00:00Z",
                  "end_time": "2017-12-26T00:00:00Z",
                  "status": 2,
                  "error_code": "", 
                  "error_msg": "" 
              },
              ……
          ]
      }

      若请求失败,则会返回错误码及对应的错误描述信息,详细错误码请参考错误码

分享:

    相关文档

    相关产品

close