Get Cloud Phone Group Tree
Get cloud phone group tree structure.
Interface Address:
text
/papi/container/group-treeRequest Method:
text
POSTContent-Type:
text
application/jsonHeader Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Access-Key | string | Yes | API access key ID. See API Rules for authentication details |
| X-Signature | string | Yes | Signature value, Base64-encoded HMAC-SHA256 result |
| X-Timestamp | string | Yes | Millisecond-level Unix timestamp (13 digits) |
| X-Nonce | string | Yes | Random string, 10~32 characters of lowercase letters and digits |
Body Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| sortType | integer | No | Sort type. Enum: 1-Device name ascending, 2-Device name descending, 3-Device duration ascending, 4-Device duration descending |
Request Example:
json
{
"sortType": 1
}Response Parameters:
| Parameter | Type | Description |
|---|---|---|
| code | integer | Error code. See Error Codes |
| data | array[object] | Response data, group tree list |
| ├─ name | string | Group name |
| ├─ sort | integer | Display order |
| ├─ sid | string | Group ID |
| ├─ systemFlag | boolean | Whether system default group |
| ├─ containerCount | integer | Container count |
| ├─ containers | array[object] | Container list under the group |
| ├─├─ ctrId | string | Container ID |
| ├─├─ remark | string | Remark |
| ├─├─ status | integer | Status |
| ├─├─ name | string | Container name |
| ├─├─ expire | integer | Authorization expiration time |
| ├─├─ ctrNameId | string | Business ID, same as the cloud phone resource's ctr_alias |
| ├─├─ ctrName | string | Container name |
| ├─├─ ctrRemark | string | Container remark name |
| ├─├─ androidVersion | string | Android version |
| ├─├─ os | integer | Cloud phone OS |
| ├─├─ skuCode | string | SKU code |
| ├─├─ skuName | string | SKU name |
| ├─├─ aliasCode | string | Alias code |
| ├─├─ multiple | number | Exchange multiplier |
| ├─├─ level | integer | Level |
| ├─├─ packageCode | string | Package code |
| ├─├─ sign | string | Signature |
| ├─├─ screenshotServiceUrl | string | Screenshot service URL |
| ├─├─ dest | string | Device IP encrypted string |
| ├─├─ ctrAlias | string | Container alias |
| ├─├─ topFlag | boolean | Whether pinned to top |
| ├─├─ operateFlag | boolean | Whether resource table container, only resource table containers have operation permission |
| ├─├─ authType | integer | Authorization type. 0-Ordinary, 1-Authorized, 2-Authorized by |
| msg | string | Error message |
Response Example:
json
{
"code": 0,
"data": [
{
"name": "Default Group",
"sort": 0,
"sid": "group-sid-xxx",
"systemFlag": true,
"containerCount": 2,
"containers": [
{
"ctrId": "ctr-xxx",
"remark": "remark",
"status": 7,
"name": "Test-Phone-01",
"expire": 1735689600000,
"ctrNameId": "22d6sr1gii",
"ctrName": "Test-Phone-01",
"ctrRemark": "cloud phone remark",
"androidVersion": "Android 12",
"os": 12,
"skuCode": "standard",
"skuName": "Standard",
"aliasCode": "std",
"multiple": 1.0,
"level": 1,
"packageCode": "pkg-xxx",
"sign": "sign-xxx",
"screenshotServiceUrl": "https://screenshot.example.com",
"dest": "encrypted-xxx",
"ctrAlias": "22d6sr1gii",
"topFlag": false,
"operateFlag": true,
"authType": 0
}
]
}
],
"msg": "success"
}