Skip to content

根据ctrAlias查询单台云机信息 ​

根据 ctrAlias 查询单台云机详细信息。

接口地址:

text
/papi/container/getContainer

请求方式:

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 参数:

参数类型必填说明
ctrAliasstring是容器别名

请求示例:

json
{
  "ctrAlias": "22d6sr1gii"
}

响应参数:

参数类型说明
codeinteger错误码,参见 错误码说明
dataobject返回数据
├─ ctrIdstring容器标识
├─ roleIdinteger角色ID
├─ namestring容器名称
├─ ctrNameIdstring容器id业务主键
├─ autoRenewFlagboolean是否自动续费
├─ shareboolean是否共享
├─ expireinteger过期时间(有效期)
├─ statusinteger状态
├─ ctrNamestring容器名称
├─ ctrMobileModelstring型号
├─ ctrAliasstring容器别名
├─ remarkstring云手机备注
├─ ctrRemarkstring云手机备注
├─ ctrIpstring容器IP
├─ bootstrapAtinteger启动时间
├─ stopAtinteger关闭时间
├─ authNuminteger授权人数
├─ groupNamestring分组名称
├─ cphoneProxyHoststring代理IP
├─ refreshCountinteger一键新机免费次数
├─ payRefreshCountinteger一键新机付费次数
├─ monthlyGiftCountinteger一键新机每月免费总次数
├─ deststring设备IP加密字符串
├─ screenshotServiceUrlstring截图服务地址
├─ turnServerUristring中继地址
├─ skuNamestringsku 名称
├─ skuCodestringsku 编号
├─ aliasCodestring别名编码
├─ androidVersionstring安卓版本
├─ osinteger云机OS
├─ levelintegersku Level
├─ packageCodestring套餐Code
├─ fpSignstring云机操作接口鉴权签名
├─ topFlagboolean是否置顶
├─ ossServiceApiUrlstringOSS服务端API地址
├─ operateFlagboolean是否操作权限
├─ authTypeinteger授权类型,0-普通,1-已授权,2-被授权
msgstring错误提示

响应示例:

json
{
  "code": 0,
  "data": {
    "ctrId": "ctr-xxx",
    "roleId": 0,
    "name": "测试云机-01",
    "ctrNameId": "ctrNameId-xxx",
    "autoRenewFlag": false,
    "share": false,
    "expire": 1735689600000,
    "status": 7,
    "ctrName": "测试云机-01",
    "ctrMobileModel": "SM-G9880",
    "ctrAlias": "22d6sr1gii",
    "remark": "备注",
    "ctrRemark": "云机备注",
    "ctrIp": "192.168.1.100",
    "bootstrapAt": 1735689600000,
    "stopAt": 0,
    "authNum": 0,
    "groupName": "默认分组",
    "cphoneProxyHost": "",
    "refreshCount": 10,
    "payRefreshCount": 0,
    "monthlyGiftCount": 10,
    "dest": "encrypted-xxx",
    "screenshotServiceUrl": "https://screenshot.example.com",
    "turnServerUri": "turn:turn.example.com:3478",
    "skuName": "标准版",
    "skuCode": "standard",
    "aliasCode": "std",
    "androidVersion": "Android 12",
    "os": 12,
    "level": 1,
    "packageCode": "pkg-xxx",
    "fpSign": "sign-xxx",
    "topFlag": false,
    "ossServiceApiUrl": "https://oss.example.com",
    "operateFlag": true,
    "authType": 0
  },
  "msg": "success"
}

OpenAPI Docs