ListGatewayRoute - Microservices Engine - Alibaba Cloud ドキュメントセンター

ゲートウェイルートの一覧を照会します。

今すぐお試しください

この 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:ListGatewayRoute

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりに表示されるインスタンスの数（現在有効ではなく、デフォルトですべてのインスタンスを照会します）。	10
OrderItem	string	任意	並べ替えプロパティ。	GmtCreate
DescSort	boolean	任意	並べ替え。このフィールドは現在利用できず、廃止予定です。	false
FilterParams	object	任意	{"key1":"value1"} 形式のフィルタ条件。
GatewayId	integer	任意	ゲートウェイ ID。	81
Name	string	任意	ルート名。	test
Status	integer	任意	ルートステータス: 未公開: 0 公開中: 2 公開済み: 3 編集中（更新は公開されていません）: 4 公開取消中: 5 利用不可: 6	1
DefaultServiceId `deprecated`	integer	任意	デフォルトサービス ID。	1
RouteOrder	integer	任意	順序（未使用）。	1
DomainId	integer	任意	ドメイン ID。	284
GatewayUniqueId	string	必須	ゲートウェイ固有識別子 ID。	gw-30a0106924c94bca8712ec4e79fc5acc
DomainName	string	任意	関連付けられたドメイン	*.alites.com
Path	string	任意	ルートパス。	/test
AcceptLanguage	string	任意	返される情報の言語タイプ: zh: 中国語 en: 英語	zh

レスポンスフィールド

パラメーター	型	説明	例
	object	データ構造。
RequestId	string	リクエスト ID。	83F02EAB-ECDF-55C6-B332-8649E5E7AF2C
HttpStatusCode	integer	HTTP ステータスコード。	200
Message	string	エラーメッセージ。	You are not authorized to perform this operation.
Code	integer	コード。	200
Success	boolean	リクエスト結果。次の値があります。 `true`: リクエストは成功です。 `false`: リクエストは失敗しました。	true
Data	object	返されたデータ。
TotalSize	integer	エントリの総数。	36
PageNumber	integer	ページ番号。	11
PageSize	integer	ページサイズ。	10
Result	array	データ構造。
	object	コレクションを返します。
