服務器詳情
更新時間 2025-01-16 10:32:07
最近更新時間: 2025-01-16 10:32:07
分享文章
接口功能介紹
獲取服務器詳細信息。
接口約束
已經簽約安全衛士服務協議
URI
GET /v1/host/detail/*
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| agentGuid | 是 | String | 計算機agentGuid | aba2f4cd-3161-4251-a382-8dc7866f0d4d |
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 資源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 請求地址類型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 200-成功 | ||
| error | String | 返回碼CTCSSCN_000000 :成功;CTCSSCN_000001:失敗;CTCSSCN_000003：用戶未簽署協議，安全衛士系統無法正常使用;CTCSSCN_000004：鑒權錯誤;CTCSSCN_000005：用戶沒有付費版配額，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回對象 | map |
表 map
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| custName | String | 名稱 | ecm-waf-lvs | |
| agentGuid | String | UUID | F091C368-4ED9-4F18-8D48-06610CB5D4FC | |
| regionName | String | 地區名稱 | 北京5 | |
| publicIp | String | 公網IP | 10.104.1.226 | |
| ipAddress | String | 內網IP | 10.104.1.228 | |
| azName | String | 所在AZ | az名稱 | |
| statusName | String | 防護狀態，防護中|已離線|未防護|已關閉 | 已離線 | |
| createDate | String | 創建時間 | Tue Aug 16 11:34:04 CST 2022 | |
| expireDate | String | 過期時間 | Mon Aug 16 11:34:04 CST 2027 | |
| osType | String | 操作系統 | Linux |
枚舉參數
無
請求示例
請求url
無
請求頭header
{
"regionid": "100054c0416811e9a6690242ac110002",
"Content-Type":"application/json",
"urlType": "CTAPI"
}
請求體body
無
響應示例
{
"statusCode": "200",
"error": "CTCSSCN_000000",
"message": "查詢成功!",
"returnObj":{
"custName": "ecm-waf-lvs",
"agentGuid": "F091C368-4ED9-4F18-8D48-06610CB5D4FC",
"azName": null,
"publicIp": "",
"ipAddress": "10.104.1.226",
"regionName": "北京5",
"stateName": "防護中",
"createDate": "Tue Aug 16 11:34:04 CST 2022",
"expireDate": "Mon Aug 16 11:34:04 CST 2027",
"osType": "linux"
},
"success": false
}
狀態碼
請參考
錯誤碼
請參考
