获得全部云机列表
获取全部云机列表。
接口地址:
text
/papi/container/all-container请求方式:
text
POST请求数据类型:
text
application/jsonHeader 参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| X-Access-Key | string | 是 | API 访问密钥 ID,鉴权方式见 接口规则 |
| X-Signature | string | 是 | 签名值,Base64 编码的 HMAC-SHA256 计算结果 |
| X-Timestamp | string | 是 | 毫秒级 Unix 时间戳(13 位) |
| X-Nonce | string | 是 | 随机字符串,10~32 位小写字母+数字 |
Body 参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| groupSid | string | 否 | 分组的sid |
| expireFlag | boolean | 否 | 是否过期 |
| proxyIpUid | string | 否 | 代理IP的UID,用于过滤已绑定该IP的云机 |
请求示例:
json
{
"groupSid": "group-xxx",
"expireFlag": false
}响应参数:
| 参数 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码,参见 错误码说明 |
| data | array[object] | 返回数据 |
| ├─ expire | integer | 过期时间(有效期) |
| ├─ ctrAlias | string | 别名 |
| ├─ ctrId | string | 容器ID |
| ├─ ctrNameId | string | 容器业务ID |
| ├─ groupName | string | 分组名称 |
| ├─ ctrName | string | 云机名称 |
| ├─ ctrRemark | string | 云机备注 |
| ├─ level | integer | 云机等级 |
| ├─ skuCode | string | 云机规格 |
| ├─ skuName | string | 云机规格名称 |
| ├─ aliasCode | string | 规格编号别名 |
| ├─ status | integer | 云机状态 |
| ├─ fpSign | string | 签名 |
| ├─ screenshotServiceUrl | string | 截图服务地址 |
| ├─ dest | string | 设备IP加密字符串 |
| ├─ operateFlag | boolean | 操作权限 |
| msg | string | 错误提示 |
响应示例:
json
{
"code": 0,
"data": [
{
"expire": 1735689600000,
"ctrAlias": "22d6sr1gii",
"ctrId": "ctr-xxx",
"ctrNameId": "ctrNameId-xxx",
"groupName": "默认分组",
"ctrName": "测试云机-01",
"ctrRemark": "云机备注",
"level": 1,
"skuCode": "standard",
"skuName": "标准版",
"aliasCode": "std",
"status": 7,
"fpSign": "sign-xxx",
"screenshotServiceUrl": "https://screenshot.example.com",
"dest": "encrypted-xxx",
"operateFlag": true
}
],
"msg": "success"
}