] }
返回值
请参考返回值。
错误码
请参考错误码。
5.6 编码服务管理
5.6.1 查询编码服务
功能介绍
● 接口名称
ListEncodeServers
● 功能描述
查询编码服务列表。
URI
GET /v1/{project_id}/cloud-phone/encode-servers?
offset={offset}&limit={limit}&type={type}&status={status}&server_id={server_id}
参数说明请参见表5-59。
表5-59 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
获取方式请参见获取项目ID。
offset 否 Integer 偏移量
偏移量为一个大于0小于资源总个 数的整数，表示查询该偏移量后 面的所有的资源数，默认值为0。
limit 否 Integer 每页返回的资源个数
取值范围：1~100（默认值为 100）
一般设置为10、20、50
参数 是否必选 参数类型 描述
type 否 Integer 编码服务类型
● 0：服务器
● 1：容器
status 否 Integer 状态列表
● 1：运行中
● 2：异常
● 3：重启中
● 4：冻结
● 5：关机
● 100、1014、0：创建中 server_id 否 String 云手机服务器ID
请求消息
● 请求参数 无
● 请求样例
GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/encode-servers?
offset=0&limit=100&type=0&status=0
响应消息
● 响应参数
参数 参数类型 描述
request_id String 请求的唯一标识ID
encode_servers Array of objects 编码服务信息，详情请参见表5-60。
表5-60 encode_server 数据结构说明
参数 参数类型 描述
encode_server_na
me String 编码服务的名称，不大于64个字节
encode_server_id String 编码服务的唯一标识ID，不大于32个 字节
encode_server_ip String 编码服务IP地址
server_id String 云手机服务器ID，不大于32个字节
参数 参数类型 描述
type Integer 编码服务类型
● 0：服务器
● 1：容器
status Integer 编码服务状态
● 1：运行中
● 2：异常
● 3：重启中
● 0、4、5：创建中
access_infos Array of objects 编码服务的访问信息，详情请参见表 5-61。
表5-61 access_info 数据结构说明
参数 参数类型 描述
listen_port Integer 编码服务监听端口 access_ip（过
期） String 编码服务访问的公网IP
internet_ip（过
期） String 编码服务访问的内网IP
public_ip（新增） String 编码服务访问的公网IP server_ip（新增） String 编码服务访问的内网IP access_port Integer 编码服务公网的访问端口
type String 编码服务的端口类型，取值如下：
● adb：云手机的ADB端口
● vnc：云手机的VNC端口
● cph_app_server：云游戏客户端接 入端口
● cph_h5_server：云游戏H5 web网 页接入端口
● 其他值：用户自定义端口
● 响应样例
{ "encode_servers": [{
"encode_server_name": "ENCODE_SERVER_2",
"encode_server_id": "00b00d1b35094f13b360cdfe15a9bfee", "encode_server_ip": "10.237.0.233",
"server_id": "26fef5ef8f484e5fbd3d3974134b8091", "keypair_name": "keyPair2",
"type": 0,
"status": 1,
"request_id": "4faba0b7f7cb4e829b18773718289b99"
}
URI
POST /v1/{project_id}/cloud-phone/encode-servers/batch-restart 参数说明请参见表5-62。
表5-62 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID
获取方式请参见获取项目ID。
请求消息
● 请求参数
参数 是否必选 参数类型 描述
encode_server_
ids 是 Array of
strings 待重启的编码服务的ID
● 请求样例
POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/encode-servers/batch-restart { "encode_server_ids": [
"d5cfa92995da40168c39b38d2aa478b3", "00b00d1b35094f13b360cdfe15a9bfee"
] }
响应消息
● 响应参数
参数 参数类型 描述
request_id String 请求的唯一标识ID。
jobs Array of objects 任务信息，详情请参见表5-63。
表5-63 job 数据结构说明
参数 参数类型 描述
encode_server_i
d String 编码服务的唯一标识ID，编码服务相关
任务包含此字段。
job_id String 任务的唯一标识
● 响应样例
{ "jobs":
[ {
"job_id": "e9d7b1a2572c4f2c9bf056a3d1b35e39",
"encode_server_id": "d5cfa92995da40168c39b38d2aa478b3"
}, {
"job_id": "4d0a42447cac4c9697b97f07934b74bd",
"encode_server_id": "00b00d1b35094f13b360cdfe15a9bfee"
} ],
"request_id": "c775bdf09bc0400a9138199b346cab62"
}
返回值
请参考返回值。
错误码
请参考错误码。