DescribeLoadBalancerAttribute による Classic Load Balancer インスタンスの詳細クエリ - Server Load Balancer (SLB)

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

操作説明

説明

バックエンドサーバーが vServer グループにデプロイされている場合、DescribeVServerGroupAttribute 操作を呼び出してバックエンドサーバーを照会できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

slb:DescribeLoadBalancerAttribute

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag
slb:tag
slb:tag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	CLB インスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
LoadBalancerId	string	必須	CLB インスタンス ID。	lb-bp1b6c719dfa08ex****

レスポンスフィールド

フィールド	型	説明	例
	object
VpcId	string	内部向け CLB インスタンスがデプロイされている VPC (Virtual Private Cloud) の ID。	vpc-25dvzy9f8****
Tags	object
Tag	array<object>	タグ。
	object
TagKey	string	タグキー。N の有効値は 1 から 20 です。タグキーは空の文字列にできません。タグキーの長さは最大 64 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始まることはできません。	test
TagValue	string	タグ値。N の有効値は 1 から 20 です。タグ値は空の文字列にできます。タグ値の長さは最大 128 文字で、`acs:` または `aliyun` で始まることはできません。タグ値に `http://` または `https://` を含めることはできません。	value
CreateTimeStamp	integer	CA 証明書がアップロードされたときに生成されたタイムスタンプ。	1504147745000
CreateTime	string	CLB インスタンスが作成された時間。`YYYY-MM-DDThh:mm:ssZ` 形式の時間です。	2017-08-31T02:49:05Z
LoadBalancerId	string	CLB インスタンス ID。	lb-bp1b6c719dfa08ex****
PayType	string	CLB インスタンスの課金方法。有効な値: PayOnDemand のみが返される場合があります。これは従量課金方法を示します。	PayOnDemand
AddressType	string	CLB インスタンスのアドレスタイプ。	internet
NetworkType	string	CLB インスタンスのネットワークタイプ。	vpc
AddressIPVersion	string	IP アドレスのバージョン。有効な値: ipv4 および ipv6。	ipv4
RenewalCycUnit	string	自動更新サイクル。有効な値: Year および Month。デフォルト値: Month。説明このパラメーターは、Alibaba Cloud 中国サイトでサブスクリプション CLB インスタンスを作成した場合にのみ有効です。この場合、PayType は PrePay に設定され、RenewalStatus は AutoRenewal に設定されている必要があります。	Month
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF34B540710
Bandwidth	integer	帯域幅課金で課金されるインターネット向け CLB インスタンスの最大帯域幅。	5
LoadBalancerName	string	CLB インスタンス名。	lb-instance-test
Address	string	CLB インスタンスのサービス IP アドレス。	42.XX.XX.6
SlaveZoneId	string	CLB インスタンスが属するセカンダリゾーンの ID。	cn-hangzhou-d
EndTimeStamp	integer	CLB インスタンスの有効期限を示すタイムスタンプ。	3249380160000
MasterZoneId	string	CLB インスタンスが属するプライマリゾーンの ID。	cn-hangzhou-b
LoadBalancerSpec	string	CLB インスタンスの仕様。説明従量課金 CLB インスタンスは仕様の対象ではありません。デフォルトでは、slb.lcu.elastic が返されます。	slb.s1.small
AutoReleaseTime	integer	CLB インスタンスがリリースされたときに生成されたタイムスタンプ。	1513947075000
ModificationProtectionReason	string	設定変更保護が有効になっている理由。値は 1 から 80 文字の長さです。文字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。説明このパラメーターは、ModificationProtectionStatus が ConsoleProtection に設定されている場合にのみ有効です。	Instance service guarantee period
RegionId	string	CLB インスタンスのリージョン ID。	cn-hangzhou
ModificationProtectionStatus	string	設定変更保護が有効になっているかどうかを示します。有効な値: NonProtection: 設定変更保護は無効です。設定変更保護を無効にすると、ModificationProtectionReason の値はクリアされます。 ConsoleProtection: 設定変更保護は有効です。説明このパラメーターが ConsoleProtection に設定されている場合、CLB コンソールでインスタンス構成を変更することはできません。ただし、API 操作を呼び出すことでインスタンス構成を変更できます。	ConsoleProtection
EndTime	string	CLB インスタンスの有効期限が切れる時間。	2022-09-08T16:00:00Z
VSwitchId	string	内部向け CLB インスタンスが属する vSwitch の ID。	vsw-255ecrwq5****
LoadBalancerStatus	string	CLB インスタンスのステータス。有効な値: inactive: CLB インスタンスは無効化されています。inactive 状態の CLB インスタンスはトラフィックを転送しません。 active: CLB インスタンスは正常に稼働しています。新規作成された CLB インスタンスは、デフォルトで active 状態です。 locked: CLB インスタンスはロックされています。CLB インスタンスは、支払い遅延またはその他の理由によりロックされる場合があります。	active
ResourceGroupId	string	リソースグループ ID。	rg-atstuj3rtop****
InternetChargeType	string	インターネット向け CLB インスタンスの課金方法。有効な値: paybytraffic paybybandwidth	paybytraffic
DeleteProtection	string	CLB インスタンスの削除保護が有効になっているかどうかを示します。有効な値: on および off。	off
RegionIdAlias	string	CLB インスタンスが属するリージョンのエイリアス。	cn-hangzhou
RenewalStatus	string	自動更新が有効になっているかどうかを示します。有効な値: AutoRenewal: 自動更新が有効です。 Normal: 自動更新は無効です。CLB インスタンスを手動で更新する必要があります。 NotRenewal: CLB インスタンスは有効期限が切れても更新されません。この値が返された場合、システムは有効期限日の 3 日前まで通知を送信しません。注このパラメーターは、Alibaba Cloud 中国サイトでサブスクリプション CLB インスタンスを作成した場合にのみ有効です。この場合、PayType パラメーターは PrePay** に設定されている必要があります。	AutoRenewal
RenewalDuration	integer	自動更新期間。このパラメーターは、RenewalStatus が AutoRenewal に設定されている場合にのみ有効です。 PeriodUnit が Year に設定されている場合の有効な値: 1～5。 PeriodUnit が Month に設定されている場合の有効な値: 1～9。説明このパラメーターは、Alibaba Cloud 中国サイトでサブスクリプション CLB インスタンスを作成した場合にのみ有効です。この場合、PayType パラメーターは PrePay に設定されている必要があります。	1
ListenerPorts	object
ListenerPort	array	CLB インスタンスで使用されるフロントエンドポート。
	integer	CLB インスタンスで使用されるフロントエンドポート。	80
