すべてのプロダクト
Search

このプロダクト

    Virtual Private Cloud:DescribeHaVips

    ドキュメントセンター

    Virtual Private Cloud:DescribeHaVips

    最終更新日:Apr 27, 2026

    指定されたリージョン内の HaVip をクエリします。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    HaVip のリージョン ID です。

    最新のリージョン一覧を取得するには、DescribeRegions 操作を呼び出してください。

    cn-hangzhou
    PageNumber

    integer

    任意

    返されるページの番号です。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数です。最大値は 50、デフォルト値は 10 です。

    10
    Filter

    array<object>

    任意

    フィルター条件の詳細です。

    object

    任意

    Key

    string

    任意

    フィルターキーです。最大で 5 つのフィルターキーを指定できます。N の有効値は 1 ～ 5 です。以下のフィルターキーがサポートされています。

    • VpcId：仮想プライベートクラウド (VPC) ID

    • VSwitchId：vSwitch ID

    • Status：HaVip のステータス

    • HaVipId：HaVip ID

    • HaVipAddress：HaVip の IP アドレス

    各フィルターキーに対して複数の値を指定できます。複数の値間の論理演算子は OR です。いずれかの値に一致すれば、そのフィルターキーは一致したものとみなされます。

    複数のフィルターキー間の論理演算子は AND です。すべてのフィルターキーが一致した場合のみ、HaVip をクエリできます。

    HaVipId
    Value

    array

    任意

    フィルターキーの値です。N の有効値は 1 ～ 5 です。

    havip-bp19o63nequs01i8d****

    string

    任意

    フィルターキーに対するフィルター値です。1 つのキーに対して複数のフィルター値を指定できます。フィルター値間の論理演算子は OR です。いずれかのフィルター値に一致すれば、そのフィルターキーは一致したものとみなされます。

    Active
    ResourceGroupId

    string

    任意

    HaVip が属するリソースグループの ID です。

    rg-bp67acfmxazb4ph****
    Tags

    array<object>

    任意

    タグリストです。

    object

    任意

    Key

    string

    任意

    リソースに追加するタグ N のキーです。最大で 20 個のタグキーを指定できます。タグキーは空文字列にできません。

    タグキーの長さは最大 128 文字です。aliyun または acs: で始まってはならず、http:// または https:// を含んではいけません。

    FinanceDept
    Value

    string

    任意

    リソースに追加するタグ N の値です。最大で 20 個のタグ値を指定できます。タグ値は空文字列にできます。

    タグ値の長さは最大 128 文字です。http:// または https:// を含んではいけません。また、aliyun または acs: で始まってはなりません。

    FinanceJoshua

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    1 ページあたりのエントリ数です。

    PageSize

    integer

    1 ページあたりのエントリ数です。

    10
    RequestId

    string

    リクエスト ID です。

    33E480C5-B46F-4CA5-B6FD-D77C746E86AB
    PageNumber

    integer

    ページ番号です。

    1
    TotalCount

    integer

    返されたエントリの数です。

    1
    HaVips

    object

    HaVip

    array<object>

    HaVip の詳細情報です。

    array<object>

    VpcId

    string

    HaVip が属する VPC の ID です。

    vpc-bp1kcm36tevkpms97****
    Status

    string

    HaVip のステータスです。有効値は次のとおりです。

    • Creating：サーバーグループを作成中です。

    • Available：FULLNAT エントリが利用可能です。

    • Deleting

    Available
    HaVipId

    string

    HaVip の ID です。

    havip-bp149uyvut73dpld****
    AssociatedInstanceType

    string

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

    • EcsInstance：Elastic Compute Service (ECS) インスタンス

    • NetworkInterface：イーサネットネットワークインターフェース (ENI)

    EcsInstance
    CreateTime

    string

    HaVip の作成時刻です。

    2021-07-03T14:25:26Z
    ChargeType

    string

    このパラメーターは無効です。値は返されません。

    none
    RegionId

    string

    HaVip が属するリージョンの ID です。

    cn-hangzhou
    VSwitchId

    string

    HaVip が属する vSwitch の 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

    リソースに追加されたタグ N のキーです。

    FinanceDept
    Value

    string

    リソースに追加されたタグ N の値です。

    FinanceJoshua

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    エラーメッセージ

    説明
    400 Forbidden.HaVip No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.
    400 InvalidRegionId.NotFound The RegionId provided does not exist in our records.
    400 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key

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

    変更履歴

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