接口功能介绍
自选服务器列表
接口约束
原生版服务器安全卫士可用
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
}
}
状态码
请参考 状态码
错误码
请参考 错误码