ListenerPortsAndProtocal	object
ListenerPortAndProtocal	array<object>	リスナーのポートまたはプロトコル。
	object
ListenerProtocal	string	CLB インスタンスで使用されるフロントエンドプロトコル。	http
ListenerPort	integer	CLB インスタンスで使用されるフロントエンドポート。	443
ListenerPortsAndProtocol	object
ListenerPortAndProtocol	array<object>	リスナーのポートまたはプロトコル。
	object
ListenerPort	integer	CLB インスタンスで使用されるフロントエンドポート。	80
ListenerProtocol	string	CLB インスタンスで使用されるフロントエンドプロトコル。	https
ListenerForward	string	リスナーが有効になっているかどうかを示します。	on
Description	string	リスナーが有効になっているかどうかを示します。	The description of listener port and protocol.
ForwardPort	integer	リクエストが転送される宛先リスニングポート。ポートはオープンであり、HTTPS を使用する必要があります。	443
BackendServers	object
BackendServer	array<object>	CLB インスタンスのバックエンドサーバー。
	object
Type	string	バックエンドサーバーのタイプ。	ecs
Weight	integer	バックエンドサーバーの重み。	90
Description	string	バックエンドサーバーの説明。説明 Description が設定されていない場合、このパラメーターは返されません。	Backend servers
ServerIp	string	ENI (Elastic Network Interface) または Elastic Container Instance の ID。	192.XX.XX.11
ServerId	string	バックエンドサーバー ID。	i-2zej4lxhjoq1icu*****

例

成功レスポンス

JSONJSON

{
  "VpcId": "vpc-25dvzy9f8****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "test",
        "TagValue": "value"
      }
    ]
  },
  "CreateTimeStamp": 1504147745000,
  "CreateTime": "2017-08-31T02:49:05Z",
  "LoadBalancerId": "lb-bp1b6c719dfa08ex****",
  "PayType": "PayOnDemand",
  "AddressType": "internet",
  "NetworkType": "vpc",
  "AddressIPVersion": "ipv4",
  "RenewalCycUnit": "Month",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Bandwidth": 5,
  "LoadBalancerName": "lb-instance-test",
  "Address": "42.XX.XX.6",
  "SlaveZoneId": "cn-hangzhou-d",
  "EndTimeStamp": 3249380160000,
  "MasterZoneId": "cn-hangzhou-b",
  "LoadBalancerSpec": "slb.s1.small",
  "AutoReleaseTime": 1513947075000,
  "ModificationProtectionReason": "Instance service guarantee period",
  "RegionId": "cn-hangzhou",
  "ModificationProtectionStatus": "ConsoleProtection",
  "EndTime": "2022-09-08T16:00:00Z",
  "VSwitchId": "vsw-255ecrwq5****",
  "LoadBalancerStatus": "active",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "InternetChargeType": "paybytraffic",
  "DeleteProtection": "off",
  "RegionIdAlias": "cn-hangzhou",
  "RenewalStatus": "AutoRenewal",
  "RenewalDuration": 1,
  "ListenerPorts": {
    "ListenerPort": [
      80
    ]
  },
  "ListenerPortsAndProtocal": {
    "ListenerPortAndProtocal": [
      {
        "ListenerProtocal": "http",
        "ListenerPort": 443
      }
    ]
  },
  "ListenerPortsAndProtocol": {
    "ListenerPortAndProtocol": [
      {
        "ListenerPort": 80,
        "ListenerProtocol": "https",
        "ListenerForward": "on",
        "Description": "The description of listener port and protocol.",
        "ForwardPort": 443
      }
    ]
  },
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 90,
        "Description": "Backend servers",
        "ServerIp": "192.XX.XX.11",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.

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

変更履歴

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