查询VIP列表v3
更新时间 2026-01-22 16:39:07
最近更新时间: 2026-01-22 16:39:07
接口功能介绍
查询VIP列表v3
接口约束
无
URI
GET /v3/vip/describe
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| vipIpAddress | 否 | String | vip地址 | ||
| pageNum | 否 | Integer | 页码，至少1，默认1 | ||
| pageSize | 否 | Integer | 每页数量，最大100，默认10 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| list | Array of Objects | 数据列表 | list | |
| 表 list |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vipOid | String | vip id | ||
| vipIpAddress | String | vip地址 | ||
| vpcOid | String | vpc id | ||
| networkId | String | vpc的uuid | ||
| vpcName | String | vpc名称 | ||
| subnetId | String | 子网uuid | ||
| subnetName | String | 子网名称 | ||
| cidr | String | 子网网段 | ||
| status | Integer | VIP状态，[0：无效，1：有效] |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&vipIpAddress=xxx&pageNum=xxx&pageSize=xxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"vipOid":"vip-xxyrk3utggvmmyeiunfic",
"vipIpAddress":"192.168.1.82",
"vpcOid":"vpc-ks38av7mklcehgu674ead",
"networkId":"86bf2cd6-9e00-4468-83a0-04327b716a07",
"vpcName":"vpc-test-1",
"subnetId":"b6deaadd-0b33-4422-aef0-0dceba639541",
"subnetName":"subnet-test",
"cidr":"192.168.1.0/24",
"status":1
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
