查詢Az信息
更新時間 2025-07-09 15:26:53
最近更新時間: 2025-07-09 15:26:53
分享文章
接口功能介紹
自選服務器列表
接口約束
原生版服務器安全衛士可用
URI
POST /v1/host/page
路徑參數
無
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json | |
| regionid | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 否 | String | 請求地址類型。EOPAPI（默認），CTAPI，API | EOPAPI |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| currentPage | 是 | Integer | 當前頁 | 1 | |
| pageSize | 是 | Integer | 每頁條數 | 10 | |
| paramType | 否 | Integer | 1. 服務器名稱；2.服務器ip; 5 agent_guid | 1 | |
| param | 否 | String | 具體搜索內容（與paramType同時使用） | 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 | 返回對象 | map |
表 map
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Integer | 記錄總數 | 5 | |
| pageSize | Integer | 頁大小 | 10 | |
| pageNum | Integer | 當前頁 | 1 | |
| pages | Integer | 總頁數 | 1 | |
| list | Array of Strings | 服務器列表信息 | serverlist |
表 serverlist
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| agentIp | String | 私網IP | 172.31.0.71 | |
| custName | String | 服務器名稱 | vm-1634888455-0003 | |
| agentGuid | String | agentGuid | 2F828AAE-55BF-410D-B393-C053AC8742F4 | |
| status | Integer | 服務器狀態，開機中,重啟中,升級中,已關機,運行中,重建中,錯誤,已凍結,已到期,刪除中,關機中 | 1 |
枚舉參數
無
請求示例
請求url
無
請求頭header
{
"regionid": "100054c0416811e9a6690242ac110002",
"Content-Type":"application/json",
"urlType": "CTAPI"
}
請求體body
{
"currentPage":1,
"pageSize":3,
"regionId":"6019b5007a0b11eab5db0242ac110002"
}
響應示例
{
"statusCode": "200",
"error": "CTCSSCN_000000",
"message": "查詢成功!",
"returnObj":{
"total": 11,
"list": [
{
"agentGuid": "A7811C7A-B3C8-4B80-A5A4-4B8566D2EC00",
"custName": "ecm-1c9b-0006",
"agentIp": "172.31.0.48",
"status": "運行中"
},
{
"agentGuid": "B6DD07FC-1E82-430E-8490-1612839A0A01",
"custName": "ecm-1c9b-0008",
"agentIp": "172.31.0.120",
"status": "運行中"
},
{
"agentGuid": "16C0346A-B5FA-4B05-B823-476D228533E3",
"custName": "ecm-1c9b-0009",
"agentIp": "172.31.0.62",
"status": "運行中"
}
],
"pageNum": 1,
"pageSize": 3,
"size": 0,
"startRow": 0,
"endRow": 0,
"pages": 4,
"prePage": 0,
"nextPage": 0,
"isFirstPage": false,
"isLastPage": false,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 0,
"navigatepageNums": null,
"navigateFirstPage": 0,
"navigateLastPage": 0
}
}
狀態碼
請參考
錯誤碼
請參考
