1)接口功能介绍
查询用户在节边缘池的全部的粗粒度配额信息。
2)接口约束
请求数据的格式确保正确,nodeCode需准确。
3)URI
GET /v1/describeStock。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码接口获取,也可联系智能边缘云团队。 | cn-guangzhou3 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例值 | 下级对象 |
---|---|---|---|---|---|
snapshotUser | 是 | Object | 用户可用快照数量 | ||
snapshotUser.total | 是 | Integer | 可用配额总数 | 10 | |
snapshotUser.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
snapshotUser.unit | 否 | String | 单位 | ||
snapshtInstance | 是 | Object | 单个实例可用快照数量 | ||
snapshtInstance.total | 是 | Integer | 可用配额总数 | 10 | |
snapshtInstance.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
snapshtInstance.unit | 否 | String | 单位 | ||
nat | 是 | Object | 可用nat网关数量 | ||
nat.total | 是 | Integer | 可用配额总数 | 10 | |
nat.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
nat.unit | 否 | String | 单位 | ||
rawDisk | 是 | Object | 可用裸盘大小 | ||
rawDisk.total | 是 | Integer | 可用配额总数 | 10 | |
rawDisk.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
rawDisk.unit | 否 | String | 单位 | ||
backupUser | 是 | Object | 用户可备份的数量 | ||
backupUser.total | 是 | Integer | 可用配额总数 | 10 | |
backupUser.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
backupUser.unit | 否 | String | 单位 | ||
mem | 是 | Object | 可用内存大小 | ||
mem.total | 是 | Integer | 可用配额总数 | 10 | |
mem.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
mem.unit | 否 | String | 单位 | ||
backupInstance | 是 | Object | 单个实例可备份的数量 | ||
backupInstance.total | 是 | Integer | 可用配额总数 | 10 | |
backupInstance.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
backupInstance.unit | 否 | String | 单位 | ||
bmImage | 是 | Object | 裸金属私有镜像个数 | ||
bmImage.total | 是 | Integer | 可用配额总数 | 10 | |
bmImage.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
bmImage.unit | 否 | String | 单位 | ||
cloudDisk | 是 | Object | 可用云盘大小 | ||
cloudDisk.total | 是 | Integer | 可用配额总数 | 10 | |
cloudDisk.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
cloudDisk.unit | 否 | String | 单位 | ||
bandwidth | 是 | Object | 可用带宽 | ||
bandwidth.total | 是 | Integer | 可用配额总数 | 10 | |
bandwidth.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
bandwidth.unit | 否 | String | 单位 | ||
vmPrivateImage | 是 | Object | 虚拟机私有镜像 | ||
vmPrivateImage.total | 是 | Integer | 可用配额总数 | 10 | |
vmPrivateImage.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
vmPrivateImage.unit | 否 | String | 单位 | ||
ipv4 | 是 | Object | ipv4 | ||
ipv4.total | 是 | Integer | 可用配额总数 | 10 | |
ipv4.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
ipv4.unit | 否 | String | 单位 | ||
vpc | 是 | Object | 私有网络 | ||
vpc.total | 是 | Integer | 可用配额总数 | 10 | |
vpc.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
vpc.unit | 否 | String | 单位 | ||
ipv6 | 是 | Object | ipv6 | ||
ipv6.total | 是 | Integer | 可用配额总数 | 10 | |
ipv6.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
ipv6.unit | 否 | String | 单位 | ||
cpu | 是 | Object | cpu | ||
cpu.total | 是 | Integer | 可用配额总数 | 10 | |
cpu.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
cpu.unit | 否 | String | 单位 | 核 | |
gpu | 是 | Object | gpu | ||
gpu.total | 是 | Integer | 可用配额总数 | 10 | |
gpu.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
gpu.unit | 否 | String | 单位 | 块 | |
slb | 是 | Object | 负载均衡 | ||
slb.total | 是 | Integer | 可用配额总数 | 10 | |
slb.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
slb.unit | 否 | String | 单位 | ||
localDisk | 是 | Object | 本地盘 | ||
localDisk.total | 是 | Integer | 可用配额总数 | 10 | |
localDisk.remaining | 是 | Integer | 剩余可用配额数 | 5 | |
localDisk.unit | 否 | String | 单位 | GiB |
6)请求示例
GET https://{host}/v1/describeStock?nodeCode=yn-lincang-1
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"snapshotUser": {
"total": 0,
"remaining": 0,
"unit": ""
},
"nat": {
"total": 0,
"remaining": 0,
"unit": ""
},
"rawDisk": {
"total": 7000,
"remaining": 7000,
"unit": "GiB"
},
"backupUser": {
"total": 0,
"remaining": 0,
"unit": ""
},
"mem": {
"total": 20,
"remaining": 16,
"unit": "GiB"
},
"backupInstance": {
"total": 0,
"remaining": 0,
"unit": ""
},
"bmImage": {
"total": 0,
"remaining": 0,
"unit": ""
},
"snapshotInstance": {
"total": 0,
"remaining": 0,
"unit": ""
},
"cloudDisk": {
"total": 800,
"remaining": 560,
"unit": "GiB"
},
"bandwidth": {
"total": 0,
"remaining": 0,
"unit": ""
},
"vmPrivateImage": {
"total": 10,
"remaining": 0,
"unit": "个"
},
"ipv4": {
"total": 20,
"remaining": 18,
"unit": "个"
},
"vpc": {
"total": 10,
"remaining": 7,
"unit": "个"
},
"ipv6": {
"total": 0,
"remaining": 0,
"unit": ""
},
"gpu": {
"total": 5,
"remaining": 2,
"unit": "块"
},
"cpu": {
"total": 10,
"remaining": 6,
"unit": "核"
},
"slb": {
"total": 0,
"remaining": 0,
"unit": ""
},
"localDisk": {
"total": 2000,
"remaining": 2000,
"unit": "GiB"
}
},
"requestId": "9819a76d-21f3-43dc-9874-39b1ee2eac27"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |