DescribeCloudPhoneNodes - - Alibaba Cloud Documentation Center

Queries the details of Cloud Phone matrices. In the Cloud Phone service, a matrix (Cloud Phone Server) is a logical resource management unit that represents a physical server instance. This physical server can be partitioned into multiple independent Cloud Phone instances that share the underlying computing, storage, and network resources of the matrix. Creating a matrix is equivalent to provisioning a physical server on which you can create Cloud Phone instances. The number of instances that you can create varies depending on the configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
BizRegionId	string	No	The region ID. Valid values: cn-shanghai : China (Shanghai) ap-southeast-1 : Singapore eu-central-1 : Germany (Frankfurt) cn-hangzhou : China (Hangzhou)	cn-hangzhou
MaxResults	string	No	The maximum number of entries to return on each page for a paged query. The maximum value is 100. The default value is 20.	20
NextToken	string	No	The token for the next query. If a query does not return all results, NextToken is not empty. Use the returned NextToken in your next query to continue.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****
NodeIds	array	No	A list of Cloud Phone matrix IDs.
	string	No	A Cloud Phone matrix ID.	cpn-192c32356ft1ov1m****
NodeName	string	No	The name of the Cloud Phone matrix.	node_name
Status	string	No	The status of the Cloud Phone matrix. Valid values: FAILED : The matrix failed to be created. RUNNING : Active. DELETING : The matrix is being deleted. NODE_READY : The node is ready and instances are being created. DELETED : The matrix is deleted. CREATING : The matrix is being created.	CREATING
ServerType	string	No	The instance type of the Cloud Phone matrix. Valid values: cpm.gn6.gx1 : cpm.gn6.gx1	cpm.gx7.10xlarge
ChargeType	string	No	The billing method. Only the subscription billing method is supported. Valid values: PrePaid : Subscription.	PrePaid
BandwidthPackageId	string	No	The ID of the bandwidth plan instance.	cbwp-bp17psa7fhxqmm*****

Response elements

Element	Type	Description	Example
	object	The request information.
RequestId	string	The request ID.	F07A1DA1-E1EB-5CCA-8EED-12F85D32****
NodeModel	array<object>	The details of the Cloud Phone matrices.
	array<object>	The details of the Cloud Phone matrix.
Status	string	The status of the Cloud Phone matrix.	RUNNING
ServerType	string	The instance type of the Cloud Phone matrix.	cpm.gx7.10xlarge
ResolutionWidth	integer	The width of the resolution. Unit: pixels.	720
NodeName	string	The name of the Cloud Phone matrix.	node_name
Memory	integer	The memory size. Unit: GB.	32
VSwitchId	string	The vSwitch ID.	vsw-2zeekryyc1q3sm72l****
GmtModified	string	The last modification time.	2025-02-13 02:03:14
Cpu	string	The number of CPU cores.	2
ResolutionHeight	integer	The height of the resolution. Unit: pixels.	1280
NetworkId	string	The network ID.	cn-hangzhou+dir-5mwr9azebliva****
GmtExpired	string	The expiration time of the subscription-based matrix.	2025-03-09 02:00:34
PhoneCount	integer	The number of instances in the Cloud Phone matrix.	25
GmtCreate	string	The creation time.	2024-11-13 02:03:14
ChargeType	string	The billing method.	PrePaid
NodeId	string	The Cloud Phone matrix ID.	cpn-ehs0yoedq8ntm****
RegionId	string	The region ID.	cn-hangzhou
InstanceType	string	The instance type.	ac.max
ShareDataVolume	integer	The size of the shared phone storage. Unit: GiB.	100
PhoneDataInfo	object	The information about the independent phone storage.
PhoneDataId	string	The ID of the independent phone storage.	pd-dhusabisshj****
PhoneDataVolume	integer	The size of the independent phone storage. Unit: GiB.	20
NetworkInfos	array<object>	The network information.
	object	The network information.
VSwitchId	string	The ID of the vSwitch in the virtual private cloud (VPC).	vsw-j6cjgev6fv3ftw4f0****
NetworkId	string	The network ID.	cn-hangzhou+dir-avcuocx9805oq****
NetworkType	string	The network type of the instance.	network_pro_ecd
BandwidthPackageType	string	The bandwidth type.	cbwp_ecd
BandwidthPackageId	string	The ID of the bandwidth plan instance.	cbwp-hn3tj409amvamz8mf****
NetworkType	string	The network type of the instance.	network_pro_ecd
BandwidthPackageType	string	The bandwidth type.	cbwp_ecd
BandwidthPackageId	string	The ID of the bandwidth plan.	cbwp-7xvrl7axet2qg6yia******
BizTags	array<object>	An array of tag information.
	object	A tag object.
Key	string	The tag key.	keyname
Value	string	The tag value.	valuename
BandwidthPackageStatus	string	The status of the bandwidth plan: 0 indicates initializing, 1 indicates normal, and 2 indicates deleted.	1
SwapSize	integer
TotalCount	integer	The total number of entries.	31
NextToken	string	The token used to start the next query. Valid values: If NextToken is empty, there are no more results. If NextToken has a value, it indicates the token for the next query.	AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****
MaxResults	integer	The maximum number of entries returned on each page.	20

Examples

Success response

JSON format

{
  "RequestId": "F07A1DA1-E1EB-5CCA-8EED-12F85D32****",
  "NodeModel": [
    {
      "Status": "RUNNING",
      "ServerType": "cpm.gx7.10xlarge",
      "ResolutionWidth": 720,
      "NodeName": "node_name",
      "Memory": 32,
      "VSwitchId": "vsw-2zeekryyc1q3sm72l****",
      "GmtModified": "2025-02-13 02:03:14",
      "Cpu": "2",
      "ResolutionHeight": 1280,
      "NetworkId": "cn-hangzhou+dir-5mwr9azebliva****",
      "GmtExpired": "2025-03-09 02:00:34",
      "PhoneCount": 25,
      "GmtCreate": "2024-11-13 02:03:14",
      "ChargeType": "PrePaid",
      "NodeId": "cpn-ehs0yoedq8ntm****",
      "RegionId": "cn-hangzhou",
      "InstanceType": "ac.max",
      "ShareDataVolume": 100,
      "PhoneDataInfo": {
        "PhoneDataId": "pd-dhusabisshj****",
        "PhoneDataVolume": 20
      },
      "NetworkInfos": [
        {
          "VSwitchId": "vsw-j6cjgev6fv3ftw4f0****",
          "NetworkId": "cn-hangzhou+dir-avcuocx9805oq****",
          "NetworkType": "network_pro_ecd",
          "BandwidthPackageType": "cbwp_ecd",
          "BandwidthPackageId": "cbwp-hn3tj409amvamz8mf****"
        }
      ],
      "NetworkType": "network_pro_ecd",
      "BandwidthPackageType": "cbwp_ecd",
      "BandwidthPackageId": "cbwp-7xvrl7axet2qg6yia******",
      "BizTags": [
        {
          "Key": "keyname",
          "Value": "valuename"
        }
      ],
      "BandwidthPackageStatus": "1",
      "SwapSize": 0
    }
  ],
  "TotalCount": 31,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.