Skip to content

获取云机分组树 ​

获取云机分组树结构。

接口地址:

text
/papi/container/group-tree

请求方式:

text
POST

请求数据类型:

text
application/json

Header 参数:

参数类型必填说明
X-Access-Keystring是API 访问密钥 ID,鉴权方式见 接口规则
X-Signaturestring是签名值,Base64 编码的 HMAC-SHA256 计算结果
X-Timestampstring是毫秒级 Unix 时间戳(13 位)
X-Noncestring是随机字符串,10~32 位小写字母+数字

Body 参数:

参数类型必填说明
sortTypeinteger否排序类型,枚举:1-设备名称升序,2-设备名称降序,3-设备时长升序,4-设备时长降序

请求示例:

json
{
  "sortType": 1
}

响应参数:

参数类型说明
codeinteger错误码,参见 错误码说明
dataarray[object]返回数据,分组树列表
├─ namestring分组名称
├─ sortinteger显示顺序
├─ sidstring分组ID
├─ systemFlagboolean是否系统默认分组
├─ containerCountinteger容器数量
├─ containersarray[object]分组下的容器列表
├─├─ ctrIdstring容器标识
├─├─ remarkstring备注
├─├─ statusinteger状态
├─├─ namestring容器名
├─├─ expireinteger授权到期时间
├─├─ ctrNameIdstringId 业务Id,跟云机资源的ctr_alias相同
├─├─ ctrNamestring容器名称
├─├─ ctrRemarkstring容器备注名
├─├─ androidVersionstring安卓版本
├─├─ osinteger云机OS
├─├─ skuCodestringsku编号
├─├─ skuNamestringsku名称
├─├─ aliasCodestring别名编码
├─├─ multiplenumber兑换倍数
├─├─ levelinteger等级
├─├─ packageCodestring套餐编码
├─├─ signstring签名
├─├─ screenshotServiceUrlstring截图服务地址
├─├─ deststring设备IP加密字符串
├─├─ ctrAliasstring容器别名
├─├─ topFlagboolean是否置顶
├─├─ operateFlagboolean是否资源表容器,只有资源表的才有操作权限
├─├─ authTypeinteger授权类型,0-普通,1-已授权,2-被授权
msgstring错误提示

响应示例:

json
{
  "code": 0,
  "data": [
    {
      "name": "默认分组",
      "sort": 0,
      "sid": "group-sid-xxx",
      "systemFlag": true,
      "containerCount": 2,
      "containers": [
        {
          "ctrId": "ctr-xxx",
          "remark": "备注",
          "status": 7,
          "name": "测试云机-01",
          "expire": 1735689600000,
          "ctrNameId": "22d6sr1gii",
          "ctrName": "测试云机-01",
          "ctrRemark": "云机备注",
          "androidVersion": "Android 12",
          "os": 12,
          "skuCode": "standard",
          "skuName": "标准版",
          "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"
}

OpenAPI Docs