接口功能介绍
服务器安全卫士系统，防护配额列表查询
接口约束
已经签约安全卫士服务协议
URI
POST /v1/quota/quotaList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentNum | 是 | Integer | 列表当前页 | 1 | |
| pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| quotaId | 否 | String | 配额ID | 1asd2 | |
| quotaStatus | 否 | Integer | 配额状态 1:未绑定(正常) 2:使用中(正常) 4:已到期 8：已冻结 16:已退订 32:已销毁 |
1 | |
| serverName | 否 | String | 服务器名称 | ||
| serverIp | 否 | String | 防护服务器IP | 166.0.0.2 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000 :成功; CTCSSCN_000001:失败; CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用; CTCSSCN_000004：鉴权错误; CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | pageInfo |
表 pageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页记录数 | 10 | |
| pages | Integer | 总页数 | 2 | |
| total | Integer | 总记录数 | 20 | |
| isFirstPage | Boolean | 是否为首页 | false | |
| isLastPage | Boolean | 是否为末页 | false | |
| list | Object | 列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| quotaId | String | 配置数据id | 05d87f69ac884ec98665289bba3a7e77 | |
| quotaVersion | Integer | 配额规格 1：基础版 2：企业版 |
2 | |
| serverName | String | 服务器名称 | CentOS76-az1-2 | |
| quotaStatus | String | 配额状态.安全系统状态 1:未绑定(正常) 2:使用中(正常) 4:已到期 8：已冻结 16:已退订 32:已销毁 |
2 | |
| serverIp | String | 服务器ip | 172.18.208.172 | |
| agentGuid | String | 服务器ID | F5283205-CB2C-45E6-8629-9D5DB63D3AC3 | |
| startDate | String | 配额开通时间 | 2023-10-10 00:00:00 | |
| expirationDate | String | 配额到期时间 | 2023-10-10 00:00:00 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"serverIp": "163.0.0.2"}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"total": 1,"list": [{"id": 2,"quotaId": "1","quotaVersion": 1,"regionId": "1","ctyunUserId": "1","quotaStatus": 2,"serverName": "2","serverIp": "1.1.1.1","agentGuid": null,"startDate": "2022-07-21T06:18:55.000+00:00","expirationDate": "2022-07-21T06:18:58.000+00:00","reloadDate": null,"cancelDate": null,"createTime": "2022-07-21T06:19:01.000+00:00","updateTime": "2022-07-21T07:40:58.000+00:00","status": 1,"agentGuidList": null,"quotaIdList": null}],"pageNum": 1,"pageSize": 10,"size": 1,"startRow": 1,"endRow": 1,"pages": 1,"prePage": 0,"nextPage": 0,"isFirstPage": true,"isLastPage": true,"hasPreviousPage": false,"hasNextPage": false,"navigatePages": 8,"navigatepageNums": [1],"navigateFirstPage": 1,"navigateLastPage": 1}}
状态码
请参考 状态码
错误码
请参考 错误码
