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

关闭云手机

功能介绍

  • 接口名称

    PowerOffCloudPhone

  • 功能描述

    批量关闭云手机。

URI

POST /v1/{project_id}/cloud-phone/phones/batch-stop

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

请求消息

  • 请求参数

    参数

    是否必选

    参数类型

    描述

    phone_ids

    Array of strings

    云手机的唯一标识,可通过查询云手机列表获取。

  • 请求样例
    POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/batch-stop
    {
        "phone_ids": [
            "1234567b8bab40ffb711234cb80d0234",
            "1678567b8bab40f93711234cb80d0764"
        ]
    }

响应消息

  • 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求的唯一标识ID

    jobs

    job结构体数组

    任务信息,详情请参见表2

    表2 job数据结构说明

    参数

    参数类型

    描述

    phone_id

    String

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

    job_id

    String

    任务的唯一标识

    error_code

    String

    错误码,详情请参见错误码

    error_msg

    String

    错误说明

  • 响应样例
    {
        "request_id": "6837531fd3f54550927b930180a706bf",
        "jobs": [{
            "phone_id": "1234567b8bab40ffb711234cb80d0234",
            "job_id": "1564567b8bab40f34711234cb80d0123"
        },
        {
            "phone_id":  "1678567b8bab40f93711234cb80d0764",
            "job_id":  "1564567b8bab40f34711234cb80d5678"
        }]
    }

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

close