配額列表查詢
更新時間 2025-04-30 15:52:40
最近更新時間: 2025-04-30 15:52:40
分享文章
接口功能介紹
服務器安全衛士系統,防護配額列表查詢
接口約束
已經簽約安全衛士服務協議
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}}
狀態碼
請參考
錯誤碼
請參考