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

Global Accelerator:DescribeListener

最終更新日:Sep 17, 2026

指定されたリスナーの構成を照会します。

操作説明

指定されたリスナーの構成を照会します。これには、リスナーのルーティングタイプ、ステータス、作成タイムスタンプ、ポート情報が含まれます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ga:DescribeListener

get

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

Alibaba Cloud Global Accelerator (GA) インスタンスのリージョン ID。値を cn-hangzhou に設定します。

cn-hangzhou

ListenerId

string

必須

クエリするリスナーの ID。

lsr-bp1bpn0kn908w4nbw****

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスパラメーター。

Description

string

リスナーの説明。

Listener

RequestId

string

リクエスト ID。

6FEA0CF3-D3B9-43E5-A304-D217037876A8

State

string

リスナーのステータス。

  • configuring: リスナーは構成中です。

  • init: リスナーは初期化中です。

  • updating: リスナーは更新中です。

  • deleting: リスナーは削除中です。

active

CreateTime

string

リスナーが作成されたタイムスタンプ。単位: ミリ秒。

1577786252000

PortRanges

array<object>

リスナーのポート情報。

object

リスナーのポート情報。

FromPort

integer

リクエストを受信してエンドポイントに転送するために使用されるポート範囲の最初のリッスンポート。

20

ToPort

integer

リクエストを受信してエンドポイントに転送するために使用されるポート範囲の最後のリッスンポート。

20

BackendPorts

array<object>

バックエンドのポート情報。

object

バックエンドのポート範囲。

FromPort

string

バックエンドサーバーがリクエストを受け入れるために使用するポート範囲の最初のポート。

このパラメーターは、リスナープロトコルが HTTPS であり、リッスンポートがバックエンドサービスが提供されるポートと同じ場合にのみ返されます。

80

ToPort

string

バックエンドサーバーがリクエストを受け入れるために使用するポート範囲の最後のポート。

80

Certificates

array<object>

SSL 証明書のリスト。

object

SSL 証明書のリスト。

Type

string

証明書のタイプ。

現在、Server (サーバー証明書) のみがサポートされています。

Server

Id

string

SSL 証明書 ID。

449****-cn-hangzhou

Protocol

string

リスナーのネットワーク伝送プロトコルタイプ。

  • TCP: TCP プロトコル。

  • UDP: UDP プロトコル。

  • HTTP: HTTP プロトコル。

  • HTTPS: HTTPS プロトコル。

TCP

ListenerId

string

リスナー ID。

lsr-bp1bpn0kn908w4nbw****

ClientAffinity

string

クライアントアフィニティ。

  • NONE が返された場合、クライアントアフィニティは維持されません。同じクライアントからの接続が常に同じエンドポイントに転送されるとは限りません。

  • SOURCE_IP が返された場合、クライアントアフィニティが維持されます。クライアントがステートフルアプリケーションにアクセスするとき、送信元ポートやプロトコルに関係なく、同じクライアントからのすべてのリクエストを同じエンドポイントに転送できます。

SOURCE_IP

Name

string

リスナーの名前。

Listener

RelatedAcls

array<object>

リスナーに関連付けられているアクセスコントロールポリシーグループの情報。

object

リスナーに関連付けられているアクセスコントロールポリシーグループの情報。

AclId

string

リスナーに関連付けられているアクセスコントロールポリシーグループの ID。

123

Status

string

アクセスコントロール機能が有効かどうかを示します。

  • Associated: 有効。

Associated

AclType

string

