调用DescribeHaVips接口查询指定地域内的高可用虚拟IP(HaVip)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeHaVips |
要执行的操作,取值:DescribeHaVips。 |
RegionId | String | 是 | cn-hangzhou |
HaVip实例所在的地域。 您可以通过调用DescribeRegions接口获取地域ID。 |
PageNumber | Integer | 否 | 1 |
列表的页码,默认值为1。 |
PageSize | Integer | 否 | 10 |
分页查询时每页的行数,最大值为50,默认值为10。 |
Filter.N.Key | String | 否 | HaVipId.havip-bp149uyvut73dpldu**** |
过滤条件,最多可提供5个过滤条件。n的取值范围为1~5。 每个过滤条件(filter key)可以提供多个值,多个值之间是“or”关系,即只要与其中一个值符合则视为符合参数的过滤条件。 各个过滤条件(filter key)之间为“and”关系,即符合所有参数的过滤条件,才会被查询出来。 支持的过滤条件如下:
|
Filter.N.Value.N | RepeatList | 否 | 1 |
指定的过滤条件对应的值。n的取值范围为1~5。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HaVips | Array of HaVip |
HaVip的详细信息。 |
|
HaVip | |||
AssociatedEipAddresses | List | 121.xx.xx.12 |
与HaVip绑定的EIP。 |
AssociatedInstances | List | i-bp145q7glnuzdvzu21xxxx |
与HaVip绑定的ECS实例。 |
ChargeType | String | none |
该参数为无效参数,返回值为空。 |
CreateTime | String | 2018-07-03T14:25:26Z |
HaVip的创建时间。 |
Description | String | My HaVip |
HaVip实例的描述。 |
HaVipId | String | havip-bp149uyvut73dpld**** |
HaVip实例ID。 |
IpAddress | String | 192.xx.xx.27 |
HaVip的私网IP地址。 |
MasterInstanceId | String | i-bp145q7glnuzdvz**** |
与HaVip绑定的主实例ID。 |
Name | String | test |
HaVip实例的名称。 |
RegionId | String | cn-hangzhou |
HaVip实例所属的地域。 |
Status | String | Available |
HaVip实例的状态。 |
VSwitchId | String | vsw-bp1pkt1fba8e824ez**** |
HaVip实例所属的交换机ID。 |
VpcId | String | vpc-bp1kcm36tevkpms97**** |
HaVip实例所属的VPC ID。 |
PageNumber | Integer | 1 |
当前页码。 |
PageSize | Integer | 10 |
每页包含的条目数。 |
RequestId | String | 33E480C5-B46F-4CA5-B6FD-D77C746E86AB |
请求ID。 |
TotalCount | Integer | 1 |
列表条目数。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeHaVips
&RegionId=cn-hangzhou
&Filter=HaVipId.havip-bp149uyvut73dplduo****
&公共请求参数
正常返回示例
XML
格式
<DescribeHaVipsResponse>
<TotalCount>1</TotalCount>
<HaVips>
<HaVip>
<Status>InUse</Status>
<Description></Description>
<AssociatedEipAddresses>
<associatedEipAddresse>eip-hp35ldsrvfj8whxi5****</associatedEipAddresse>
</AssociatedEipAddresses>
<VSwitchId>vsw-hp3izinkr3z9xmpfm****</VSwitchId>
<CreateTime>2020-08-17T07:49:31Z</CreateTime>
<HaVipId>havip-hp34cvmp99ccxi89k****</HaVipId>
<Name></Name>
<AssociatedInstances>
<associatedInstance>i-hp3i6071qw5usdnh****</associatedInstance>
<associatedInstance>i-hp3aoqzkbkk2yi6n****</associatedInstance>
</AssociatedInstances>
<VpcId>vpc-hp3usj8308rws2r4w****</VpcId>
<MasterInstanceId>i-hp3i6071qw5usdnh****</MasterInstanceId>
<ChargeType></ChargeType>
<IpAddress>192.xx.xx.88</IpAddress>
<RegionId>cn-huhehaote</RegionId>
</HaVip>
</HaVips>
<PageSize>10</PageSize>
<RequestId>F3B026B9-7EB7-4FE2-8AA7-D7A394C24259</RequestId>
<PageNumber>1</PageNumber>
</DescribeHaVipsResponse>
JSON
格式
{
"TotalCount": 1,
"HaVips": {
"HaVip": [
{
"Status": "InUse",
"Description": "",
"AssociatedEipAddresses": {
"associatedEipAddresse": [
"eip-hp35ldsrvfj8whxi5****"
]
},
"VSwitchId": "vsw-hp3izinkr3z9xmpfm****",
"CreateTime": "2020-08-17T07:49:31Z",
"HaVipId": "havip-hp34cvmp99ccxi89k****",
"Name": "",
"AssociatedInstances": {
"associatedInstance": [
"i-hp3i6071qw5usdnh****",
"i-hp3aoqzkbkk2yi6n****"
]
},
"VpcId": "vpc-hp3usj8308rws2r4w****",
"MasterInstanceId": "i-hp3i6071qw5usdnh****",
"ChargeType": "",
"IpAddress": "192.xx.xx.88",
"RegionId": "cn-huhehaote"
}
]
},
"PageSize": 10,
"RequestId": "F3B026B9-7EB7-4FE2-8AA7-D7A394C24259",
"PageNumber": 1
}
在文档使用中是否遇到以下问题
更多建议
匿名提交