文档首页/ 云手机服务器 CPH/ API参考/ 云手机服务器API/ 编码服务管理/ 查询编码服务 - ListEncodeServers
更新时间：2025-10-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询编码服务 - ListEncodeServers

功能介绍

查询编码服务列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/cloud-phone/encode-servers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。
表2 Query参数

参数

是否必选

参数类型

描述

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

云手机服务器的唯一标识。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

encode_servers

Array of EncodeServer objects

编码服务信息。
表5 EncodeServer

参数

参数类型

描述

encode_server_name

String

编码服务的名称，不大于64个字节。

encode_server_id

String

编码服务的唯一标识ID，不大于32个字节。

encode_server_ip

String

编码服务IP地址。

server_id

String

云手机服务器ID，不大于32个字节。

keypair_name

String

编码服务登录密钥名称。

type

Integer

编码服务类型。

  • 0：服务器

  • 1：容器

status

Integer

编码服务状态。

  • 1：运行中

  • 2：异常

  • 3：重启中

  • 0、4、5：创建中

access_infos

Array of EncodeServerAccessInfo objects

编码服务的访问信息。

encode_server_ipv6

String

编码服务IPv6地址。
表6 EncodeServerAccessInfo

参数

参数类型

描述

listen_port

Integer

编码服务监听端口。

access_ip

String

编码服务访问的公网IP（过期）。

intranet_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网页接入端口

  • 其他值：用户自定义端口

server_ipv6

String

编码服务访问的内网IPv6 IP（新增）。

请求示例

查询服务器id上的编码容器

GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/encode-servers?server_id=9a8870d670584f929978b15c80009e99

响应示例

状态码：200

OK

{
  "encode_servers" : [ {
    "encode_server_name" : "ENCODE_SERVER_2",
    "encode_server_id" : "00b00d1b35094f13b360cdfe15a9bfee",
    "encode_server_ip" : "10.237.0.233",
    "encode_server_ipv6" : "fd00::aed:e9",
    "server_id" : "26fef5ef8f484e5fbd3d3974134b8091",
    "keypair_name" : "keyPair2",
    "type" : 0,
    "status" : 1,
    "access_infos" : [ {
      "listen_port" : 6902,
      "intranet_ip" : "172.31.240.115",
      "access_port" : 6902,
      "access_ip" : "10.154.119.231",
      "server_ip" : "172.31.240.115",
      "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d",
      "public_ip" : "10.154.119.231",
      "type" : "port1"
    }, {
      "listen_port" : 6903,
      "intranet_ip" : "172.31.240.115",
      "access_port" : 6903,
      "access_ip" : "172.31.240.115",
      "server_ip" : "172.31.240.115",
      "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d",
      "public_ip" : "",
      "type" : "port2"
    }, {
      "listen_port" : 6900,
      "intranet_ip" : "172.31.240.115",
      "access_port" : 6900,
      "access_ip" : "172.31.240.115",
      "server_ip" : "172.31.240.115",
      "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d",
      "public_ip" : "",
      "type" : "port3"
    }, {
      "listen_port" : 6901,
      "intranet_ip" : "172.31.240.115",
      "server_ipv6" : "2001:db8:a583:b62:e5ea:4a6b:de7b:f97d",
      "access_port" : 6901,
      "access_ip" : "100.68.0.235",
      "server_ip" : "172.31.240.115",
      "public_ip" : "100.68.0.235",
      "type" : "port4"
    } ]
  } ],
  "request_id" : "4faba0b7f7cb4e829b18773718289b99"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 编码服务管理