接口功能介绍
防护配额列表查询
接口约束
此功能为收费功能。确认已经购买网页防篡改配额,并且开启防篡改扫描配置。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护
URI
POST /v1/tamperproof/quota/query//
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
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 | |
orderField | 否 | String | 排序字段: 开通时间:create_time(默认) 到期时间:expiration_date 配额状态(或使用状态):quota_status |
||
orderType | 否 | String | 排序类型: asc:升序(默认) desc:降序 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | |
serverName | String | 服务器名称 | CentOS76-az1-2 | |
quotaStatus | String | 配额状态: 1:未绑定(正常) 2:使用中(正常) 4:已到期 8:已冻结 16:已退订 32:已销毁) |
F5283205-CB2C-45E6-8629-9D5DB63D3AC3 | |
serverIp | String | 服务器ip | 172.18.208.172 | |
guid | String | 服务器ID | ||
expirationDate | String | 配额到期时间 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"serverIp": "163.0.0.2",}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"total":30,"list":[{"id":30,"quotaId":"05d87f69ac884ec98665289bba3a7e77","zoneId":"100054c0416811e9a6690242ac110002","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T07:05:10.000+00:00","expirationDate":"2023-03-27T07:05:10.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T07:05:42.000+00:00","updateTime":"2022-08-29T07:05:42.000+00:00"},{"id":29,"quotaId":"a00cfacc638e45ce9e5b6e0b94e2510c","zoneId":"100054c0416811e9a6690242ac110002","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T07:05:09.000+00:00","expirationDate":"2023-03-27T07:05:09.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T07:05:42.000+00:00","updateTime":"2022-08-29T07:05:42.000+00:00"},{"id":28,"quotaId":"ea890189dcb2477a974858547fc8ba92","zoneId":"100054c0416811e9a6690242ac110002","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T07:05:10.000+00:00","expirationDate":"2023-03-27T07:05:10.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T07:05:42.000+00:00","updateTime":"2022-08-29T07:05:42.000+00:00"},{"id":27,"quotaId":"8cf7f2341a664457b2e51160f68c258b","zoneId":"100054c0416811e9a6690242ac110002","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T07:05:09.000+00:00","expirationDate":"2023-03-27T07:05:09.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T07:05:41.000+00:00","updateTime":"2022-08-29T07:05:41.000+00:00"},{"id":26,"quotaId":"27bd6b9aab894e16b66e23734a78aca9","zoneId":"100054c0416811e9a6690242ac110002","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T07:05:09.000+00:00","expirationDate":"2023-03-27T07:05:09.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T07:05:41.000+00:00","updateTime":"2022-08-29T07:05:41.000+00:00"},{"id":25,"quotaId":"3969fa19242d4851aaff95667557ab8b","zoneId":"100054c0416811e9a6690242ac110002","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T07:05:00.000+00:00","expirationDate":"2022-10-27T23:05:00.000+00:00","reloadDate":"2022-08-29T07:05:01.000+00:00","cancelDate":null,"createTime":"2022-08-29T07:05:33.000+00:00","updateTime":"2022-08-29T07:05:33.000+00:00"},{"id":24,"quotaId":"b0d006dcfeb543e3bb7e61549c112b7b","zoneId":"41f64827f25f468595ffa3a5deb5d15d","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T02:12:46.000+00:00","expirationDate":"2023-03-27T02:12:46.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T02:13:19.000+00:00","updateTime":"2022-08-29T02:13:19.000+00:00"},{"id":23,"quotaId":"5ed56a835f234051a03e1fcfa7094a05","zoneId":"41f64827f25f468595ffa3a5deb5d15d","adminId":null,"ctyunUserId":"1","quotaStatus":2,"serverName":"CentOS75","serverIp":"192.168.1.3","guid":"147BF416-D1BC-0114-BC9F-CB512F07443B","startDate":"2022-08-29T02:12:47.000+00:00","expirationDate":"2023-03-27T02:12:47.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T02:13:19.000+00:00","updateTime":"2022-08-30T03:03:22.000+00:00"},{"id":22,"quotaId":"67689b5180054d6ab4439b40680da84a","zoneId":"41f64827f25f468595ffa3a5deb5d15d","adminId":null,"ctyunUserId":"1","quotaStatus":1,"serverName":null,"serverIp":null,"guid":null,"startDate":"2022-08-29T02:12:46.000+00:00","expirationDate":"2023-03-27T02:12:46.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T02:13:18.000+00:00","updateTime":"2022-08-29T02:13:18.000+00:00"},{"id":20,"quotaId":"f44bc279d3c44f9780fb1ee8396f8ff2","zoneId":"41f64827f25f468595ffa3a5deb5d15d","adminId":null,"ctyunUserId":"1","quotaStatus":2,"serverName":"windows2008","serverIp":"192.168.1.6","guid":"EBF69C73-C5A8-D5E2-7BDA-2D064A802CA6","startDate":"2022-08-29T02:12:45.000+00:00","expirationDate":"2023-03-27T02:12:45.000+00:00","reloadDate":null,"cancelDate":null,"createTime":"2022-08-29T02:13:18.000+00:00","updateTime":"2022-08-30T03:06:22.000+00:00"}],"pageNum":1,"pageSize":10,"size":10,"startRow":1,"endRow":10,"pages":3,"prePage":0,"nextPage":2,"isFirstPage":true,"isLastPage":false,"hasPreviousPage":false,"hasNextPage":true,"navigatePages":8,"navigatepageNums":[1,2,3],"navigateFirstPage":1,"navigateLastPage":3}}
状态码
请参考 状态码
错误码
请参考 错误码