すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:DescribeIngress

    ドキュメントセンター

    Serverless App Engine:DescribeIngress

    最終更新日:Apr 22, 2026

    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:DescribeIngress

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    IngressId

    integer

    必須

    ルーティングルールの ID。 この ID を取得するには、ListIngresses 操作を呼び出します。

    16263

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    RequestId

    string

    リクエスト ID。

    91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
    Message

    string

    返されたメッセージ。

    • リクエストが成功した場合、success が返されます。

    • リクエストが失敗した場合、特定のエラーコードが返されます。

    success
    TraceId

    string

    呼び出しの詳細を照会するために使用されるトレース ID。

    0a981dd515966966104121683d****
    Data

    object

    返されたデータ。

    SlbId

    string

    Server Load Balancer (SLB) インスタンスの ID。

    lb-uf62****6d13tq2u5
    NamespaceId

    string

    名前空間 ID。

    cn-beijing:sae-test
    Description

    string

    Ingress の説明。

    ingress-sae-test
    ListenerPort

    integer

    SLB インスタンスのリスナーポート。

    443
    SlbType

    string

    SLB インスタンスのタイプ。 有効な値：

    • internet：インターネット向けのインスタンス。

    • intranet：内部向けのインスタンス。

    internet
    CertId

    string

    クラシックロードバランサー (CLB) 証明書の ID。

    13623****809_16cad216b32_845_-419427029
    Name

    string

    Ingress の名前。

    lb-uf6jt0nu4z6ior943****-80-f5****
    DefaultRule

    object

    デフォルトルール。

    ContainerPort

    integer

    デフォルトルールのバックエンドポート。

    8080
    AppName

    string

    デフォルトルールのアプリケーション名。

    app1
    AppId

    string

    デフォルトルールのアプリケーション ID。

    395b60e4-0550-458d-9c54-a265d036****
    BackendProtocol

    string

    バックエンドプロトコル。 有効な値：

    • http：データコンテンツを識別する必要があるアプリケーションに適しています。

    • https：暗号化された伝送を必要とするアプリケーションに適しています。

    • grpc：.NET などの複数の言語で開発された gRPC サービスの負荷分散に適しています。

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

    http
    Rules

    array<object>

    転送ルール。

    array<object>

    転送ルール。

    AppName

    string

    宛先アプリケーションの名前。

    app1
    ContainerPort

    integer

    アプリケーションのバックエンドポート。

    8080
    Domain

    string

    アプリケーションのドメイン名。

    edas.site
    AppId

    string

    宛先アプリケーションの ID。

    395b60e4-0550-458d-9c54-a265d036****
    Path

    string

    URL パス。

    /path1
    BackendProtocol

    string

    バックエンドプロトコル。 有効な値：

    • http：データコンテンツを識別する必要があるアプリケーションに適しています。

    • https：暗号化された伝送を必要とするアプリケーションに適しています。

    • grpc：.NET などの複数の言語で開発された gRPC サービスの負荷分散に適しています。

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

    http
    RewritePath

    string

    書き換えパス。

    /${1}
    RuleActions

    array<object>

    転送ルールのアクション。

    object

    ルールのアクション。

    ActionType

    string

    アクションのタイプ。 有効な値：

    • rewrite：書き換えポリシー

    • redirect：リダイレクトポリシー

    rewrite
    ActionConfig

    string

    アクションの構成。

    {\"host\":\"www.example.com\",\"path\":\"/example/text\",\"query\":\"x=1\"}
    Id

    integer

    Ingress の ID。

    87
    LoadBalanceType

    string

    Server Load Balancer (SLB) インスタンスのタイプ。 有効な値：

    • clb：クラシックロードバランサー (CLB)、旧称 SLB。

    • alb：Application Load Balancer (ALB)。

    clb
    ListenerProtocol

    string

    リクエスト転送プロトコル。 有効な値：

    • HTTP：データコンテンツを識別する必要があるアプリケーションに適しています。

    • HTTPS：暗号化された伝送を必要とするアプリケーションに適しています。

    このパラメーターは、CreateIngress および UpdateIngress 操作ではオプションです。 Ingress の作成または更新時に指定されなかった場合は返されません。

    HTTP
    CertIds

    string

    コンマで区切られた Application Load Balancer (ALB) 証明書の ID。

    87***35-cn-hangzhou,812***3-cn-hangzhou
    SecurityPolicyId

    string

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

    sp-n0kn923****
    RequestTimeout

    integer

    リクエストタイムアウト (秒単位)。

    有効な値：1～180。

    デフォルト値：60。

    バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、ロードバランサーはリクエストを終了し、HTTP 504 エラーをクライアントに返します。

    60
    IdleTimeout

    integer

    接続アイドルタイムアウト (秒単位)。

    有効な値：1～60。

    デフォルト値：15。

    タイムアウト期間内にリクエストが受信されない場合、ロードバランサーは接続を閉じます。 次のリクエストが受信されると、新しい接続が確立されます。

    3
    EnableXForwardedFor

    boolean

    X-Forwarded-For ヘッダーを使用してクライアント IP アドレスを取得するかどうかを指定します。

    true
    EnableXForwardedForClientSrcPort

    boolean

    ヘッダーを使用してクライアントの送信元ポートを取得するかどうかを指定します。

    true
    EnableXForwardedForProto

    boolean

    X-Forwarded-Proto ヘッダーを使用して SLB インスタンスのリスナープロトコルを取得するかどうかを指定します。

    true
    EnableXForwardedForSlbId

    boolean

    SLB-ID ヘッダーを使用して SLB インスタンスの ID を取得するかどうかを指定します。

    true
    EnableXForwardedForSlbPort

    boolean

    X-Forwarded-Port ヘッダーを使用して SLB インスタンスのリスナーポートを取得するかどうかを指定します。

    true
    CreatedBySae

    boolean

    Application Load Balancer (ALB) インスタンスが SAE によってプロビジョニングされたかどうかを示します。

    true
    CorsConfig

    object

    Cross-Origin Resource Sharing (CORS) の構成。 有効な HTTP メソッド：

    • GET

    • POST

    • PUT

    • DELETE

    • HEAD

    • OPTIONS

    • PATCH

    Enable

    string

    CORS を有効にするかどうかを指定します。

    false
    ExposeHeaders

    string

    クライアントに公開されるヘッダー。

    test_123
    AllowHeaders

    string

    クロスオリジンリクエストで許可されるヘッダー。

    test_123
    AllowMethods

    string

    クロスオリジンリクエストで許可される HTTP メソッド。

    GET
    AllowOrigin

    string

    リソースへのアクセスが許可されているオリジン。 単一のアスタリスク (*) または 1 つ以上の特定のオリジンを指定できます。

    • 特定のオリジンは http:// または https:// で始まり、有効なドメイン名または第 1 レベルのワイルドカードドメイン名である必要があります。 例：http://*.test.abc.example.com。

    • オプションでポートを指定できます。 有効なポート範囲は 1～65535 です。

    *
    AllowCredentials

    string

    クロスオリジンリクエストで認証情報を許可するかどうかを指定します。 有効な値：

    • on：はい

    • off：いいえ

    on
    MaxAge

    string

    ブラウザでのプリフライトリクエストの最大キャッシュ期間 (秒単位)。

    有効な値：-1～172800。

    1000
    EnableGzip

    boolean

    Gzip 圧縮を有効にするかどうかを指定します。

    ErrorCode

    string

    エラーコード。

    • このパラメーターは、リクエストが失敗した場合にのみ返されます。

    • 詳細については、このトピックの「エラーコード」セクションをご参照ください。

    Code

    string

    リクエストに対して返される HTTP ステータスコード。 有効な値：

    • 2xx：リクエストは成功しました。

    • 3xx：リクエストはリダイレクトされました。

    • 4xx：クライアントエラーが発生しました。

    • 5xx：サーバーエラーが発生しました。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。 有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a981dd515966966104121683d****",
  "Data": {
    "SlbId": "lb-uf62****6d13tq2u5",
    "NamespaceId": "cn-beijing:sae-test",
    "Description": "ingress-sae-test",
    "ListenerPort": 443,
    "SlbType": "internet",
    "CertId": "13623****809_16cad216b32_845_-419427029",
    "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
    "DefaultRule": {
      "ContainerPort": 8080,
      "AppName": "app1",
      "AppId": "395b60e4-0550-458d-9c54-a265d036****",
      "BackendProtocol": "http"
    },
    "Rules": [
      {
        "AppName": "app1",
        "ContainerPort": 8080,
        "Domain": "edas.site",
        "AppId": "395b60e4-0550-458d-9c54-a265d036****",
        "Path": "/path1",
        "BackendProtocol": "http",
        "RewritePath": "/${1}",
        "RuleActions": [
          {
            "ActionType": "rewrite",
            "ActionConfig": "{\\\"host\\\":\\\"www.example.com\\\",\\\"path\\\":\\\"/example/text\\\",\\\"query\\\":\\\"x=1\\\"}"
          }
        ]
      }
    ],
    "Id": 87,
    "LoadBalanceType": "clb",
    "ListenerProtocol": "HTTP",
    "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
    "SecurityPolicyId": "sp-n0kn923****",
    "RequestTimeout": 60,
    "IdleTimeout": 3,
    "EnableXForwardedFor": true,
    "EnableXForwardedForClientSrcPort": true,
    "EnableXForwardedForProto": true,
    "EnableXForwardedForSlbId": true,
    "EnableXForwardedForSlbPort": true,
    "CreatedBySae": true,
    "CorsConfig": {
      "Enable": "false",
      "ExposeHeaders": "test_123",
      "AllowHeaders": "test_123",
      "AllowMethods": "GET",
      "AllowOrigin": "*",
      "AllowCredentials": "on",
      "MaxAge": "1000"
    },
    "EnableGzip": false
  },
  "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

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

    変更履歴

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