調用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	否	網路識別碼。	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：刪除中。	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 的建立時間。	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	網路識別碼。	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	執行個體綁定的建立時間。	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.

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

變更歷史

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