すべてのプロダクト
Search

このプロダクト

    Microservices Engine:UpdateGatewayRoute

    ドキュメントセンター

    Microservices Engine:UpdateGatewayRoute

    最終更新日: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:UpdateGatewayRoute

    update

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayId

    integer

    任意

    ゲートウェイ ID。

    501
    Name deprecated

    string

    任意

    ルート名。

    route-web
    RouteOrder

    integer

    任意

    ルートのシーケンス番号。

    1
    Predicates

    array

    必須

    ルートのマッチング条件。

    PathPredicates

    object

    必須

    パスのマッチング。

    Path

    string

    任意

    ルートパス。

    /test
    Type

    string

    任意

    マッチングタイプ。

    PRE
    IgnoreCase

    boolean

    任意

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

    true
    MethodPredicates

    array

    任意

    メソッドマッチングに関する情報。

    string

    任意

    メソッド。

    GET
    HeaderPredicates

    array

    任意

    ヘッダーマッチングに関する情報。

    object

    任意

    リクエストヘッダー。

    Key

    string

    任意

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

    debug
    Value

    string

    任意

    対応する値。

    on
    Type

    string

    任意

    マッチングタイプ。

    PRE
    QueryPredicates

    array

    任意

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

    object

    任意

    URL パラメータ。

    Key

    string

    任意

    パラメータ名。

    userid
    Value

    string

    任意

    値。

    test
    Type

    string

    任意

    一致タイプ。

    PRE
    Services

    array

    任意

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

    array

    任意

    サービスのリスト。

    ServiceId

    integer

    任意

    サービス ID。

    1
    Percent

    integer

    任意

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

    80
    Version

    string

    任意

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

    v1
    Name

    string

    任意

    名前。

    web
    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

    任意

    Dubbo サービスグループ。

    service name
    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

    任意

    Dubbo ポート番号。

    20880
    Id

    integer

    任意

    ルート ID。

    139
    DestinationType

    string

    任意

    宛先サービスの種類。

    Mock
    DirectResponseJSON

    object

    任意

    Mock コンテンツ。

    Code

    integer

    任意

    Mock リターンコード。

    200
    Body

    string

    任意

    戻り値。

    hello
    GatewayUniqueId

    string

    必須

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

    gw-86575c0bc9f04ecfbacb92b8e392a2c4
    DomainIdListJSON

    string

    必須

    関連付けられたドメイン名。

    [90]
    RedirectJSON

    object

    任意

    リダイレクト。

    Code

    integer

    任意

    状態コード。

    302
    Host

    string

    任意

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

    test.com
    Path

    string

    任意

    リダイレクト先のパス。

    /test
    EnableWaf deprecated

    boolean

    任意

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

    false
    Fallback

    boolean

    任意

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

    true
    FallbackServices

    array

    任意

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

    object

    任意

    データオブジェクト。

    ServiceId

    integer

    任意

    サービス ID。

    1
    Percent

    integer

    任意

    パーセント値で表した重み。

    80
    Version

    string

    任意

    サービスのバージョン。

    v1
    Name

    string

    任意

    名前。

    name
    SourceType

    string

    任意

    ソースのタイプ。

    MSE
    Namespace

    string

    任意

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

    Namespace

    GroupName

    string

    任意

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

    test
    AgreementType

    string

    任意

    プロトコルタイプ。

    DUBBO

    ServicePort

    integer

    任意

    サービスポート番号。

    8848
    Description

    string

    任意

    ルートの説明。

    a route for xxx
    AcceptLanguage

    string

    任意

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

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    パラメーター

    型

    説明

    例

    object

    データ構造

    RequestId

    string

    リクエスト ID

    73785414-2C5B-5E28-BD91-B2C742269C48
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    返されたメッセージ。

    The request is successfully processed.

    Code

    integer

    状態コード

    200
    Success

    boolean

    呼び出しが成功したかどうかを示します。有効な値:

    • true: 呼び出しは成功しました。

    • false: 呼び出しは失敗しました。

    true
    Data

    integer

    データ。

    337
    ErrorCode

    string

    エラーコード。

    NoPermission

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "73785414-2C5B-5E28-BD91-B2C742269C48",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": 337,
  "ErrorCode": "NoPermission"
}

    エラーコード

    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

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

    変更履歴

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