接口功能介绍
绑定了企业版配额的自选服务器列表
接口约束
此功能为收费功能。确认已经购买系统配额,并且开启服务器防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护。
URI
POST /v1/quota/quotaHosts
路径参数
无
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 | param为服务器名称或ip,允许任意字符或数字,也可以为空。1-服务器名称 2-服务器ip 5-agentGuid | cust | |
azName | 否 | String | AZ名称;azName包含数字、字母和特殊符号 | 1 | |
regionId | 否 | String | 区域ID | 9035c530814611e990660242ac110002 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | 总记录数 | 100 | |
pageNum | Integer | 页码 | 1 | |
pageSize | Integer | 页大小 | 10 | |
list | Array of Objects | 服务器列表信息 | serverlist | |
pages | Integer | 总页数 | 1 |
表 serverlist
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
agentGuid | String | AgentGuid | 2F828AAE-55BF-410D-B393-C053AC8742F4 | |
custName | String | 服务器名称 | vm-1634888455-0003 | |
agentIp | String | 私网IP | 172.31.0.71 | |
status | Integer | 服务器状态,开机中,重启中,升级中,已关机,运行中,重建中,错误,已冻结,已到期,删除中,关机中 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"currentPage":1,"pageSize":10,"param":"192.168.0.97","paramType":"2"}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": {"total": 1,"list": [{"agentGuid": "1DA7B4D3-70BA-4038-B161-A90C7BF74DE1","custName": "P-96b7-gOMI","agentIp": "192.168.0.97","status": "运行中"}],"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}}
状态码
请参考 状态码
错误码
请参考 错误码