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
Help Center/ Cloud Phone Host/ API Reference/ Cloud Phone Server APIs/ Cloud Phone Servers/ Querying the Details of a Cloud Phone Server

Querying the Details of a Cloud Phone Server

Updated on 2025-01-16 GMT+08:00

Function

This API is used to query the details of a cloud phone server based on the server ID.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

server_id

Yes

String

Specifies the unique identifier of the cloud phone server.

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique request ID.

server_name

String

Cloud Phone Server Name, The value can contain a maximum of 65 characters, including only letters, digits, underscores (_), and hyphens (-).

availability_zone

String

Specifies the AZ where the cloud phone server is deployed. For example, the name for AZ 1 in the CN East-Shanghai1 region is cn-east-3a.

server_id

String

Specifies the unique identifier of the cloud phone server. The identifier can contain a maximum of 32 bytes.

server_model_name

String

Specifies the flavor of the cloud phone server. The flavor can contain a maximum of 64 bytes.

phone_model_name

String

Specifies the cloud phone flavor. The value can contain a maximum of 64 bytes.

keypair_name

String

Specifies the name of the key pair used to connect to a cloud phone. The name can contain a maximum of 64 bytes.

status

Integer

Specifies the Server status.

  • 0, 1, 3, 4: creating

  • 2: abnormal

  • 5: normal

  • 8: frozen

  • 10: powered off

  • 11: powering off

  • 12: Failed to shut down the VM.

  • 13: being started

vpc_id

String

Specifies the ID of the VPC to which the cloud phone server belongs. If network_version is set to v1, this parameter indicates the VPC ID of the resource tenant to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the VPC ID specified by the tenant during server creation.

cidr

String

Specifies the network segment of the VPC to which the cloud phone server belongs. If network_version is set to v1, this parameter indicates the VPC CIDR of the resource tenant to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the VPC CIDR of the VPC specified by the tenant during server creation.

vpc_cidr

String

Specifies the network segment of the VPC to which the cloud phone server belongs. If network_version is set to v1, this parameter indicates the VPC CIDR of the resource tenant to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the VPC CIDR of the VPC specified by the tenant during server creation.

subnet_id

String

Specifies the ID of the subnet to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the subnet ID specified when a tenant creates a server. If network_version is set to v1, this parameter indicates the subnet ID of the resource tenant to which the cloud phone server belongs.

subnet_cidr

String

Specifies the network segment of the subnet to which the cloud phone server belongs. If network_version is set to v2, this parameter indicates the CIDR of the subnet specified when a tenant creates a server. If network_version is set to v1, this parameter indicates the CIDR of the subnet of the resource tenant to which the cloud phone server belongs.

resource_project_id

String

Specifies the project ID of the cloud phone server.

metadata

metadata object

Specifies the order and product information.

addresses

Array of Address objects

Specifies the IP address of the cloud phone server.

band_widths

Array of Bandwidth objects

Specifies the structure array of the cloud phone server bandwidth information.

volumes

Array of Volume objects

Specifies the structure array of the cloud phone server volume information.

share_volume_info

share_volume_info object

Information about the shared storage of the cloud phone server.

network_version

String

Specifies whether the cloud phone server is a user-defined network. v1: cloud phone server on a non-user-defined network. v2: cloud phone server on a user-defined network. Data can be filtered by network version.

enterprise_project_id

String

Specifies the ID of the enterprise project to which the cloud phone server belongs.

security_groups

Array of strings

Specifies the security group bound to the extension NIC of the server. Indicates the server of the system-defined network. An empty list is returned for this field.

create_time

String

Creation Time, The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

Update Time, The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

Table 4 metadata

Parameter

Type

Description

product_id

String

Specifies the product ID, which can contain a maximum of 64 characters.

order_id

String

Specifies the order ID, which can contain a maximum of 64 characters.

Table 5 Address

Parameter

Type

Description

intranet_ip

String

(Expired) Specifies the private IP address of the cloud phone server.

access_ip

String

(Expired) Specifies the public IP address of the cloud phone server.

server_ip

String

(New) Specifies the private IP address of the cloud phone server.

public_ip

String

(New) Specifies the public IP address of the cloud phone server.

Table 6 Bandwidth

Parameter

Type

Description

band_width_name

String

Specifies the bandwidth name of the cloud phone server.

band_width_id

String

Specifies the unique identifier of the bandwidth used by the cloud phone server.

band_width_size

Integer

Specifies the bandwidth size of the cloud phone server.

band_width_charge_mode

Integer

Specifies the billing mode of the cloud phone server bandwidth.

  • 0: bandwidth (charged by bandwidth)

  • 1: traffic (charged by traffic)

band_width_share_type

Integer

Specifies the bandwidth type of the cloud phone server.

  • 0: per, exclusive bandwidth

  • 1: whole, shared bandwidth

create_time

String

Time when the bandwidth is created,

The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

Bandwidth Update Time,

The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

Table 7 Volume

Parameter

Type

Description

volume_name

String

Specifies the disk name of the cloud phone server.

volume_id

String

Specifies the unique identifier of the cloud phone server disk.

volume_size

Integer

Specifies the disk size of the cloud phone server, in GiB.

volume_type

String

Specifies the disk type of the cloud phone server.

create_time

String

Time when the hard disk is created,

The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

update_time

String

Hard Disk Update Time,

The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.

Table 8 share_volume_info

Parameter

Type

Description

volume_type

String

Specifies the type of the shared storage disk.

size

Integer

Size of the shared storage, in GiB.

version

Integer

Shared storage version:

  • 0: shared storage 1.0

  • 1: shared storage 2.0

Example Requests

Querying the details of a cloud phone server

GET https://{CPH Endpoint}/v1/{project_id}/cloud-phone/servers/88b8449b896f3a4f0ad57222dd91909

Example Responses

Status code: 200

OK

{
  "server_name" : "cph-418540-1620-40-old-1",
  "availability_zone" : "xxxxxx",
  "addresses" : [ {
    "public_ip" : "10.246.xxx.xxx",
    "server_ip" : "172.31.22.245",
    "intranet_ip" : "172.31.22.245",
    "access_ip" : "10.246.xxx.xxx"
  } ],
  "metadata" : {
    "product_id" : "OFFI451249149551403012",
    "order_id" : "CS2007271727F9XJE"
  },
  "create_time" : "2020-01-01T00:00:00Z",
  "vpc_id" : "12021c68-730f-41fa-9884-11c616f4c9ad",
  "phone_model_name" : "kg1.cg.c40.d30SSD.e1v1.old",
  "subnet_cidr" : "172.31.0.0/16",
  "keypair_name" : "KeyPair-1230",
  "resource_project_id" : "06a5b529fa80d28b2f53c014024bed44",
  "server_id" : "6edb89150bc742aa81fc8ac4ff047297",
  "server_model_name" : "physical.kg1.4xlarge.cg",
  "update_time" : "2020-01-01T00:00:00Z",
  "cidr" : "172.31.0.0/16",
  "vpc_cidr" : "172.31.0.0/16",
  "subnet_id" : "5784d2fe-fefd-42f0-a7f1-e88454d8bc0f",
  "request_id" : "91d5bf46a817466daa25fc5824ab9717",
  "status" : 5,
  "network_version" : "v1",
  "security_groups" : [ ]
}

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