接口功能介绍
展示待绑定服务器列表。
接口约束
已经签约安全卫士服务协议
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}
状态码
请参考 状态码
错误码
请参考 错误码
