DescribeHaVips - 查詢地區內的高可用虛擬IP（HaVip） - Virtual Private Cloud

調用DescribeHaVips介面查詢指定地區內的高可用虛擬IP（HaVip）。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	HaVip 所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
PageNumber	integer	否	列表的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁的行數，最大值為 50。預設值為 10。	10
Filter	array<object>	否	過濾條件詳細資料。
	object	否	過濾條件詳細資料。
Key	string	否	過濾條件，最多可支援 5 個過濾條件。N 的取值範圍為1~5。支援的過濾條件如下： VpcId：專用網路 ID。 VSwitchId：交換器 ID。 Status：HaVip 的狀態。 HaVipId：HaVip 的 ID。 HaVipAddress：HaVip 的 IP 位址。每個過濾條件（Filter Key）可以過濾多個值，每個值之間為“或”關係，只要有其中一個值符合則視為符合參數的過濾條件。各個過濾條件（Filter Key）之間為“與”關係，必須符合所有參數的過濾條件，才能被查詢出來。	HaVipId
Value	array	否	指定的過濾條件對應的值。N 的取值範圍為1~5。	havip-bp19o63nequs01i8d****
	string	否	根據過濾條件指定過濾值。一個過濾條件支援指定多個過濾值，每個過濾值之間是“或”的關係，即只要符合其中一個過濾值，則視為匹配該過濾條件。	Active
ResourceGroupId	string	否	HaVip 所屬的資源群組 ID。	rg-bp67acfmxazb4ph****
Tags	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	object	每頁包含的條目數。
PageSize	integer	每頁包含的條目數。	10
RequestId	string	請求 ID。	33E480C5-B46F-4CA5-B6FD-D77C746E86AB
PageNumber	integer	當前頁碼。	1
TotalCount	integer	列表條目數。	1
HaVips	object
HaVip	array<object>	HaVip 的詳細資料。
	array<object>	HaVip 的詳細資料。
VpcId	string	HaVip 所屬的 VPC ID。	vpc-bp1kcm36tevkpms97****
Status	string	HaVip 的狀態。取值： Creating：建立中。 Available：可用。 Deleting：刪除中。	Available
HaVipId	string	HaVip 的 ID。	havip-bp149uyvut73dpld****
AssociatedInstanceType	string	與 HaVip 綁定的執行個體類型。取值： EcsInstance：Elastic Compute Service 執行個體。 NetworkInterface：彈性網卡執行個體。	EcsInstance
CreateTime	string	HaVip 的建立時間。	2021-07-03T14:25:26Z
ChargeType	string	該參數為無效參數，傳回值為空白。	none
RegionId	string	HaVip 所屬的地區 ID。	cn-hangzhou
VSwitchId	string	HaVip 所屬的交換器 ID。	vsw-bp1pkt1fba8e824ez****
IpAddress	string	HaVip 的私網 IP 位址。	192.168.24.5
Description	string	HaVip 的描述。	My HaVip
MasterInstanceId	string	與 HaVip 綁定的主執行個體 ID。	i-bp145q7glnuzdvz****
Name	string	HaVip 的名稱。	test
AssociatedEipAddresses	object
associatedEipAddresse	array	與 HaVip 綁定的 EIP 列表。
	string	與 HaVip 綁定的 EIP。	121.12.XX.XX
AssociatedInstances	object
associatedInstance	array	與 HaVip 綁定的執行個體資訊。
	string	與 HaVip 綁定的執行個體 ID。	i-bp145q7glnuzdvzu21****
ResourceGroupId	string	HaVip 所屬的資源群組 ID。	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "33E480C5-B46F-4CA5-B6FD-D77C746E86AB",
  "PageNumber": 1,
  "TotalCount": 1,
  "HaVips": {
    "HaVip": [
      {
        "VpcId": "vpc-bp1kcm36tevkpms97****",
        "Status": "Available",
        "HaVipId": "havip-bp149uyvut73dpld****",
        "AssociatedInstanceType": "EcsInstance",
        "CreateTime": "2021-07-03T14:25:26Z",
        "ChargeType": "none",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1pkt1fba8e824ez****",
        "IpAddress": "192.168.24.5",
        "Description": "My HaVip",
        "MasterInstanceId": "i-bp145q7glnuzdvz****",
        "Name": "test",
        "AssociatedEipAddresses": {
          "associatedEipAddresse": [
            "121.12.XX.XX"
          ]
        },
        "AssociatedInstances": {
          "associatedInstance": [
            "i-bp145q7glnuzdvzu21****"
          ]
        },
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	操作HaVip沒有許可權，請到配額中心申請許可權。
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
400	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。