待綁定服務器列表
更新時間 2025-04-30 15:53:00
最近更新時間: 2025-04-30 15:53:00
分享文章
接口功能介紹
展示待綁定服務器列表。
接口約束
已經簽約安全衛士服務協議
URI
POST /v1/quota/hostList
路徑參數
無
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 請求地址類型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 當前頁 | 1 | |
| pageSize | 是 | Integer | 每頁條數 | 10 | |
| param | 否 | String | 服務器ip或者名稱 模糊匹配 | test | |
| regionId | 否 | String | 地域ID | 9035c530814611e990660242ac110002 | |
| azName | 否 | String | AZ名稱 | 1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 200-成功 | ||
| error | String | 返回碼 CTCSSCN_000000 :成功; CTCSSCN_000001:失敗; CTCSSCN_000003：用戶未簽署協議，安全衛士系統無法正常使用; CTCSSCN_000004：鑒權錯誤; CTCSSCN_000005：用戶沒有付費版配額，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回對象 | data |
表 data
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Integer | 記錄總數 | 5 | |
| pageSize | Integer | 頁大小 | 10 | |
| pageNum | Integer | 當前頁 | 1 | |
| pages | Integer | 總頁數 | 1 | |
| list | Array of Objects | 服務器列表信息 | serverlist |
表 serverlist
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| agentIp | String | 私網IP | 172.31.0.71 | |
| custName | String | 服務器名稱 | vm-1634888455-0003 | |
| quotaVersion | Integer | 配額版本 1：基礎版 2：企業版 |
2 |
枚舉參數
無
請求示例
請求url
無
請求頭header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
請求體body
{"currentPage":1,"pageSize":10,"agentGuidList":["2E76B306-DCA5-4B47-86E5-99207A16F4C01","F0111FE1-A07A-1B03-3B1D-2BDD3064D149","80A48180-5C45-2AB9-EEE9-1EFE99E34D6E"]}
響應示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查詢成功!","returnObj":{"total": 3,"list": [{"agentGuid": "2E76B306-DCA5-4B47-86E5-99207A16F4C01","publicIp": "0.0.0.0","agentIp": "192.168.0.18","custName": "win2012-az1-2","unHandle": 0,"hostNum": 0,"quotaVersion": 1,"quotaId": null,"expirationDate": null},{"agentGuid": "80A48180-5C45-2AB9-EEE9-1EFE99E34D6E","publicIp": null,"agentIp": "192.168.2.3","custName": "CentOS81-az2-1","unHandle": 0,"hostNum": 0,"quotaVersion": 1,"quotaId": null,"expirationDate": null},{"agentGuid": "F0111FE1-A07A-1B03-3B1D-2BDD3064D149","publicIp": null,"agentIp": "192.168.0.17","custName": "CentOS76-az1-2","unHandle": 0,"hostNum": 0,"quotaVersion": 1,"quotaId": null,"expirationDate": null}],"pageNum": 1,"pageSize": 10,"size": 0,"startRow": 0,"endRow": 0,"pages": 0,"prePage": 0,"nextPage": 0,"isFirstPage": false,"isLastPage": false,"hasPreviousPage": false,"hasNextPage": false,"navigatePages": 0,"navigatepageNums": null,"navigateFirstPage": 0,"navigateLastPage": 0},"success": false}
狀態碼
請參考
錯誤碼
請參考
