查询总资源概览信息
更新时间：2021-08-02
接口描述
本接口用于获取用户当前总资源的概览信息，包括用户资源使用量汇总、已购买节点汇总等相关信息。
请求结构
Plain Text
1GET /v1/overview/summary HTTP/1.1
2Host: bec.baidubce.com
3Content-Type: application/json; charset=utf-8
4Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
无。
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ready | Integer | 已上线节点数量 |
| notReady | Integer | 未上线节点数量 |
| used | Integer | 已购买节点数量 |
| resourceUsage | ResourceUsageInISP | 用户资源使用量汇总 |
| usedNodes | NodeInfoVo | 用户已购买节点汇总 |
| readyNodes | NodeInfoVo | 已上线节点信息汇总 |
| notReadyNodes | NodeInfoVo | 未上线节点信息汇总 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v1/overview/summary HTTP/1.1
2Host: bec.baidubce.com
3Content-Type: application/json; charset=utf-8
4Authorization: bce-auth-v1/318857a8f08b11e9845ca7e54775a0c2/2019-10-17T03:07:21Z/1800/host/212eef8cfe1ac94be56c4afedb9360bba621ef646c3c8288971d36801d70501a响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2019 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5X-Bce-Gateway-Region: BJ
6{
7 "ready": 5,
8 "notReady": 1,
9 "used": 3,
10 "resourceUsage": {
11 "usageMap": {
12 "CHINA_MOBILE": {
13 "cpu": 3,
14 "memory": 6,
15 "storage": 0
16 },
17 "CHINA_TELECOM": {
18 "cpu": 6,
19 "memory": 12,
20 "storage": 0
21 },
22 "CHINA_UNICOM": {
23 "cpu": 4,
24 "memory": 8,
25 "storage": 0
26 }
27 }
28 },
29 "usedNodes": {
30 "regionList": [
31 {
32 "region": "EAST_CHINA",
33 "name": "华东",
34 "cityList": [
35 {
36 "city": "HANGZHOU",
37 "name": "杭州",
38 "serviceProviderList": [
39 {
40 "serviceProvider": "CHINA_MOBILE",
41 "name": "移动"
42 }
43 ]
44 }
45 ]
46 },
47 {
48 "region": "NORTH_EAST",
49 "name": "东北",
50 "cityList": [
51 {
52 "city": "CHANGCHUN",
53 "name": "长春",
54 "serviceProviderList": [
55 {
56 "serviceProvider": "CHINA_UNICOM",
57 "name": "联通"
58 }
59 ]
60 }
61 ]
62 },
63 {
64 "region": "NORTH_WEST",
65 "name": "西北",
66 "cityList": [
67 {
68 "city": "XIAN",
69 "name": "西安",
70 "serviceProviderList": [
71 {
72 "serviceProvider": "CHINA_TELECOM",
73 "name": "电信"
74 }
75 ]
76 }
77 ]
78 }
79 ],
80 "nodeSum": 3
81 },
82 "readyNodes": {
83 "regionList": [
84 {
85 "region": "NORTH_WEST",
86 "name": "西北",
87 "cityList": [
88 {
89 "city": "XIAN",
90 "name": "西安",
91 "serviceProviderList": [
92 {
93 "serviceProvider": "CHINA_TELECOM",
94 "name": "电信"
95 }
96 ]
97 }
98 ]
99 },
100 {
101 "region": "EAST_CHINA",
102 "name": "华东",
103 "cityList": [
104 {
105 "city": "HANGZHOU",
106 "name": "杭州",
107 "serviceProviderList": [
108 {
109 "serviceProvider": "CHINA_MOBILE",
110 "name": "移动"
111 }
112 ]
113 }
114 ]
115 },
116 {
117 "region": "SOUTH_CHINA",
118 "name": "华南",
119 "cityList": [
120 {
121 "city": "GUANGZHOU",
122 "name": "广州",
123 "serviceProviderList": [
124 {
125 "serviceProvider": "CHINA_UNICOM",
126 "name": "联通"
127 }
128 ]
129 }
130 ]
131 },
132 {
133 "region": "NORTH_EAST",
134 "name": "东北",
135 "cityList": [
136 {
137 "city": "CHANGCHUN",
138 "name": "长春",
139 "serviceProviderList": [
140 {
141 "serviceProvider": "CHINA_UNICOM",
142 "name": "联通"
143 }
144 ]
145 }
146 ]
147 },
148 {
149 "region": "SOUTH_WEST",
150 "name": "西南",
151 "cityList": [
152 {
153 "city": "CHENGDU",
154 "name": "成都",
155 "serviceProviderList": [
156 {
157 "serviceProvider": "CHINA_MOBILE",
158 "name": "移动"
159 }
160 ]
161 }
162 ]
163 }
164 ],
165 "nodeSum": 5
166 },
167 "notReadyNodes": {
168 "regionList": [
169 {
170 "region": "EAST_CHINA",
171 "name": "华东",
172 "cityList": [
173 {
174 "city": "ZHONGWEI",
175 "name": "中卫",
176 "serviceProviderList": [
177 {
178 "serviceProvider": "CHINA_MOBILE",
179 "name": "移动"
180 }
181 ]
182 }
183 ]
184 }
185 ],
186 "nodeSum": 1
187 }
188}Model对象定义
ResourceUsageInISP
| 参数名称 | 类型 | 描述 |
|---|---|---|
| usageMap | Map<ServiceProvider, Usage> | 资源使用量汇总 |
Usage
| 参数名称 | 类型 | 描述 |
|---|---|---|
| cpu | Integer | cpu使用量，单位核数 |
| memory | Integer | 内存使用量，单位Gi |
| storage | long | 存储使用量，单位Gi |
NodeInfoVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| regionList | List<RegionInfo> | 节点信息 |
RegionInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| region | Region | 节点所属区域英文名称 |
| name | String | 节点所属区域中文名称，如region为"CENTRAL_CHINA"，对应name为"华中" |
| cityList | List<CityInfo> | 节点所在城市信息 |
CityInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| city | String | 节点所在城市英文名称，格式如"CHENGDU" |
| name | String | 节点所在城市中文名称，如city为"CHENGDU"，则对应name为"成都" |
| serviceProviderList | List<ServiceProviderInfo> | 节点所在运营商信息 |
ServiceProviderInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceProvider | ServiceProvider | 节点所属运营商英文名称 |
| name | String | 节点所属运营商中文名称 |
Region
| 枚举名称 | 描述 |
|---|---|
| CENTRAL_CHINA | 华中 |
| EAST_CHINA | 华东 |
| NORTH_CHINA | 华北 |
| SOUTH_CHINA | 华南 |
| NORTH_EAST | 东北 |
| NORTH_WEST | 西北 |
| SOUTH_WEST | 西南 |
ServiceProviderInfo
| 枚举名称 | 描述 |
|---|---|
| CHINA_UNICOM | 联通 |
| CHINA_MOBILE | 移动 |
| CHINA_TELECOM | 电信 |