アクセスコントロールのタイプ:

  • white: 選択したアクセスコントロールポリシーグループ内の IP アドレスまたは CIDR ブロックからのリクエストのみが転送されます。ホワイトリストは、アプリケーションが特定の IP アドレスからのアクセスのみを許可するシナリオに適用されます。ホワイトリストを有効にすると、いくつかのリスクが生じます。ホワイトリストを有効にすると、ホワイトリスト内の IP アドレスのみが Global Accelerator リスナーにアクセスできます。ホワイトリストが有効になっているにもかかわらず、アクセスコントロールポリシーグループに IP アドレスが追加されていない場合、Global Accelerator リスナーはリクエストを転送しません。

  • black: 選択したアクセスコントロールポリシーグループ内の IP アドレスまたは CIDR ブロックからのすべてのリクエストがブロックされます。ブラックリストは、アプリケーションが特定の IP アドレスからのアクセスのみを拒否するシナリオに適用されます。ブラックリストが有効になっているにもかかわらず、アクセスコントロールポリシーグループに IP アドレスが追加されていない場合、Global Accelerator リスナーはすべてのリクエストを転送します。

このパラメーターは、Status パラメーターの値が on の場合にのみ返されます。

white

AcceleratorId

string

Alibaba Cloud Global Accelerator (GA) インスタンス ID。

ga-bp1odcab8tmno0hdq****

ProxyProtocol deprecated

boolean

クライアント IP アドレス保持の機能が有効かどうかを示します。

  • true: クライアント IP アドレス保持の機能が有効です。この機能を有効にすると、バックエンドサービスはクライアントの送信元 IP アドレスをビューできます。

  • false: クライアント IP アドレス保持の機能が無効です。

false

XForwardedForConfig

object

XForward フィールド構成情報。

XForwardedForGaIdEnabled

boolean

GA-ID ヘッダーを使用して Alibaba Cloud Global Accelerator (GA) インスタンス ID を取得するかどうかを示します。

  • true: はい。

  • false: いいえ。

説明

HTTP および HTTPS リスナーのみがこのパラメーターをサポートしています。

false

XForwardedForGaApEnabled

boolean

GA-AP ヘッダーを使用して加速エリア情報を取得するかどうかを示します。

  • true: はい。

  • false: いいえ。

説明

HTTP および HTTPS リスナーのみがこのパラメーターをサポートしています。

false

XForwardedForProtoEnabled

boolean

GA-X-Forward-Proto ヘッダーを使用して Alibaba Cloud Global Accelerator (GA) インスタンスのリスナープロトコルを取得するかどうかを示します。

  • true: はい。

  • false: いいえ。

説明

HTTP および HTTPS リスナーのみがこのパラメーターをサポートしています。

false

XForwardedForPortEnabled

boolean

GA-X-Forward-Port ヘッダーを使用して Alibaba Cloud Global Accelerator (GA) インスタンスのリスナーポートを取得するかどうかを示します。

  • true: はい。

  • false: いいえ。

説明

HTTP および HTTPS リスナーのみがこのパラメーターをサポートしています。

false

XRealIpEnabled

boolean

X-Real-IP ヘッダーを使用して実際のクライアント IP アドレスを取得するかどうかを示します。

  • true: はい。

  • false: いいえ。

説明

HTTP および HTTPS リスナーのみがこのパラメーターをサポートしています。

false

SecurityPolicyId

string

TLS セキュリティポリシーインスタンス ID。

  • tls_cipher_policy_1_0

    • サポートされている TLS バージョン: TLSv1.0、TLSv1.1、および TLSv1.2。

    • サポートされている暗号化アルゴリズムスイート: ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、および DES-CBC3-SHA。

  • tls_cipher_policy_1_1

    • サポートされている TLS バージョン: TLSv1.1 および TLSv1.2。

    • サポートされている暗号化アルゴリズムスイート: ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、および DES-CBC3-SHA。

  • tls_cipher_policy_1_2

    • サポートされている TLS バージョン: TLSv1.2。

    • サポートされている暗号化アルゴリズムスイート: ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA、および DES-CBC3-SHA。

  • tls_cipher_policy_1_2_strict

    • サポートされている TLS バージョン: TLSv1.2。

    • サポートされている暗号化アルゴリズムスイート: ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA、および ECDHE-RSA-AES256-SHA。

  • tls_cipher_policy_1_2_strict_with_1_3

    • サポートされている TLS バージョン: TLSv1.2 および TLSv1.3。

    • サポートされている暗号化アルゴリズムスイート: TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、ECDHE-ECDSA-AES128-GCM-SHA256、ECDHE-ECDSA-AES256-GCM-SHA384、ECDHE-ECDSA-AES128-SHA256、ECDHE-ECDSA-AES256-SHA384、ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、および ECDHE-RSA-AES256-SHA。

