SAE アプリケーションにおける NLB インスタンスバインディングの概要 - SAE - Alibaba Cloud - Serverless App Engine

アプリケーションの NLB 構成を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:DescribeApplicationNlbs

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/app/nlb HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	任意	アプリケーション ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	返されるメッセージ。`success` が返された場合はリクエストが成功したことを示し、それ以外の場合はエラーコードが返されます。	success
TraceId	string	リクエストの詳細を照会するために使用されるトレース ID。	ac1a0b2215622246421415014e****
ErrorCode	string	エラーコード。このパラメーターは、リクエストが失敗した場合にのみ返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	HTTP ステータスコード。有効な値： 2xx：リクエストは成功です。 3xx：リクエストはリダイレクトされます。 4xx：クライアントエラーが発生しました。 5xx：サーバーエラーが発生しました。	200
Success	string	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
Data	object	応答で返されるデータ。
Instances	object	インスタンス詳細のコレクション。
	object	インスタンスの詳細。
DnsName	string	DNS 名。	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
Listeners	object	リスナー詳細のコレクション。
	object	リスナーの詳細。
Protocol	string	リスナープロトコル。	TCPSSL
Port	integer	リスナーポート。	80
Status	string	NLB リスナーの状態。有効な値： Creating：リスナーは作成中です。 Configuring：リスナーは設定中です。 Bounded：リスナーは実行中です。 Unbinding：リスナーは削除中です。 Failed：リスナーは利用不可です。	Bounded
TargetPort	integer	ターゲットポート。	8080
CertIds	string	サーバー証明書 ID。	123157******
CreatedBySae	boolean	SAE がインスタンスを作成したかどうかを示します。有効な値： true：SAE がインスタンスを作成しました。 false：SAE が既存のインスタンスを再利用しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "ErrorCode": "",
  "Code": "200",
  "Success": "true",
  "Data": {
    "Instances": {
      "key": {
        "DnsName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
        "Listeners": {
          "key": {
            "Protocol": "TCPSSL",
            "Port": 80,
            "Status": "Bounded",
            "TargetPort": 8080,
            "CertIds": "123157******"
          }
        },
        "CreatedBySae": true
      }
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

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

変更履歴

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