DescribeHaVips - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

DescribeHaVips

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Vpc(2016-04-28) - DescribeHaVips への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:DescribeHaVips

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョンの ID です。
PageNumber	integer	任意	ページ番号です。デフォルト値：1。
PageSize	integer	任意	ページあたりのエントリ数です。最大値：50。デフォルト値：10。
Filter	array<object>	必須	クエリフィルターです。1～20 個のフィルターを指定できます。
	object	任意	キーと 1 つ以上の値で構成されるフィルターです。
Key	string	任意	フィルターキーです。有効な値： `HaVipId`：高可用性仮想 IP (HAVIP) の ID。 `HaVipName`： HAVIP の名前。 `VpcId`： HAVIP が属する Virtual Private Cloud (VPC) の ID。 `VSwitchId`： HAVIP が属する vSwitch の ID。 `IpAddress`： HAVIP の IP アドレス。 `AssociatedInstanceType`： HAVIP に関連付けられているインスタンスのタイプです。値は `EcsInstance` である必要があります。 `AssociatedInstanceId`： HAVIP に関連付けられているインスタンスの ID。
Value	array	任意	1～20 個の値のリストです。
	string	任意	フィルター値です。

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
PageSize	integer	ページあたりのエントリ数。
RequestId	string	リクエスト ID。
PageNumber	integer	ページ番号。
TotalCount	integer	総エントリ数。
HaVips	object	HaVip の詳細。
HaVip	array<object>	HaVip オブジェクトの配列。
	array<object>
Status	string	HaVip のステータス。有効な値： `Creating`、`Available`、`Associating`、`Unassociating`、`Deleting`、`Deleted`。
VpcId	string	HaVip が属する Virtual Private Cloud (VPC) の ID。
VSwitchId	string	HaVip が属する vSwitch の ID。
IpAddress	string	HaVip のプライベート IP アドレス。
Description	string	HaVip の説明。
HaVipId	string	HaVip の ID。
CreateTime	string	HaVip が作成された時刻。時刻は UTC で、`YYYY-MM-DDThh:mm:ssZ` 形式です。
MasterInstanceId	string	HaVip に関連付けられたマスター ECS インスタンスの ID。
RegionId	string	HaVip が属するリージョンの ID。
AssociatedEipAddresses	object	HaVip に関連付けられた EIP。
associatedEipAddresse	array	関連付けられた EIP の配列。
	string	関連付けられた EIP。
AssociatedInstances	object	HaVip に関連付けられた ECS インスタンス。
associatedInstance	array	関連付けられた ECS インスタンス ID の配列。
	string	関連付けられた ECS インスタンス ID。

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

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

変更履歴

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