すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:CreateIngress

    ドキュメントセンター

    Serverless App Engine:CreateIngress

    最終更新日:Apr 22, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sae:CreateIngress

    create

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    NamespaceId

    string

    必須

    アプリケーションが配置されている名前空間の ID。名前空間をまたいだアプリケーションはサポートされていません。

    cn-beijing:sae-test
    Description

    string

    任意

    ルーティングルールの名前。

    ingress-for-sae-test
    SlbId

    string

    任意

    ルーティングルールに関連付けられている Server Load Balancer (SLB) インスタンスの ID。

    説明

    Server Load Balancer (SLB) には、クラシックロードバランサー (CLB) と Application Load Balancer (ALB) インスタンスが含まれます。

    lb-uf6hucc7inlqrtcq5****
    ListenerPort

    integer

    必須

    SLB インスタンスのリスナーポート。このポートは利用可能である必要があります。

    80
    CertId

    string

    任意

    CLB 証明書の ID。

    • LoadBalanceType が clb に設定されている場合、このパラメーターを使用して HTTPS リスナー証明書を構成します。

    CLB の SSL 証明書 ID の使用方法の詳細については、「証明書の管理 (CLB)」をご参照ください。

    188077086902****_176993d****_181437****_108724****
    CertIds

    string

    任意

    ALB 証明書の ID。

    • LoadBalanceType が alb に設定されている場合、このパラメーターを使用して HTTPS リスナーに複数の証明書を構成します。複数の証明書 ID はコンマ (,) で区切ります。

    • ALB インスタンスの SSL 証明書 ID は、デジタル証明書サービスから取得します。たとえば、756***-cn-hangzhou を構成する場合、756*** は製品ページから取得した証明書 ID で、-cn-hangzhou は固定のサフィックスです。詳細については、「証明書の管理 (ALB)」をご参照ください。

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

    string

    必須

    デフォルトの転送ルール。Rules パラメーターのどの転送ルールにも一致しないリクエストは、このルールで指定されたアプリケーションに転送されます。値は、次のパラメーターを含む JSON 文字列です：

    • appId：アプリケーションの ID。

    • containerPort：アプリケーションインスタンスのポート。

    説明

    このルールは、他の特定の転送ルールで処理されないトラフィックのキャッチオールとして機能します。

    {"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
    Rules

    string

    必須

    転送ルール。これらのルールは、ドメイン名とパスに基づいて、指定されたアプリケーションにトラフィックをルーティングします。値は JSON 文字列です。各ルールには次のパラメーターが含まれます：

    • appId：アプリケーションの ID。

    • containerPort：アプリケーションインスタンスのポート。

    • domain：ドメイン名。

    • path：リクエストパス。

    • backendProtocol：バックエンドサーバーが使用するプロトコル。有効な値：http、https、grpc。デフォルト値：http。

    • rewritePath：書き換え後のパス。

    説明

    パスの書き換え (RewritePath) は ALB のみがサポートしており、CLB はこの機能をサポートしていません。

    [{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2****","containerPort":8080,"domain":"sae.site","path":"/sys/(.*)/(.*)/aaa","backendProtocol":"http"}]
    LoadBalanceType

    string

    任意

    Server Load Balancer (SLB) インスタンスのタイプ。このパラメーターは、ルーティングルール作成後に変更することはできません。有効な値：

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

    • alb：Application Load Balancer (ALB)。

    clb
    ListenerProtocol

    string

    任意

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

    • HTTP：暗号化を必要としないアプリケーション向け。

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

    HTTP
    SecurityPolicyId

    string

    任意

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

    sp-bp1bpn0kn9****
    RequestTimeout

    integer

    任意

    リクエストタイムアウト (秒単位)。有効な値：1～180。バックエンドサーバーがタイムアウト期間内に応答しない場合、ロードバランサーは待機を停止し、クライアントに HTTP 504 エラーを返します。

    3
    IdleTimeout

    integer

    任意

    接続アイドルタイムアウト (秒単位)。有効な値：1～60。タイムアウト期間内にリクエストが受信されない場合、ロードバランサーは一時的に接続を閉じます。次のリクエストが受信されると、接続は再確立されます。

    15
    EnableXForwardedFor

    boolean

    任意

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

    true
    EnableXForwardedForClientSrcPort

    boolean

    任意

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

    true
    EnableXForwardedForProto

    boolean

    任意

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

    true
    EnableXForwardedForSlbId

    boolean

    任意

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

    true
    EnableXForwardedForSlbPort

    boolean

    任意

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

    true
    AddressType

    string

    任意

    アドレスタイプ。有効な値：

    • Internet：パブリックアドレス。

    • Intranet：プライベートアドレス。

    Internet
    LoadBalancerEdition

    string

    任意

    Application Load Balancer (ALB) インスタンスのエディション。エディションによって特徴や課金ポリシーが異なります。有効な値：

    • Standard：Standard エディション。

    • StandardWithWaf：WAF-enhanced edition。

    Standard
    ZoneMappings

    string

    任意

    アベイラビリティゾーンと VSwitch 間のマッピングを含む JSON 文字列。現在のリージョンが 2 つ以上のアベイラビリティゾーンをサポートしている場合、少なくとも 2 つ指定する必要があります。ZoneMapping は次のパラメーターで構成されます：

    • VSwitchId：アベイラビリティゾーンに対応する VSwitch の ID を指定する文字列。各アベイラビリティゾーンには 1 つの VSwitch と 1 つのサブネットしか設定できません。

    • ZoneId：ロードバランサーインスタンスのアベイラビリティゾーンの ID を指定する文字列。

    [{"VSwitchId":"vsw-wz9klui6icc08p6******","ZoneId":"cn-shenzhen-c"},{"VSwitchId":"vsw-wz9frrmoeuki2wp******","ZoneId":"cn-shenzhen-e"}]
    CorsConfig

    string

    任意

    オリジン間リソース共有 (CORS) の構成を指定します。

    {"Enable":"true"}
    EnableGzip

    boolean

    任意

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

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    RequestId

    string

    リクエストの ID。

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

    string

    返されたメッセージ。

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

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

    success
    TraceId

    string

    リクエストの詳細を照会するために使用されるトレース ID。

    0a98a02315955564772843261e****
    Data

    object

    返された結果。

    IngressId

    integer

    ルーティングルールの ID。

    87
    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": "0a98a02315955564772843261e****",
  "Data": {
    "IngressId": 87
  },
  "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
    400 Slb.NotFound The SLB instance does not exist: slbId [%s]
    400 Exceed.IngressRule The number of Ingress related rules must be less than or equal to 40.
    400 SlbListenerPort.NotAvailable The SLB listening port is unavailable: slbId [%s], port [%s]
    400 SSLCert.NotFound The specified SSL certificate cannot be found.
    404 InvalidResponse.Api The response of API %s is empty.

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

    変更履歴

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