Filter and Query Cloud Phone Node Details with DescribeCloudPhoneNodes - ECP - Alibaba Cloud -

Queries the details of a cloud phone matrix. In the Wuying Cloud Phone system, a matrix (Cloud Phone Server) is a logical resource management snap-in that represents a physical server instance. The physical server can be divided into multiple independently running cloud phone instances that share the underlying compute, storage, and network resources of the matrix. Creating a matrix is equivalent to obtaining a physical server on which you can create cloud phone instances. The number of cloud phone instances that can be created 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 per page for a paged query. Maximum value: 100. Default value: 20.	20
NextToken	string	No	The pagination token for the next query. If the results of a query are not completely returned, the returned NextToken is not empty. You can include the returned NextToken in the next request to continue the query.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uONHqPtDLM2U8s****
NodeIds	array	No	The list of cloud phone matrix IDs.
	string	No	The 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 : Creation failed. RUNNING : Available. DELETING : Being deleted. NODE_READY : Node ready. Instances are being created. DELETED : Deleted. CREATING : Being created.	CREATING
ServerType	string	No	The specifications of the cloud phone matrix. Valid values: cpm.gx7.10xlarge : cpm.gx7.10xlarge cpm.gx8.16xlarge : cpm.gx8.16xlarge	cpm.gx7.10xlarge
ChargeType	string	No	The billing method. Only subscription is supported. Valid values: PrePaid : Subscription.	PrePaid
BandwidthPackageId	string	No	The instance ID of the bandwidth plan.	cbwp-bp17psa7fhxqmm*****
NodeNameList	array	No
	string	No
Tags	array<object>	No
	object	No
Key	string	No
Value	string	No
SortKey	string	No
SortType	string	No

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.