すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetGatewayRouteDetail

    ドキュメントセンター

    Microservices Engine:GetGatewayRouteDetail

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

    get

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RouteId

    integer

    必須

    ルート ID。

    1050
    GatewayUniqueId

    string

    必須

    ゲートウェイの一意の識別子 ID。

    gw-5d3a78a53ec947aa928212d671d400ac
    AcceptLanguage

    string

    任意

    返される情報の言語タイプ:

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    パラメーター

    型

    説明

    例

    object

    データ構造。

    RequestId

    string

    リクエスト ID。

    FDF2D16C-5D28-5FAA-A56B-30BDE3559880
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    エラーメッセージ。

    You are not authorized to perform this operation.
    Code

    integer

    ステータスコード。 200 は成功を示します。

    200
    Success

    boolean

    リクエスト結果。次の値があります。

    • true: リクエストは成功です。

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

    true
    Data

    object

    返されたデータ。

    Id

    integer

    ID。

    1050
    Name

    string

    名前。

    test
    GatewayUniqueId

    string

    ゲートウェイの一意の識別子 ID。

    gw-7ea3da97b96543e19f6c597c****
    GatewayId

    integer

    ゲートウェイ ID。

    1
    DefaultServiceId

    integer

    デフォルト サービス ID。

    3
    DefaultServiceName

    string

    デフォルト サービス名。

    test
    Status

    integer

    ルート ステータス。

    • 未公開: 0

    • 公開中: 2

    • 公開済み: 3

    • 編集中 (更新は公開されていません): 4

    • 公開取消中: 5

    • 利用不可: 6

    0
    GmtCreate

    string

    作成時間。

    2022-01-07 18:07:57
    GmtModified

    string

    最終更新時間。

    2022-01-07T10:07:57.000+0000
    RouteOrder

    integer

    ルート次数。

    1
    Predicates

    string

    照合条件。

    {}
    RoutePredicates

    object

    ルート照合。

    PathPredicates

    object

    ルート照合。

    Path

    string

    パス。

    /api
    Type

    string

    照合タイプ。

    PRE
    IgnoreCase

    boolean

    大文字と小文字を区別するかどうか。

    true
    MethodPredicates

    array

    メソッド照合。

    string

    メソッド。

    GET
    HeaderPredicates

    array

    ヘッダー照合。

    object

    リクエストヘッダー。

    Key

    string

    リクエストヘッダー KEY。

    id
    Value

    string

    照合値。

    200
    Type

    string

    タイプ。

    PRE
    QueryPredicates

    array

    パラメーター照合。

    object

    パラメーター。

    Key

    string

    パラメーター名。

    userid
    Value

    string

    照合値。

    test
    Type

    string

    タイプ。

    PRE
    DomainId

    integer

    ドメイン ID。

    235
    DomainName

    string

    ドメイン名。

    123.com
    Services

    string

    サービス構成情報。

    [{\"Percent\":100,\"ServiceId\":126}]
    RouteServices

    array

    サービス。

    object

    サービス。

    ServiceId

    integer

    サービス ID。

    782
    ServiceName

    string

    サービス名。

    xkc-crm
    Percent

    integer

    重み。

    80
    Version

    string

    サービスバージョン。

    v1
    Name

    string

    サービス名。

    dubbo4
    SourceType

    string

    サービスソース。

    MSE
    Namespace

    string

    名前空間。

    acs_ecs_dashboard
    GroupName

    string

    サービス グループ名。

    api
    AgreementType

    string

    プロトコルタイプ。

    DUBBO
    HttpDubboTranscoder

    object

    Dubbo プロトコル変換本文。

    DubboServiceName

    string

    Dubbo サービス名。

    DubboServiceVersion

    string

    Dubbo サービスバージョン。

    MothedMapList

    array

    Dubbo 転送ルールリスト。

    object

    DubboMothedName

    string

    Dubbo メソッド名。

    HttpMothed

    string

    HTTP メソッド。

    説明

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

    • ALL_GET

    • ALL_POST

    • ALL_PUT

    • ALL_DELETE

    • ALL_PATCH

    Mothedpath

    string

    メソッド照合パス。

    PassThroughAllHeaders

    string

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

    説明

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

    • すべてパススルー: PASS_ALL

    • パススルーなし: PASS_NOT

    • 指定されたパラメーター: PASS_ASSIGN

    PassThroughList

    array

    指定されたヘッダー パススルーリスト。

    string

    指定されたヘッダー パススルー値。

    ParamMapsList

    array

    パラメーター マッピングリスト。

    object

    ExtractKeySpec

    string

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

    説明

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

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

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

    • リクエストの URI: ALL_PATH

    • リクエスト本文: ALL_BODY

    ExtractKey

    string

    入力パラメーター抽出キー。

    MappingType

    string

    バックエンド パラメータータイプ。

    DubboServiceGroup

    string

    Dubbo サービス グループ。

    ServicePort

    integer

    サービスポート。

    20880
    HealthStatus

    string

    ヘルスステータス

    • 正常

    • 異常

    • チェック中

    • 不明

    Health
    UnhealthyEndpoints

    array

    異常なエンドポイントリスト

    string

    異常なエンドポイント

    192.168.1.2
    HTTPRewrite

    object

    書き換えポリシー情報。

    Status

    string

    有効化ステータス。

    off
    Path

    string

    ノードパス。

    /test/client
    Host

    string

    インスタンスアドレス。

    aliyuncs.com
    PathType

    string

    書き換えタイプ。

    PRE
    Pattern

    string

    照合パターン。

    /test
    Substitution

    string

    置換。

    test
    HeaderOp

    object

    ヘッダー設定情報。

    Status

    string

    ステータス。

    off
    HeaderOpItems

    array

    ヘッダーフィールドオブジェクト。

    object

    設定ポリシー。

    DirectionType

    string

    リクエストまたはレスポンス。

    Response
    OpType

    string

    操作タイプ。

    Add
    Key

    string

    ヘッダーキー。

    debug
    Value

    string

    設定値。

    test
    DestinationType

    string

    ターゲット サービス タイプ。

    Single
    DirectResponse

    object

    モック情報。

    Code

    integer

    レスポンスコード。

    200
    Body

    string

    モック戻り値。

    {}
    Cors

    object

    クロスドメイン構成。

    Status

    string

    ステータス。

    off
    AllowOrigins

    string

    クロスドメイン。

    *
    AllowMethods

    string

    クロスドメインメソッド。

    GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH
    AllowHeaders

    string

    クロスドメインヘッダー。

    *
    ExposeHeaders

    string

    レスポンスヘッダー。

    *
    TimeUnit

    string

    時間単位。

    h
    UnitNum

    integer

    時間数。

    24
    AllowCredentials

    boolean

    資格情報を許可する。

    true
    Timeout

    object

    タイムアウト構成。

    UnitNum

    integer

    時間数。

    10
    TimeUnit

    string

    時間単位。

    s
    Status

    string

    ステータス。

    off
    Retry

    object

    リトライ構成。

    Attempts

    integer

    リトライ試行回数。

    1
    RetryOn

    array

    リトライ条件。

    string

    リトライ条件。

    5xx
    HttpCodes

    array

    HTTP ステータスコード。

    string

    HTTP ステータスコード。

    500
    Status

    string

    リトライステータス。

    on
    DomainIdList

    array

    ドメインリスト

    integer

    ドメイン ID リスト。

    1
    DomainNameList

    array

    ドメイン名リスト

    string

    ドメイン名リスト。

    test.com
    Redirect

    object

    リダイレクト構成

    Code

    integer

    レスポンスコード。

    200
    Host

    string

    ホスト。

    16
    Path

    string

    パス。

    10111
    FlowMirror

    object

    トラフィック ミラーリング構成。

    TargetServiceId

    integer

    ターゲット サービス ID。

    21
    TargetServiceName

    string

    ターゲット サービス名。

    test
    Port

    integer

    ターゲット サービスポート。

    8790
    Percentage

    integer

    トラフィック レプリケーションの割合 (%)、値の範囲は 0 ～ 100 です。

    90
    Status

    string

    有効化ステータス、値:

    • on: 有効

    • off: 無効

    on
    EnableWaf

    boolean

    Waf を有効にするかどうか。

    true
    AhasStatus

    integer

    Ahas ステータス。

    1
    Fallback

    boolean

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

    true
    FallbackServices

    array

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

    object

    データオブジェクト。

    ServiceId

    integer

    サービス ID。

    1
    ServiceName

    string

    サービス名。

    name
    Percent

    integer

    重み割合。

    80
    Version

    string

    サービスバージョン。

    v1
    Name

    string

    名前。

    name
    SourceType

    string

    ソースタイプ。

    MSE
    Namespace

    string

    サービス名前空間。

    namespace
    GroupName

    string

    サービス グループ名。

    test
    AgreementType

    string

    プロトコルタイプ。

    DUBBO
    ServicePort

    integer

    サービスポート。

    8848
    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

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "FDF2D16C-5D28-5FAA-A56B-30BDE3559880",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 1050,
    "Name": "test",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "GatewayId": 1,
    "DefaultServiceId": 3,
    "DefaultServiceName": "test",
    "Status": 0,
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "RouteOrder": 1,
    "Predicates": "{}",
    "RoutePredicates": {
      "PathPredicates": {
        "Path": "/api",
        "Type": "PRE",
        "IgnoreCase": true
      },
      "MethodPredicates": [
        "GET"
      ],
      "HeaderPredicates": [
        {
          "Key": "id",
          "Value": "200",
          "Type": "PRE"
        }
      ],
      "QueryPredicates": [
        {
          "Key": "userid",
          "Value": "test",
          "Type": "PRE"
        }
      ]
    },
    "DomainId": 235,
    "DomainName": "123.com",
    "Services": "[{\\\"Percent\\\":100,\\\"ServiceId\\\":126}]",
    "RouteServices": [
      {
        "ServiceId": 782,
        "ServiceName": "xkc-crm",
        "Percent": 80,
        "Version": "v1",
        "Name": "dubbo4",
        "SourceType": "MSE",
        "Namespace": "acs_ecs_dashboard",
        "GroupName": "api",
        "AgreementType": "DUBBO",
        "HttpDubboTranscoder": {
          "DubboServiceName": "",
          "DubboServiceVersion": "",
          "MothedMapList": [
            {
              "DubboMothedName": "",
              "HttpMothed": "",
              "Mothedpath": "",
              "PassThroughAllHeaders": "",
              "PassThroughList": [
                ""
              ],
              "ParamMapsList": [
                {
                  "ExtractKeySpec": "",
                  "ExtractKey": "",
                  "MappingType": ""
                }
              ]
            }
          ],
          "DubboServiceGroup": ""
        },
        "ServicePort": 20880,
        "HealthStatus": "Health",
        "UnhealthyEndpoints": [
          "192.168.1.2"
        ]
      }
    ],
    "HTTPRewrite": {
      "Status": "off",
      "Path": "/test/client",
      "Host": "aliyuncs.com",
      "PathType": "PRE",
      "Pattern": "/test",
      "Substitution": "test"
    },
    "HeaderOp": {
      "Status": "off",
      "HeaderOpItems": [
        {
          "DirectionType": "Response",
          "OpType": "Add",
          "Key": "debug",
          "Value": "test"
        }
      ]
    },
    "DestinationType": "Single",
    "DirectResponse": {
      "Code": 200,
      "Body": "{}"
    },
    "Cors": {
      "Status": "off",
      "AllowOrigins": "*",
      "AllowMethods": "GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH",
      "AllowHeaders": "*",
      "ExposeHeaders": "*",
      "TimeUnit": "h",
      "UnitNum": 24,
      "AllowCredentials": true
    },
    "Timeout": {
      "UnitNum": 10,
      "TimeUnit": "s",
      "Status": "off"
    },
    "Retry": {
      "Attempts": 1,
      "RetryOn": [
        "5xx"
      ],
      "HttpCodes": [
        "500"
      ],
      "Status": "on"
    },
    "DomainIdList": [
      1
    ],
    "DomainNameList": [
      "test.com"
    ],
    "Redirect": {
      "Code": 200,
      "Host": "16",
      "Path": "10111"
    },
    "FlowMirror": {
      "TargetServiceId": 21,
      "TargetServiceName": "test",
      "Port": 8790,
      "Percentage": 90,
      "Status": "on"
    },
    "EnableWaf": true,
    "AhasStatus": 1,
    "Fallback": true,
    "FallbackServices": [
      {
        "ServiceId": 1,
        "ServiceName": "name",
        "Percent": 80,
        "Version": "v1",
        "Name": "name",
        "SourceType": "MSE",
        "Namespace": "namespace",
        "GroupName": "test",
        "AgreementType": "DUBBO",
        "ServicePort": 8848
      }
    ],
    "Policies": "{\n      \"CORS\": \"{\\\"allowMethods\\\":\\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\\",\\\"allowHeaders\\\":\\\"*\\\",\\\"exposeHeaders\\\":\\\"*\\\",\\\"unitNum\\\":12,\\\"allowCredentials\\\":true,\\\"status\\\":\\\"off\\\",\\\"allowOrigins\\\":\\\"*\\\",\\\"timeUnit\\\":\\\"h\\\"}\",\n      \"Timeout\": \"{\\\"unitNum\\\":10,\\\"timeUnit\\\":\\\"s\\\",\\\"status\\\":\\\"off\\\"}\",\n      \"Retry\": \"{\\\"attempts\\\":2,\\\"retryOn\\\":[\\\"5xx\\\"],\\\"status\\\":\\\"off\\\"}\",\n      \"HTTPRewrite\": \"{\\\"pathType\\\":\\\"EQUAL\\\",\\\"path\\\":\\\"/o\\\",\\\"status\\\":\\\"off\\\"}\",\n      \"Waf\": \"{\\\"enabled\\\":false}\",\n      \"HeaderOp\": \"{\\\"status\\\":\\\"off\\\",\\\"headerOpItems\\\":[{\\\"directionType\\\":\\\"Request\\\",\\\"opType\\\":\\\"Add\\\",\\\"key\\\":\\\"kkk\\\",\\\"value\\\":\\\"ll\\\"}]}\"\n}",
    "Description": "a route for xxx"
  }
}

    エラーコード

    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

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

    変更履歴

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