获取高可用虚拟IP的后端实例列表
更新时间：2022-11-10
接口描述
本接口用来获取指定高可用虚拟IP（HAVIP）的后端实例列表信息。
请求结构
GET /v1/vpc/havip/{haVipId}/instance/list{?vpcId,instanceType,isBound,keyword,keywordType,order,orderBy,pageNo,pageSize} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| haVipId | String | 是 | Path参数 | HAVIP ID |
| pageNo | Integer | 否 | Query参数 | 页号，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 查询返回每页个数，取值范围为1～100，缺省值为100 |
| keywordType | String | 否 | Query参数 | 查询的关键字类型，过滤类型：INTERNAL_IP、NAME，分别代表内网IP，实例名称 |
| keyword | String | 否 | Query参数 | 查询的关键字值 |
| instanceType | String | 是 | Query参数 | 实例类型，值为SERVER |
| vpcId | String | 否 | Query参数 | 所属VPC ID |
| isBound | Boolean | 否 | Query参数 | 实例绑定状态, true为已绑定实例，false为可绑定实例 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<BackendDetailVo> | HAVIP后端对象列表 |
| orderBy | String | 排序字段，缺省为createTime |
| order | String | 排序顺序,取值为DESC、ASC，分别表示为降序、升序。缺省为DESC |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
请求示例
GET /v1/vpc/havip/havip-mldpfkonbqoq/instance/list?vpcId=vpc-1fd9vkmlo7mh&isBound=true HTTP/1.1
Host: bec.baidubce.com
ContentType: application/json
Authorization: authorization string 返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
Date: Thu, 16 Mar 2021 06:29:48 GMT
Content Type: application/json;charset=UTF 8
Server: BWS
{
"result": [
{
"createTime": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"instanceId": "",
"instanceType": "",
"internalIp": "",
"isMaster": true,
"multiplePublicIp": [
{
"ip": "",
"serviceProvider": ""
}
],
"name": "",
"publicIp": "",
"regionId": "",
"status": "",
"subnetId": ""
}
],
"orders": null,
"orderBy": "createTime",
"order": "desc",
"pageNo": 1,
"pageSize": 1000,
"totalCount": 1
}错误码
请参照错误返回章节的内容。
Model对象定义
BackendDetailVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 后端实例ID |
| name | String | 后端实例名称 |
| instanceType | String | 后端类型，云主机为SERVER |
| subnetId | String | 所属子网 ID |
| regionId | String | 所属节点ID |
| internalIp | String | 内网IP地址 |
| publicIp | String | 公网IP地址，instanceType=SERVER且节点为单线节点时返回 |
| multiplePublicIp | List<IpInfo> | 公网IP地址，instanceType=SERVER且节点为三线节点时返回 |
| status | String | 云主机实例状态 |
| isMaster | Boolean | 是否为主服务器, true为是；false为否 |
| createTime | String | 创建时间（UTC） |
IpInfo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ip | String | 公网IP地址 |
| serviceProvider | String | 运营商，可用值:BGP,CHINA_MOBILE,CHINA_UNICOM,CHINA_TELECOM,TRIPLE_LINE,INTRA |