Id	integer	ルート ID。	47
Name	string	名前。	test
GatewayUniqueId	string	ゲートウェイ固有識別子。	gw-cf0e7f52ecc7429dbc7ba4d5e3656100
GatewayId	integer	ゲートウェイ ID。	496
Status	integer	ステータス。	2
RouteOrder	integer	順序	1
DefaultServiceName	string	デフォルトサービス名。	test
DefaultServiceId	integer	デフォルトサービス ID。	1
Predicates	string	照合ルール	{\"PathPredicates\":{\"Path\":\"/rpc/compute \",\"Type\":\"PRE\",\"IgnoreCase\":true}}
RoutePredicates	object	照合ルール
PathPredicates	object	ルートパスの照合。
Path	string	ノードパス。	/getIp
Type	string	照合タイプ。	PRE
IgnoreCase	boolean	大文字と小文字を区別しない	true
MethodPredicates	array	HTTP メソッドの照合
	string	メソッド	GET
HeaderPredicates	array	ヘッダーの照合
	object	ヘッダーリスト
Key	string	ヘッダー KEY	userid
Value	string	照合値	test
Type	string	照合タイプ	PRE
QueryPredicates	array	パラメーターの照合
	object	パラメーターリスト
Key	string	パラメーター名	userid
Value	string	照合値	test
Type	string	照合タイプ	PRE
GmtCreate	string	作成時間。	2022-01-25T07:14:01.817+0000
GmtModified	string	変更時間	2022-01-07 18:07:57
Services	string	サービス。	[]
RouteServices	array	サービス。
	object	サービスリスト
ServiceId	integer	サービス ID	1563
ServiceName	string	サービス名。	hu
Percent	integer	重み付けの割合	11
Version	string	サービスバージョン。	v1
Name	string	名前。	test
SourceType	string	ソースタイプ	MSE
Namespace	string	名前空間。	default
GroupName	string	サービスグループ名。	api
AgreementType	string	プロトコルタイプ。	DUBBO
HttpDubboTranscoder	object	Dubbo プロトコル変換本文。
DubboServiceName	string	Dubbo サービス名。	org.apache.dubbo.samples.basic.api.DemoService
DubboServiceVersion	string	Dubbo サービスバージョン。	0.0.0
MothedMapList	array	Dubbo 転送ルールリスト。
	object	メソッドマッピング本文。
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` リクエストパス: `ALL_PATH` リクエスト本文: `ALL_BODY`	ALL_QUERY_PARAMETER
ExtractKey	string	入力パラメーター抽出キー。	name
MappingType	string	バックエンドパラメータータイプ。	java.lang.String
DubboServiceGroup	string	Dubbo サービスグループ。	service group
ServicePort	integer	サービスポート。	20880
HealthStatus	string	ヘルスステータス正常異常チェック中不明	Health
UnhealthyEndpoints	array	異常なエンドポイントリスト
	string	異常なエンドポイント	192.168.1.2
DomainId	integer	ドメイン ID。	265
DomainName	string	ドメイン名。	y.com
DestinationType	string	宛先タイプ。	Single
DirectResponse	object	モック構成
Code	integer	レスポンスコード。	200
Body	string	モック戻り値	hello
DomainIdList	array	ドメインリスト。
	integer	ドメイン ID	123
DomainNameList	array	ドメイン名リスト。
	string	ドメイン名	test.com
Redirect	object	リダイレクト
Code	integer	レスポンスコード。	200
Host	string	リダイレクトホスト名	test.com
Path	string	パス。	/test
Type	string	ルートタイプ	Op
Comment	object	ルートコメント (イングレス)
Status	string	ステータス。	error
EnableWaf	string	WAF を有効にするかどうか	false
Fallback	boolean	フォールバックサービスを有効にするかどうか。	true
FallbackServices	array	フォールバックサービス。
	object
ServiceId	integer	サービス ID。	353
ServiceName	string	サービス名。	service name
Percent	integer	重み付けの割合。	100
Version	string	サービスバージョン。	v1
Name	string	名前。	name
SourceType	string	ソースタイプ。	MSE
Namespace	string	サービス名前空間。	Namespace
GroupName	string	サービスグループ名。	test
AgreementType	string	プロトコルタイプ。	DUBBO
ServicePort	integer	サービスポート。	8848
DynamicRoute	boolean	動的ルーティングを有効にするかどうか

例

成功レスポンス

JSONJSON

{
  "RequestId": "83F02EAB-ECDF-55C6-B332-8649E5E7AF2C",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 36,
    "PageNumber": 11,
    "PageSize": 10,
    "Result": [
      {
        "Id": 47,
        "Name": "test",
        "GatewayUniqueId": "gw-cf0e7f52ecc7429dbc7ba4d5e3656100",
        "GatewayId": 496,
        "Status": 2,
        "RouteOrder": 1,
        "DefaultServiceName": "test",
        "DefaultServiceId": 1,
        "Predicates": "{\\\"PathPredicates\\\":{\\\"Path\\\":\\\"/rpc/compute \\\",\\\"Type\\\":\\\"PRE\\\",\\\"IgnoreCase\\\":true}}",
        "RoutePredicates": {
          "PathPredicates": {
            "Path": "/getIp",
            "Type": "PRE",
            "IgnoreCase": true
          },
          "MethodPredicates": [
            "GET"
          ],
          "HeaderPredicates": [
            {
              "Key": "userid",
              "Value": "test",
              "Type": "PRE"
            }
          ],
          "QueryPredicates": [
            {
              "Key": "userid",
              "Value": "test",
              "Type": "PRE"
            }
          ]
        },
        "GmtCreate": "2022-01-25T07:14:01.817+0000",
        "GmtModified": "2022-01-07 18:07:57",
        "Services": "[]",
        "RouteServices": [
          {
            "ServiceId": 1563,
            "ServiceName": "hu",
            "Percent": 11,
            "Version": "v1",
            "Name": "test",
            "SourceType": "MSE",
            "Namespace": "default",
            "GroupName": "api",
            "AgreementType": "DUBBO",
            "HttpDubboTranscoder": {
              "DubboServiceName": "org.apache.dubbo.samples.basic.api.DemoService",
              "DubboServiceVersion": "0.0.0",
              "MothedMapList": [
                {
                  "DubboMothedName": "sayHello",
                  "HttpMothed": "ALL_GET",
                  "Mothedpath": "/mytestzbk/sayhello",
                  "PassThroughAllHeaders": "PASS_NOT",
                  "PassThroughList": [
                    "x-forward"
                  ],
                  "ParamMapsList": [
                    {
                      "ExtractKeySpec": "ALL_QUERY_PARAMETER",
                      "ExtractKey": "name",
                      "MappingType": "java.lang.String"
                    }
                  ]
                }
              ],
              "DubboServiceGroup": "service group"
            },
            "ServicePort": 20880,
            "HealthStatus": "Health",
            "UnhealthyEndpoints": [
              "192.168.1.2"
            ]
          }
        ],
        "DomainId": 265,
        "DomainName": "y.com",
        "DestinationType": "Single",
        "DirectResponse": {
          "Code": 200,
          "Body": "hello"
        },
        "DomainIdList": [
          123
        ],
        "DomainNameList": [
          "test.com"
        ],
        "Redirect": {
          "Code": 200,
          "Host": "test.com",
          "Path": "/test"
        },
        "Type": "Op",
        "Comment": {
          "Status": "error"
        },
        "EnableWaf": "false",
        "Fallback": true,
        "FallbackServices": [
          {
            "ServiceId": 353,
            "ServiceName": "service name",
            "Percent": 100,
            "Version": "v1",
            "Name": "name",
            "SourceType": "MSE\n",
            "Namespace": "Namespace",
            "GroupName": "test",
            "AgreementType": "DUBBO",
            "ServicePort": 8848
          }
        ],
        "DynamicRoute": true
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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