Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Encoding Services

Updated on 2024-08-09 GMT+08:00

Function

This API is used to query encoding services.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

If the offset is 0 (default value) or an integer greater than 0, all resources after the offset will be queried.

limit

No

Integer

Specifies the number of resources returned on each page. The value ranges from 1 to 100 (default). Generally, this parameter is set to 10, 20, or 50.

type

No

Integer

Encoding service type.

  • 0: server

  • 1: container

status

No

Integer

Status list.

  • 1: running

  • 2: abnormal

  • 3: restarting

  • 4: frozen

  • 5: powered off

  • 100, 1014, 0: being created

server_id

No

String

Specifies the unique identifier of the cloud phone server.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique request ID.

encode_servers

Array of EncodeServer objects

Specifies the information about the encoding service.

Table 5 EncodeServer

Parameter

Type

Description

encode_server_name

String

Specifies the name of the encoding service. The name can contain a maximum of 64 bytes.

encode_server_id

String

Specifies the unique ID of the encoding service. The ID can contain a maximum of 32 bytes.

encode_server_ip

String

Specifies the IP address of the encoding service.

server_id

String

Specifies the cloud phone server ID, which can contain a maximum of 32 bytes.

keypair_name

String

Specifies the key pair for logging in to the encoding service.

type

Integer

Encoding service type.

  • 0: server

  • 1: container

status

Integer

Encoding service status.

  • 1: running

  • 2: abnormal

  • 3: restarting

  • 0, 4, 5: being created

access_infos

Array of EncodeServerAccessInfo objects

Specifies the access information about the encoding service.

encode_server_ipv6

String

Specifies the IPv6 address of the encoding service.

Table 6 EncodeServerAccessInfo

Parameter

Type

Description

listen_port

Integer

Specifies the listening port of the encoding service.

access_ip

String

(Expired) Specifies the public IP address of the encoding service.

intranet_ip

String

(Expired) Specifies the private IP address of the encoding service.

public_ip

String

(New) Specifies the public IP address for accessing the encoding service.

server_ip

String

(New) Specifies the private IP address for accessing the encoding service.

access_port

Integer

Specifies the port of the encoding service accessed by the public network.

type

String

Specifies the port type of the encoding service. The value can be one of the following:

  • adb: ADB ports of the cloud phone

  • vnc: VNC ports of the cloud phone

  • cph_app_server: access ports of the cloud gaming client

  • cph_h5_server: H5 web page access ports of cloud gaming

  • Others: user-defined ports

server_ipv6

String

(New) Specifies the private IPv6 address for accessing the encoding service.

Example Requests

Querying the encoding container by server ID

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

Example Responses

Status code: 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"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback