You need to enable JavaScript to run this app.
导航
DescribeHaVips
最近更新时间:2024.09.06 08:11:09首次发布时间:2022.03.01 09:03:59

调用 DescribeHaVips 接口,查询满足指定条件的高可用虚拟IP(HAVIP)。

说明

高可用虚拟IP正在邀测中,暂仅支持完成 企业认证 的账号申请试用,如需试用,请联系客户经理。

调用说明

  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的HAVIP,若没有符合条件的HAVIP,则返回空值。

  • 若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有HAVIP。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeHaVips要执行的操作,取值:DescribeHaVips。
VersionString2020-04-01API版本信息,取值为:2020-04-01。

VpcId

string

vpc-bp1s5fnvk4gn2tws03****

HAVIP所属私有网络的ID。
您可以调用 DescribeVpcs 接口,查询VPC的ID。

SubnetId

String

subnet-bp1s5fnvk4gn2tws03****

HAVIP所属子网的ID。
您可以调用 DescribeSubnets 接口,查询子网的ID。

IpAddressString192.XX.XX.10HAVIP的IP地址。

HaVipIds.N

String

HaVipIds.1=havip-2zeo05qre24nhrqpy****&HaVipIds.2=havip-38skshdajs223****

HAVIP的ID。

  • 参数 - N:表示HAVIP的ID序号,单次调用数量上限100个。
  • 多个HAVIP的ID之间用&分隔。
HaVipNamestringhavip-test-nameHAVIP的名称。

Status

String

Available

HAVIP的状态。

  • Available:可用
  • Creating:创建中
  • InUse:使用中
  • Deleting:删除中
ProjectNameStringProject-1HAVIP的项目名称。

TagFilters.N.Key

String

TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3

标签的标签键。

  • 参数 - N:表示标签键的序号,取值范围:1~10。
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的HAVIP。
  • 不允许重复。

TagFilters.N.Values.N

String

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1

标签的标签值。

  • 第一个N:表示标签键的序号,取值范围:1~10。
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的HAVIP。
  • 多个标签值之间用&分隔。

说明

  • 若传入该参数,则必须先传入TagFilters.N.Key
  • 传入空字符串时,表示查询标签值为空的HAVIP。

PageNumber

Integer

1

列表的页码。默认值为1。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

20

分页查询时每页的行数。最大值为100,默认值为20。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

分页查询凭证,用于标记分页的位置。

  • 不填则从头开始查询。
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。
MaxResultsInteger50查询的数量,默认为 10,最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

符合条件的HAVIP总数。

说明

本参数即将下线,使用NextTokenMaxResults分页查询时,此参数无意义。

PageNumber

Integer

1

当前页码。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

10

当前分页的行数。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。

HaVipsArray of Struct-HAVIP的详细信息。具体请参见下表“HaVips结构”。

HaVips结构

参数名称
类型
示例值
描述
CreatedAtString2021-08-05T21:46:55+08:00创建HAVIP的时间。
UpdatedAtString2021-08-05T21:48:55+08:00更新HAVIP的时间。
AccountIdString200000****HAVIP所属账号的ID。
StatusStringAvailableHAVIP的状态。
DescriptionStringtest havipHAVIP的描述信息。
HaVipIdStringhavip-273whz6qg3k7fap8tw****HAVIP的ID。
HaVipNameStringhavip-test-nameHAVIP的名称。
IPAddressString10.XX.XX.20HAVIP的IP地址。
MasterInstanceIdStringi-sad5kl1we****与HAVIP绑定的主实例的ID。
VpcIdStringvpc-274dzjk74o0e87fap8u****HAVIP所属私有网络的ID。
SubnetIdStringsubnet-274dzk7vi0o3k7fap8sp****HAVIP所属子网的ID。

AssociatedInstanceType

String

EcsInstance

绑定HAVIP的实例类型。

  • EcsInstance:云服务器实例
  • NetworkInterface:弹性网卡
AssociatedInstanceIdsArray["i-sad5kl1we****","i-pua1ksl2e****"]绑定HAVIP的实例ID列表。
AssociatedEipIdStringeip-2ziwb7ujxscd*****HAVIP绑定的公网IP的ID。
AssociatedEipAddressString132.XX.XX.45HAVIP绑定的公网IP的IP地址。
ProjectNameStringProject-1HAVIP的项目名称。
TagsArray of Struct-高可用虚拟IP的标签信息。具体请参见下表“Tag结构”。

Tag结构

参数名称
类型
示例值
描述
KeyStringk1标签的标签键。
ValueStringv1标签的标签值。

请求示例

GET /?Action=DescribeHaVips&Version=2020-04-01&VpcId=vpc-bp1s5fnvk4gn2tws03**** HTTP/1.1
Host: open.volcengineapi.com 
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E****",
        "Action": "DescribeHaVips",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "HaVips": [
            {
                "CreatedAt": "2021-08-05T21:46:55+08:00",
                "UpdatedAt": "2021-08-05T21:48:55+08:00",
                "AccountId": "200000****",
                "Status": "Available",
                "Description": "test havip",
                "HaVipId": "havip-273whz6qg3k7fap8tw****",
                "HaVipName": "havip-test-name",
                "IpAddress": "10.XX.XX.20",
                "MasterInstanceId": "eni-273whz8pqai2o7fap8t6****",
                "VpcId": "vpc-274dzjk74o0e87fap8ul****",
                "SubnetId": "subnet-274dzk7vi0o3k7fap8sp****",
                "AssociatedInstanceType": "EcsInstance",
                "AssociatedInstanceIds": [
                    "i-sad5kl1we*****",
                    "i-pua1ksl2e*****"
                ],
                "AssociatedEipId": "eip-2ziwb7ujxscd*****",
                "AssociatedEipAddress": "132.XX.XX.45",
                "ProjectName": "Project-1",
                "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    }
                ]   
            }                    
        ]
    }
}

错误码

此处仅展示当前API的错误码,更多错误码请参见公共错误码

HttpCode
错误码
错误信息
描述
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.HaVipIdYou've reached the limit on the number of HaVip IDs that you can describe.已达到可查询的高可用虚拟IP ID数量上限。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
404InvalidVpc.NotFoundThe specified VPC does not exist.指定的VPC不存在。
404InvalidSubnet.NotFoundThe specified subnet does not exist.指定的子网不存在。