Queries the details of a cloud phone matrix. In the Wuying Cloud Phone system, a matrix (Cloud Phone Server) is a logical resource 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
Test
RAM authorization
Request syntax
GET HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| BizRegionId |
string |
No |
The region ID. Valid values:
|
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 pass 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:
|
CREATING |
| ServerType |
string |
No |
The specifications of the cloud phone matrix. Valid values:
|
cpm.gx7.10xlarge |
| ChargeType |
string |
No |
The billing type. Only subscription is supported. Valid values:
|
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 |
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 matrix. |
|
|
array<object> |
The details of the cloud phone matrix. |
||
| Status |
string |
The status of the cloud phone matrix. |
RUNNING |
| ServerType |
string |
The specifications 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 time when the matrix was last modified. |
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 matrix. |
2025-03-09 02:00:34 |
| PhoneCount |
integer |
The number of instances provisioned under the cloud phone matrix. |
25 |
| GmtCreate |
string |
The creation time. |
2024-11-13 02:03:14 |
| ChargeType |
string |
The billing type. |
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 device storage. Unit: GiB. |
100 |
| PhoneDataInfo |
object |
The independent device storage information. |
|
| 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-related information. |
|
|
object |
The network-related 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 bandwidth plan ID. |
cbwp-7xvrl7axet2qg6yia****** |
| BizTags |
array<object> |
The array of tag information. |
|
|
object |
The tag object. |
||
| Key |
string |
The tag key. |
keyname |
| Value |
string |
The tag value. |
valuename |
| BandwidthPackageStatus |
string |
The status of the bandwidth plan. Valid values:
|
1 |
| SwapSize |
integer |
||
| Tags |
array<object> |
||
|
object |
|||
| Key |
string |
||
| Value |
string |
||
| TotalCount |
integer |
The total number of entries. |
31 |
| NextToken |
string |
Indicates whether a next pagination token exists. Valid values:
|
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
| MaxResults |
integer |
The maximum number of entries per page for a paged query. |
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,
"Tags": [
{
"Key": "",
"Value": ""
}
]
}
],
"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.