すべてのプロダクト
Search

このプロダクト

    ENS:DescribeHaVips

    ドキュメントセンター

    ENS:DescribeHaVips

    最終更新日:Mar 20, 2026

    高可用性仮想 IP アドレス（HaVip）を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ens:DescribeHaVips

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    NetworkId

    string

    任意

    ネットワークの ID です。

    n-57gqcdfvx6n****
    VSwitchId

    string

    任意

    vSwitch の 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

    任意

    エッジノードの ID です。1～100 個まで指定できます。

    string

    任意

    エッジノードの ID です。

    cn-chengdu-telecom-4
    PageNumber

    string

    任意

    ページ番号です。

    1
    PageSize

    string

    任意

    1 ページあたりの表示件数です。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマです。

    RequestId

    string

    リクエスト ID です。

    AAE90880-4970-4D81-A534-A6C0F3631F74
    TotalCount

    string

    返された合計件数です。

    49
    PageSize

    string

    1 ページあたりの表示件数です。

    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

    リージョンの ID です。

    cn-guiyang-14
    NetworkId

    string

    ネットワークの ID です。

    n-5wtkyrk****
    VSwitchId

    string

    vSwitch の ID です。

    vsw-5yc8d****
    IpAddress

    string

    HaVip の IP アドレスです。

    192.XX.XX.5

    AssociatedEipAddresses

    array<object>

    HaVip に関連付けられた弾力的 IP アドレス（EIP）です。

    object

    HaVip に関連付けられた EIP です。

    EipId

    string

    EIP の ID です。

    eip-5p1wz****
    Eip

    string

    EIP です。

    47.XX.XX.40
    AssociatedInstances

    array<object>

    HaVip に関連付けられたインスタンスの情報です。

    object

    HaVip に関連付けられたインスタンスの情報です。

    InstanceId

    string

    インスタンスの ID です。

    i-51p****
    InstanceType

    string

    HaVip に関連付けられたインスタンスのタイプです。有効な値は以下のとおりです。

    • EnsInstance：ENS インスタンス

    • NetworkInterface：弾力的ネットワークインターフェース（ENI）

    EnsInstance
    IpAddress

    string

    HaVip に関連付けられたインスタンスのプライベート IP アドレスです。有効な値は以下のとおりです。

    192.XX.XX.9
    Status

    string

    HaVip の関連付けステータスです。有効な値は以下のとおりです。

    • Associating

    • InUse

    • Unassociating

    InUse
    CreationTime

    string

    インスタンスの作成時刻です。

    2023-01-05T07:09:28Z

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。