功能介绍

• 接口名称

  ListEncodeServers

• 功能描述

  查询编码服务列表。

URI

GET /v1/{project_id}/cloud-phone/encode-servers?offset={offset}&limit={limit}&type={type}&status={status}&server_id={server_id}

请求消息

• 请求参数

  无

• 请求样例

  1	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	编码服务信息，详情请参见表2。

  表2 encode_server数据结构说明

  参数	参数类型	描述
  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 objects	编码服务的访问信息，详情请参见表3。

  表3 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,
              "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",
                      "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",
                      "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",
                      "public_ip": "",
                      "type": "port3"
                  },
                      "listen_port": 6901,
                      "intranet_ip": "172.31.240.115",
                      "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"
  }

返回值

请参考返回值。

错误码

请参考错误码。