查询配额列表
更新时间 2025-12-25 11:43:39
最近更新时间: 2025-12-25 11:43:39
接口功能介绍
服务器安全卫士系统，防护配额列表查询
接口约束
已经签约安全卫士服务协议
URI
POST /v1/quota/quotaList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentNum | 是 | Integer | 页码 | ||
| pageSize | 是 | Integer | 页大小 |
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| quotaId | 否 | String | 防护配额ID | 6c8caaa32418441c8c164e3f43d76791 | |
| quotaVersion | 否 | Integer | 配额版本 1-基础版 2-企业版 3-旗舰版 | 1 | |
| serverIp | 否 | String | 服务器ip | 192.168.1.1 | |
| custName | 否 | String | 服务器名称（模糊查询) | test-server-name | |
| quotaStatus | 否 | Integer | 防护配额状态 1-未绑定 2-绑定中 4-已过期 8-已冻结 16-已退订 32-已销毁 0-无效 3-正常（未绑定和绑定中） | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000：成功 | ||||
| CTCSSCN_000001：失败 | ||||
| CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004：鉴权错误 | ||||
| CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | returnObj | |
| traceId | String | traceId | asaadasd11111 | |
| statusCode | String | 状态码 200-成功 | 200 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总数 | 100 | |
| list | Array of Objects | 结果集 | list | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| quotaId | String | 配额ID | 6c8caaa32418441c8c164e3f43d767 | |
| quotaVersion | Integer | 配额版本 1-基础版 2-企业版 3-旗舰版 | 1 | |
| quotaStatus | Integer | 防护配额状态 1-未绑定 2-绑定中 4-已过期 8-已冻结 16-已退订 32-已销毁 0-无效 | 1 | |
| serverIp | String | 服务器ip | 192.168.1.1 | |
| agentGuid | String | agentGuid | test-agent-guid | |
| startDate | String | 开始时间 | 2020-01-01 00:00:00 | |
| expirationDate | String | 到期时间 | 2020-01-01 00:00:00 | |
| createTime | String | 创建时间 | 2020-01-01 00:00:00 | |
| updateTime | String | 更新时间 | 2020-01-01 00:00:00 | |
| serverName | String | 主机名称 | test-server-name | |
| custName | String | 主机名称 | test-server-name | |
| displayName | String | 实例名称 | test-display-name | |
| publicIp | String | 公网ip | 192.168.1.1 | |
| privateIp | String | 私网ip | 192.168.1.1 | |
| extInfo | Object | extInfo | ||
| enterpriseProjectId | String | 企业项目id | ||
| enterpriseProjectName | String | 企业项目名称 | ||
| 表 extInfo |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| key | Object | key | ||
| 表 key |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"quotaId": "6c8caaa32418441c8c164e3f43d76791", "quotaVersion": 1, "serverIp": "192.168.1.1", "custName": "test-server-name", "quotaStatus": 1}
响应示例
{"message": "success", "traceId": "asaadasd11111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": {"total": 100, "list": [{"quotaId": "6c8caaa32418441c8c164e3f43d767", "quotaVersion": 1, "quotaStatus": 1, "serverIp": "192.168.1.1", "agentGuid": "test-agent-guid", "startDate": "2020-01-01 00:00:00", "expirationDate": "2020-01-01 00:00:00", "createTime": "2020-01-01 00:00:00", "updateTime": "2020-01-01 00:00:00", "serverName": "test-server-name", "custName": "test-server-name", "displayName": "test-display-name", "publicIp": "192.168.1.1", "privateIp": "192.168.1.1", "extInfo": {"key": ""}, "enterpriseProjectId": "", "enterpriseProjectName": ""}], "pageNum": 1, "pageSize": 10}}
状态码
请参考 状态码
错误码
请参考 错误码
