接口功能介绍
服务器安全卫士系统,配额统计
接口约束
已经签约安全卫士服务协议
URI
GET /v1/quota/overview
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码 CTCSSCN_000000 :成功; CTCSSCN_000001:失败; CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用; CTCSSCN_000004:鉴权错误; CTCSSCN_000005:用户没有付费版配额,功能不可用 |
CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | Object | 返回对象 | QuotaDto |
表 QuotaDto
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
bindingCount | Integer | 使用中配额数量 | 1 | |
unbindingCount | Integer | 未绑定配额数量 | 10 | |
normalCount | Integer | 正常配额数量,bindingCount+unbindingCount | 11 | |
expirationCount | Integer | 过期配额数量 | 20 | |
cancelCount | Integer | 退订配额数量 | 1 | |
quotaTotal | Integer | 配额总数 | 1 | |
expirationDate | String | 配额到期时间,取所有配额中,到期时间最大值 | 2022-07-21T06:18:58.000+00:00 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
无
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"expirationDate": "2022-07-21T06:18:58.000+00:00","bindingCount": 1,"unbindingCount": 1,"normalCount": 2,"expirationCount": 1,"cancelCount": 1,"quotaTotal": 5}
状态码
请参考 状态码
错误码
请参考 错误码