DescribeHaVips - 查询高可用虚拟IP - 边缘节点服务ENS

调用DescribeHaVips接口查询高可用虚拟IP（HaVip）。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeHaVips

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
NetworkId	string	否	网络 ID。	n-57gqcdfvx6n****
VSwitchId	string	否	交换机 ID。	vsw-5****
HaVipId	string	否	HaVip 实例 ID。	havip-5p14t****
HaVipAddress	string	否	HaVip 实例的 IP 地址。	10.5.XX.XX
EnsRegionId	string	否	地域 ID。	cn-beijing-cmcc
Name	string	否	HaVip 实例的名称。	test
Status	string	否	HaVip 状态。取值： Creating：创建中。 Available：可用。 InUse: 使用中。 Deleting：删除中。枚举值： Creating : 创建中 Available : 可用 InUse : 使用中 Deleting : 删除中	Available
EnsRegionIds	array	否	ENS 节点 ID 数组。数组长度：1~100。
	string	否	ENS 节点 ID。	cn-chengdu-telecom-4
PageNumber	string	否	当前页码。	1
PageSize	string	否	分页查询时设置的每页行数。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	AAE90880-4970-4D81-A534-A6C0F3631F74
TotalCount	string	列表数据总数。	49
PageSize	string	每页包含的条目数。	10
PageNumber	string	当前页码。	1
HaVips	array<object>	HaVip 的详细信息。
	array<object>	HaVip 的详细信息。
Status	string	HaVip 状态。取值： Creating：创建中。 Available：可用。 InUse: 使用中。 Deleting：删除中。	Available
CreationTime	string	HaVip 的创建时间，采用 ISO 8601 UTC 时间格式，格式为 YYYY-MM-DDTHH:mm:ssZ。	2023-03-29T11:17:38Z
Description	string	HaVip 实例的描述。	test
HaVipId	string	HaVip 实例 ID。	havip-52y28****
Name	string	HaVip 实例的名称。	test
EnsRegionId	string	ENS 的节点 ID。	cn-guiyang-14
NetworkId	string	网络 ID。	n-5wtkyrk****
VSwitchId	string	交换机 ID。	vsw-5yc8d****
IpAddress	string	HaVip 的 IP 地址。	192.XX.XX.5
AssociatedEipAddresses	array<object>	与 HaVip 绑定的 EIP。
	object	与 HaVip 绑定的 EIP。
EipId	string	EIP 的 ID。	eip-5p1wz****
Eip	string	EIP 的 IP 地址。	47.XX.XX.40
AssociatedInstances	array<object>	与 HaVip 绑定的实例信息。
	object	与 HaVip 绑定的实例信息。
InstanceId	string	实例 ID。	i-51p****
InstanceType	string	要绑定 HaVip 的实例类型，取值： EnsInstance：云服务器 ENS 实例。 NetworkInterface：弹性网卡实例	EnsInstance
IpAddress	string	绑定实例的私网 IP。	192.XX.XX.9
Status	string	HaVip 实例的绑定关系状态。取值： Associating：绑定中。 InUse：可用。 Unassociating：解绑中。	InUse
CreationTime	string	实例绑定的创建时间，采用 ISO 8601 UTC 时间格式，格式为 YYYY-MM-DDTHH:mm:ssZ。	2023-01-05T07:09:28Z

示例

正常返回示例

JSON格式

{
  "RequestId": "AAE90880-4970-4D81-A534-A6C0F3631F74",
  "TotalCount": "49",
  "PageSize": "10",
  "PageNumber": "1",
  "HaVips": [
    {
      "Status": "Available",
      "CreationTime": "2023-03-29T11:17:38Z",
      "Description": "test",
      "HaVipId": "havip-52y28****",
      "Name": "test",
      "EnsRegionId": "cn-guiyang-14",
      "NetworkId": "n-5wtkyrk****",
      "VSwitchId": "vsw-5yc8d****",
      "IpAddress": "192.XX.XX.5\n",
      "AssociatedEipAddresses": [
        {
          "EipId": "eip-5p1wz****",
          "Eip": "47.XX.XX.40"
        }
      ],
      "AssociatedInstances": [
        {
          "InstanceId": "i-51p****",
          "InstanceType": "EnsInstance",
          "IpAddress": "192.XX.XX.9",
          "Status": "InUse",
          "CreationTime": "2023-01-05T07:09:28Z"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	SystemError	Interface call error, please re-match, or contact the product.	接口调用错误,请重新选配
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。