GetLoadBalancerAttribute - - Alibaba Cloud ドキュメントセンター

Gateway Load Balancer (GWLB) インスタンスの詳細を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:GetLoadBalancerAttribute

get

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
LoadBalancerId	string	必須	GWLB インスタンスの ID。	gwlb-9njtjmqt7zfcqm****

レスポンスフィールド

フィールド	型	説明	例
	object
AddressIpVersion	string	プロトコルバージョン。有効な値： Ipv4：IPv4。	IPv4
CreateTime	string	リソースが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は UTC で表示されます。	2024-07-08T10:12:58Z
LoadBalancerBusinessStatus	string	GWLB インスタンスのビジネスステータス。有効な値： Normal：正常に実行中 FinancialLocked：支払い遅延によるロック	Normal
LoadBalancerId	string	GWLB インスタンスの ID。	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	GWLB インスタンスの名前。名前は長さが 2～128 文字で、文字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。先頭は文字である必要があります。	gwlb
LoadBalancerStatus	string	GWLB インスタンスのステータス。有効な値： Active：GWLB インスタンスは実行中です。 Inactive：GWLB インスタンスは無効になっています。Inactive 状態の GWLB インスタンスのリスナーはトラフィックを転送しません。 Provisioning：GWLB インスタンスは作成中です。 Configuring：GWLB インスタンスは変更中です。	Active
RequestId	string	リクエスト ID。	B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF
ResourceGroupId	string	リソースグループ ID。	rg-acfmx7pmxcy****
Tags	array<object>	タグ。
	object	タグに関する情報。
Key	string	タグキー。タグキーは空の文字列にできません。タグキーは最大 128 文字です。タグキーの先頭に `aliyun` または `acs:` を使用することはできず、`http://` または `https://` を含めることはできません。	testTagKey
Value	string	タグ値。タグ値は最大 256 文字で、`http://` または `https://` を含めることはできません。	testTagValue
VpcId	string	VPC ID。	vpc-k1aajsbwbaq4todet****
ZoneMappings	array<object>	ゾーンと vSwitch 間のマッピング。少なくとも 1 つのゾーンを指定する必要があります。最大 20 のゾーンを指定できます。リージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを指定してください。
	array<object>	ゾーンと vSwitch に関する情報。
LoadBalancerAddresses	array<object>	GWLB インスタンスのアドレス。
	object	GWLB インスタンスのアドレスに関する詳細。
EniId	string	GWLB インスタンスが使用する Elastic Network Interface (ENI) の ID。	eni-bp1iahwz3rzgvltz****
PrivateIpv4Address	string	プライベート IPv4 アドレス。	192.168.XX.XX
VSwitchId	string	ゾーン内の vSwitch。GWLB インスタンスの各ゾーンで指定できる vSwitch (サブネット) は 1 つだけです。	vsw-uf6v8l7d2f1k53xrl****
ZoneId	string	ゾーン ID。	cn-hangzhou-j
TrafficMode	string	トラフィック処理モード。有効な値： LoadBalance：ロードバランスモード。GWLB はバックエンドサーバーにトラフィックを転送します。 ByPass：バイパスモード。GWLB はトラフィックをバックエンドサーバーに転送せず、GWLB エンドポイントに直接返します。	LoadBalance

例

成功レスポンス

JSONJSON

{
  "AddressIpVersion": "IPv4",
  "CreateTime": "2024-07-08T10:12:58Z",
  "LoadBalancerBusinessStatus": "Normal",
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "LoadBalancerName": "gwlb",
  "LoadBalancerStatus": "Active",
  "RequestId": "B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF",
  "ResourceGroupId": "rg-acfmx7pmxcy****",
  "Tags": [
    {
      "Key": "testTagKey",
      "Value": "testTagValue"
    }
  ],
  "VpcId": "vpc-k1aajsbwbaq4todet****",
  "ZoneMappings": [
    {
      "LoadBalancerAddresses": [
        {
          "EniId": "eni-bp1iahwz3rzgvltz****",
          "PrivateIpv4Address": "192.168.XX.XX"
        }
      ],
      "VSwitchId": "vsw-uf6v8l7d2f1k53xrl****",
      "ZoneId": "cn-hangzhou-j"
    }
  ],
  "TrafficMode": "LoadBalance"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.
400	MissingParam.LoadBalancerId	The param of LoadBalancerId is missing.

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

変更履歴

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