ListIngresses API で SAE Ingress ルールを取得 - SAE - Alibaba Cloud - Serverless App Engine

Ingress のリストを取得します。

今すぐお試しください

この 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:ListIngresses

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/ingress/IngressList HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NamespaceId	string	必須	名前空間 ID。	cn-beijing
AppId	string	任意	アプリケーション ID。	bbf3a590-6d13-46fe-8ca9-c947a20b****
CurrentPage	integer	任意	現在のページ番号。
PageSize	integer	任意	ページサイズ。

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	応答メッセージ。呼び出しが成功すると、success が返されます。呼び出しが失敗すると、エラーコードが返されます。	success
TraceId	string	トレース ID。この ID を使用して、呼び出しの詳細をクエリできます。	0a98a02315955564772843261e****
Data	object	結果。
CurrentPage	integer	現在のページ。
TotalSize	integer	検出されたエントリの総数。
PageSize	integer	1 ページあたりのエントリ数。
IngressList	array<object>	ルーティングルールのリスト。
	array<object>	ルーティングルールに関する情報。
SlbId	string	Server Load Balancer (SLB) インスタンスの ID。	lb-uf62****6d13tq2u5
NamespaceId	string	名前空間 ID。	cn-shanghai
Description	string	Ingress ルールの名前。	test
ListenerPort	string	SLB インスタンスのリッスンポート。	80
SlbType	string	SLB インスタンスのタイプ。有効値： internet：パブリックネットワーク。 intranet：プライベートネットワーク。	internet
CertId	string	クラシックロードバランサー (CLB) 証明書の ID。	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	Application Load Balancer (ALB) 証明書の ID。	87*35-cn-hangzhou,812*3-cn-hangzhou
Name	string	ルーティングルールの名前。	lb-uf6jt0nu4z6ior943**-80-f5**
Id	integer	ルーティングルール ID。	18
LoadBalanceType	string	SLB インスタンスのタイプ。有効値： clb：Classic Load Balancer。 alb：Application Load Balancer。	clb
ListenerProtocol	string	SLB インスタンスの転送プロトコル。有効値： HTTP：データコンテンツを識別する必要があるアプリケーションに適しています。 HTTPS：暗号化された伝送を必要とするアプリケーションに適しています。このパラメーターは、CreateIngress および UpdateIngress 操作ではオプションです。ゲートウェイルーティングルールの作成または更新時にこのパラメーターを設定しない場合、このパラメーターは返されません。	HTTP
MseGatewayId	string	MSE クラウドネイティブゲートウェイインスタンスの ID。	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	サービスに対応するポート。	80
MseGatewayProtocol	string	MSE クラウドネイティブゲートウェイでサポートされている転送プロトコル。有効値： HTTP：データコンテンツを識別する必要があるアプリケーションに適しています。 HTTPS：暗号化された伝送を必要とするアプリケーションに適しています。	HTTP
RequestTimeout	integer	リクエストタイムアウト期間。
IdleTimeout	integer	接続アイドルタイムアウト期間。
CreateTime	integer	作成時間。
DefaultRule	object	デフォルトルール。
ContainerPort	integer	コンテナポート。
AppName	string	アプリケーション名。
AppId	string	アプリケーション ID。
BackendProtocol	string	バックエンドプロトコル。
Rules	array<object>	ルール。
	array<object>
AppName	string	アプリケーション名。
ContainerPort	integer	コンテナポート。
Domain	string	ドメイン名。
AppId	string	アプリケーション ID。
Path	string	パス。
BackendProtocol	string	バックエンドプロトコル。
RewritePath	string	書き換えられたパス。
RuleActions	array<object>	ルールアクションのリスト。
	object	ルールアクション。
ActionType	string	アクションタイプ。
ActionConfig	string	アクション設定。
CorsConfig	object	クロスドメイン設定。
Enable	string	クロスドメインアクセスが有効かどうかを示します。
ExposeHeaders	string	許可された公開ヘッダー。
AllowHeaders	string	許可されたヘッダー。
AllowMethods	string	許可されたメソッド。
AllowOrigin	string	許可されたオリジン。
AllowCredentials	string	認証情報を伝送できるかどうかを示します。
MaxAge	string	生存時間 (TTL)。
ErrorCode	string	エラーコード。リクエストが成功した場合、このパラメーターは返されません。リクエストが失敗した場合、このパラメーターが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	API 呼び出しのステータスまたは POP エラーコード。有効値： 2xx：呼び出しは成功しました。 3xx：呼び出しはリダイレクトされました。 4xx：クライアントエラーが発生しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	呼び出しが成功したかどうかを示します。有効値： true：呼び出しは成功しました。 false：呼び出しは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 0,
    "TotalSize": 0,
    "PageSize": 0,
    "IngressList": [
      {
        "SlbId": "lb-uf62****6d13tq2u5",
        "NamespaceId": "cn-shanghai",
        "Description": "test",
        "ListenerPort": "80",
        "SlbType": "internet",
        "CertId": "13624*****73809_16f8e549a20_1175189789_12****3210",
        "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
        "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
        "Id": 18,
        "LoadBalanceType": "clb",
        "ListenerProtocol": "HTTP",
        "MseGatewayId": "gw-d5df01a1bae748f1a7c4e325d2fd****",
        "MseGatewayPort": "80",
        "MseGatewayProtocol": "HTTP",
        "RequestTimeout": 0,
        "IdleTimeout": 0,
        "CreateTime": 0,
        "DefaultRule": {
          "ContainerPort": 0,
          "AppName": "",
          "AppId": "",
          "BackendProtocol": ""
        },
        "Rules": [
          {
            "AppName": "",
            "ContainerPort": 0,
            "Domain": "",
            "AppId": "",
            "Path": "",
            "BackendProtocol": "",
            "RewritePath": "",
            "RuleActions": [
              {
                "ActionType": "",
                "ActionConfig": ""
              }
            ]
          }
        ],
        "CorsConfig": {
          "Enable": "",
          "ExposeHeaders": "",
          "AllowHeaders": "",
          "AllowMethods": "",
          "AllowOrigin": "",
          "AllowCredentials": "",
          "MaxAge": ""
        }
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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

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

変更履歴

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