DescribeHaVips --云服务器 ECS(ECS)-阿里云帮助中心

DescribeHaVips

说明

目前该API接口已标记为弃用，推荐使用替代API：Vpc(2016-04-28) - DescribeHaVips。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

vpc:DescribeHaVips

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是
PageNumber	integer	否
PageSize	integer	否
Filter	array<object>	是
	object	否
Key	string	否
Value	array	否
	string	否

返回参数

名称	类型	描述	示例值
	object
PageSize	integer
RequestId	string
PageNumber	integer
TotalCount	integer
HaVips	object
HaVip	array<object>
	array<object>
Status	string
VpcId	string
VSwitchId	string
IpAddress	string
Description	string
HaVipId	string
CreateTime	string
MasterInstanceId	string
RegionId	string
AssociatedEipAddresses	object
associatedEipAddresse	array
	string
AssociatedInstances	object
associatedInstance	array
	string

示例

正常返回示例

JSON格式

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "HaVips": {
    "HaVip": [
      {
        "Status": "",
        "VpcId": "",
        "VSwitchId": "",
        "IpAddress": "",
        "Description": "",
        "HaVipId": "",
        "CreateTime": "",
        "MasterInstanceId": "",
        "RegionId": "",
        "AssociatedEipAddresses": {
          "associatedEipAddresse": [
            ""
          ]
        },
        "AssociatedInstances": {
          "associatedInstance": [
            ""
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	操作HaVip没有权限，请到配额中心申请权限。
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	地域信息错误
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

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

变更历史

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