説明

HTTPS リスナーのみがこのパラメーターをサポートしています。

tls_cipher_policy_1_0

Type

string

リスナーのルーティングタイプ。

  • Standard: 標準のインテリジェントルーティングタイプ。

  • CustomRouting: カスタムルーティングタイプ。

Standard

ServiceId

string

ホストインスタンスを管理するサービスの ID。

説明

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

ALB

ServiceManaged

boolean

インスタンスが管理されているかどうかを示します。有効な値:

  • true: インスタンスは管理されています。

  • false: インスタンスは管理されていません。

true

ServiceManagedInfos

array<object>

ユーザーがホストインスタンスで実行できる操作ポリシーのリスト。

説明
  • このパラメーターは、ServiceManaged パラメーターが True に設定されている場合にのみ有効です。

  • インスタンスが管理状態にある場合、インスタンスに対するユーザーの操作は制限され、特定の操作は禁止されます。

object

ユーザーがホストインスタンスで実行できる操作ポリシーのリスト。

Action

string

管理ポリシー操作の名前。有効な値:

  • Create: インスタンスを作成します。

  • Update: 現在のインスタンスを更新します。

  • Delete: 現在のインスタンスを削除します。

  • Associate: 現在のインスタンスを参照するか、現在のインスタンスから参照されます。

  • UserUnmanaged: インスタンスの管理を解除します。

  • CreateChild: 現在のインスタンスの下に子リソースを作成します。

Update

ChildType

string

子リソースタイプ。有効な値:

  • Listener: リスナーリソース。

  • IpSet: 加速リージョンリソース。

  • EndpointGroup: エンドポイントグループリソース。

  • ForwardingRule: 転送ルールリソース。

  • Endpoint: エンドポイントリソース。

  • EndpointGroupDestination: カスタムルーティングリスナーの下のエンドポイントグループのプロトコルマッピングリソース。

  • EndpointPolicy: カスタムルーティングリスナーの下のエンドポイントトラフィックポリシーリソース。

説明

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

Listener

IsManaged

boolean

管理ポリシー操作が管理されているかどうかを示します。有効な値:

  • true: 管理ポリシー操作は管理されています。ユーザーは、ホストインスタンスに対して Action で指定された操作を実行できません。

  • false: 管理ポリシー操作は管理されていません。ユーザーは、ホストインスタンスに対して Action で指定された操作を実行できます。

false

IdleTimeout

integer

アイドル接続タイムアウト期間。単位: 秒。

900

RequestTimeout

integer

HTTP/HTTPS 接続リクエストタイムアウト期間。単位: 秒。

説明

このパラメーターは、Protocol (ネットワーク伝送プロトコルタイプ) が HTTP または HTTPS のリスナーに対してのみ有効です。バックエンドサーバーがタイムアウト期間内に応答を返さない場合、Global Accelerator は待機を停止し、クライアントに HTTP 504 エラーコードを返します。

60

HttpVersion

string

HTTP プロトコルの最大バージョン。有効な値:

  • http3: HTTP/3。

  • http2: HTTP/2。

  • http1.1: HTTP/1.1。

説明

HTTPS リスナーのみがこのパラメーターをサポートしています。

http2

例

成功レスポンス

JSONJSON

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "TCP",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "Associated"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": false
  },
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "Type": "Standard",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "IdleTimeout": 900,
  "RequestTimeout": 60,
  "HttpVersion": "http2"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 NotExist.Listener listener %s is not exist
500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

変更履歴

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