すべてのプロダクト
Search
ドキュメントセンター

:DescribeLoadBalancerAttribute

最終更新日:Dec 14, 2025

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 の ID。

vpc-25dvzy9f8****

Tags

object

Tag

array<object>

タグ。

object

TagKey

string

タグキー。 N の有効値:120。タグキーは空の文字列にできません。

タグキーは最大 64 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

test

TagValue

string

タグ値。 N の有効値:120。タグ値は空の文字列にできます。

タグ値は最大 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 インスタンスを作成する場合にのみ有効です。 この場合、PayTypePrePay に、RenewalStatusAutoRenewal に設定する必要があります。

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 インスタンスの有効期限を示すタイムスタンプ。

32493801600000

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 文字です。先頭は英字である必要があり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。

説明

このパラメーターは、ModificationProtectionStatusConsoleProtection に設定されている場合にのみ有効です。

Managed instance

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 インスタンスが属するリージョンのエイリアス。

hangzhou

RenewalStatus

string

自動更新が有効になっているかどうかを示します。 有効な値:

  • AutoRenewal:自動更新が有効になっています。

  • Normal:自動更新は無効になっています。 CLB インスタンスを手動で更新する必要があります。

  • NotRenewal:CLB インスタンスは有効期限が切れても更新されません。 この値が返された場合、有効期限が切れる 3 日前まで通知は送信されません。

    **

    Note このパラメーターは、Alibaba Cloud 中国サイトでサブスクリプションの CLB インスタンスを作成する場合にのみ有効です。 この場合、PayTypePrePay に設定する必要があります。

AutoRenewal

RenewalDuration

integer

自動更新期間。 このパラメーターは、RenewalStatusAutoRenewal に設定されている場合にのみ有効です。

  • PeriodUnitYear に設定されている場合の有効な値:15

  • PeriodUnitMonth に設定されている場合の有効な値:19

説明

このパラメーターは、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

リスナーが有効になっているかどうかを示します。

Listener Description

ForwardPort

integer

リクエストの転送先となるリスニングポート。 ポートは開いており、HTTPS を使用している必要があります。

443

BackendServers

object

BackendServer

array<object>

CLB インスタンスのバックエンドサーバー。

object

Type

string

バックエンドサーバーのタイプ。

ecs

Weight

integer

バックエンドサーバーの重み。

90

Description

string

バックエンドサーバーの説明。

説明

Description が設定されていない場合、このパラメーターは返されません。

backend server description

ServerIp

string

Elastic Network Interface (ENI) または 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": "实例业务保障期",
  "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": "监听描述",
        "ForwardPort": 443
      }
    ]
  },
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 90,
        "Description": "用来接收转发请求的后端服务器",
        "ServerIp": "192.XX.XX.11",
        "ServerId": "i-2zej4lxhjoq1icu*****"
      }
    ]
  },
  "InstanceChargeType": "PayBySpec"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 LocationServiceTimeout Location service connection timeout. Please try again later.
403 UnauthorizedRegion The specified region of is not authorized.

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

変更履歴

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