すべてのプロダクト
Search

このプロダクト

    Microservices Engine:AddGatewayRoute

    ドキュメントセンター

    Microservices Engine:AddGatewayRoute

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mse:AddGatewayRoute

    create

    *Gateway

    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayId

    integer

    任意

    ゲートウェイ ID。

    526
    Name

    string

    必須

    ルート名。

    test
    RouteOrder

    integer

    任意

    ルートのシーケンス番号。(値が小さいほど優先度が高いことを示します。)

    1
    Predicates

    array

    任意

    一致ルール。

    PathPredicates

    object

    任意

    ルート一致タイプ。

    Path

    string

    任意

    パス。

    /test
    Type

    string

    任意

    ルート一致タイプ。有効な値：

    • PRE: プレフィックス一致

    • EQUAL: 完全一致

    • ERGULAR: 正規表現一致

    PRE
    IgnoreCase

    boolean

    任意

    大文字と小文字を区別するかどうかを指定します。

    true
    MethodPredicates

    array

    任意

    メソッド一致に関する情報。

    string

    任意

    メソッド。

    GET
    HeaderPredicates

    array

    任意

    ヘッダー一致に関する情報。

    object

    任意

    リクエストヘッダー。

    Key

    string

    任意

    リクエストヘッダーキー。

    debug
    Value

    string

    任意

    対応する値。

    test
    Type

    string

    任意

    一致タイプ。

    PRE
    QueryPredicates

    array

    任意

    URL パラメーターの照合。

    object

    任意

    URL パラメーター。

    Key

    string

    任意

    パラメーター名。

    userid
    Value

    string

    任意

    一致条件の値。

    test
    Type

    string

    任意

    一致タイプ。

    PRE
    Services

    array

    任意

    ゲートウェイに関連付けるサービス。ルートポイントパラメーターが単一サービス、複数サービス、またはラベルルーティングに設定されている場合、このパラメーターは必須です。

    array

    任意

    サービスリスト。

    ServiceId

    integer

    任意

    サービス ID。

    353
    Percent

    integer

    任意

    特定のバージョンのサービスのトラフィックの重みをパーセントで表します。ルートポイントパラメーターが複数サービスまたはラベルルーティングに設定されている場合、このパラメーターは必須です。

    80
    Version

    string

    任意

    サービスバージョン。ルートポイントパラメーターがラベルルーティングに設定されている場合にのみ、このパラメーターは必須です。

    v1
    Name

    string

    任意

    名前。

    user
    SourceType

    string

    任意

    ソースのタイプ。

    MSE
    Namespace

    string

    任意

    サービスが属する名前空間。

    default
    GroupName

    string

    任意

    サービスグループの名前。

    test
    AgreementType

    string

    任意

    プロトコルタイプ。

    DUBBO
    HttpDubboTranscoder

    object

    任意

    Dubbo プロトコルコンバーター。

    DubboServiceName

    string

    任意

    Dubbo サービス名。

    org.apache.dubbo.samples.basic.api.DemoService
    DubboServiceVersion

    string

    任意

    Dubbo サービスバージョン。

    0.0.0
    DubboServiceGroup

    string

    任意

    サービスグループ。

    None

    MothedMapList

    array

    任意

    Dubbo 転送ルール。

    array

    任意

    メソッドマッピング。

    DubboMothedName

    string

    任意

    Dubbo メソッド名。

    sayHello
    HttpMothed

    string

    任意

    HTTP メソッド。

    説明

    サポートされている HTTP メソッドパラメーター値：

    • ALL_GET。

    • ALL_POST。

    • ALL_PUT。

    • ALL_DELETE。

    • ALL_PATCH。

    ALL_GET
    Mothedpath

    string

    任意

    メソッドの照合に使用されるパス。

    /mytestzbk/sayhello
    PassThroughAllHeaders

    string

    任意

    ヘッダーのパススルータイプ。

    説明

    パススルータイプの列挙値：

    • PASS_ALL: すべてのヘッダーがパススルーされます。

    • PASS_NOT: ヘッダーはパススルーされません。

    • PASS_ASSIGN: 指定されたヘッダーがパススルーされます。

    PASS_NOT
    PassThroughList

    array

    任意

    パススルーされるヘッダー。

    string

    任意

    パススルーされるヘッダー値。

    x-forward
    ParamMapsList

    array

    任意

    パラメータマッピングに関する情報。

    object

    任意

    パラメータマッピングオブジェクト。

    ExtractKeySpec

    string

    任意

    入力パラメーターの位置。

    説明

    入力パラメーター位置の列挙値：

    • リクエストパラメーター: ALL_QUERY_PARAMETER

    • リクエストヘッダー: ALL_HEADER

    • リクエストの URI : ALL_PATH

    • リクエスト本文: ALL_BODY

    ALL_QUERY_PARAMETER
    ExtractKey

    string

    任意

    抽出される入力パラメーターのキー。

    name
    MappingType

    string

    任意

    バックエンドサービスパラメーターのタイプ。

    java.lang.String
    ServicePort

    integer

    任意

    サービスポート番号。

    443
    DomainId

    integer

    任意

    ドメイン ID。

    20
    DestinationType

    string

    任意

    宛先サービスのタイプ。

    • Single: 単一サービス

    • Multiple: 複数サービス

    • VersionOriented: ラベルルーティング

    • Mock: Mock

    • Redirect: リダイレクト

    Multiple
    DirectResponseJSON

    object

    任意

    Mock レスポンス設定。

    Code

    integer

    任意

    Mock リターンコード。

    403
    Body

    string

    任意

    戻り値。

    hello
    GatewayUniqueId

    string

    必須

    ゲートウェイの一意の ID。

    gw-492af9b04bb4474cae9d645be8*****
    DomainIdListJSON

    string

    必須

    ドメインの ID。

    [0,94]
    RedirectJSON

    object

    任意

    リダイレクト操作の設定。

    Code

    integer

    任意

    HTTP ステータスコード。

    302
    Host

    string

    任意

    リダイレクト先のホスト名。

    test.com
    Path

    string

    任意

    リダイレクト先のパス。

    /test
    EnableWaf deprecated

    boolean

    任意

    非推奨。UpdateGatewayRouteWafStatus を使用して、ルートの WAF ステータスを更新します。

    true
    Fallback

    boolean

    任意

    フォールバックサービスを有効にするかどうかを示します。

    true
    FallbackServices

    array

    任意

    フォールバックサービス。

    object

    任意

    ServiceId

    integer

    任意

    サービス ID。

    353
    Percent

    integer

    任意

    パーセント値形式の重み。

    80
    Version

    string

    任意

    サービスのバージョン。

    v1
    Name

    string

    任意

    名前。

    user
    SourceType

    string

    任意

    ソースのタイプ。

    MSE
    Namespace

    string

    任意

    サービスが存在する名前空間。

    default
    GroupName

    string

    任意

    サービスが属するグループの名前。

    test
    AgreementType

    string

    任意

    プロトコルタイプ。

    DUBBO
    ServicePort

    integer

    任意

    サービスポート番号。

    443
    RouteType

    string

    任意

    ルートのタイプ。有効な値：

    Op: 管理ルート。

    Op
    Policies

    string

    任意

    JSON 文字列形式のルーティングポリシー。

    {"CORS":"{\"allowMethods\":\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\",\"allowHeaders\":\"*\",\"exposeHeaders\":\"*\",\"unitNum\":12,\"allowCredentials\":true,\"status\":\"off\",\"allowOrigins\":\"*\",\"timeUnit\":\"h\"}","Timeout":"{\"unitNum\":10,\"timeUnit\":\"s\",\"status\":\"off\"}","Retry":"{\"attempts\":2,\"retryOn\":[\"5xx\"],\"status\":\"off\"}","HTTPRewrite":"{\"pathType\":\"EQUAL\",\"path\":\"/o\",\"status\":\"off\"}","Waf":"{\"enabled\":false}","HeaderOp":"{\"status\":\"off\",\"headerOpItems\":[{\"directionType\":\"Request\",\"opType\":\"Add\",\"key\":\"kkk\",\"value\":\"ll\"}]}"}
    Description

    string

    任意

    ルートの説明。

    a route for xxx
    AcceptLanguage

    string

    任意

    レスポンスの言語。有効な値：

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    パラメーター

    型

    説明

    例

    object

    データ構造。

    RequestId

    string

    リクエスト ID。

    03A3E2F4-6804-5663-9D5D-2EC47A1*****
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    レスポンスメッセージ。

    The request is successfully processed.

    Code

    integer

    返されたコード。

    200
    Success

    boolean

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

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

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

    true
    Data

    integer

    ルート ID。

    555
    ErrorCode

    string

    エラーコード。

    • InvalidParameter: パラメーターが無効です。たとえば、パラメーターが不完全であるか、パラメーターの形式が無効です。

    • IllegalRequest: リクエストが無効です。パラメーターによって開始されたデータへの不正アクセスが識別されます。

    • NoPermission: この操作を実行する権限がありません。

    • NotFound: リソースが存在しません。

    • InternalError: 内部エラーが発生しました。

    InvalidParameter

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": 555,
  "ErrorCode": "InvalidParameter"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

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

    変更履歴

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