ListGreyTagRoute API リファレンス - グレースケールルール - SAE - Alibaba Cloud - Serverless App Engine

アプリケーション ID に基づいてグレースケールルールの詳細を照会します。

操作説明

説明

各アプリケーションには、グレースケールルールを 1 つだけ設定できます。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/tagroute/greyTagRouteList HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****

ScRule パラメーター

パラメーター	タイプ	例	説明
condition	String	OR	グレースケールルールの条件パターン。有効値： - AND：リスト内のすべての条件を満たす必要があります。 - OR：リスト内のいずれかの条件を満たす必要があります。
path	String	/path	Spring Cloud アプリケーションのグレースケールルールに対応するパス。
items	項目の配列		条件のリスト。

Item パラメーター

パラメーター	タイプ	例	説明
name	String	test	パラメーター名。
cond	String	==	比較演算子。有効値： >、 <、 >=、 <=、 ==、 !=
type	String	cookie	比較タイプ。有効値： - param：パラメーター。 - cookie：Cookie。 - header：ヘッダー。
value	String	test	パラメーター値。 type と name に基づいて取得された値がこの値と比較されます。
operator	String	rawvalue	オペレーター。有効値： - rawvalue：直接比較。 - list：ホワイトリスト。 - mod：Modulo 100 操作。 - deterministic_proportional_steaming_division：パーセンテージ。

DubboRule パラメーター

パラメーター	タイプ	例	説明
condition	String	OR	グレースケールルールの条件パターン。有効値： - AND：リスト内のすべての条件を満たす必要があります。 - OR：リスト内のいずれかの条件を満たす必要があります。
methodName	String	echo	Dubbo サービスのメソッド名。
serviceName	String	com.alibaba.edas.boot.EchoService	Dubbo サービスの名前。
version	String	1.0.0	Dubbo サービスのバージョン。
items	項目の配列		条件のリスト。
group	String	DUBBO	グレースケールルールに対応する Dubbo サービスのグループ。

Item パラメーター

パラメーター	タイプ	例	説明
index	Integer	0	パラメーター番号。 0 は最初のパラメーターを示します。
expr	String	.name	パラメーター値を取得するために使用される式。構文は Spring Expression Language (SpEL) に従います。有効値： - 空のままにする：現在のパラメーターの値を取得します。 - .name：パラメーターの name プロパティを取得します。これは args0.getName() と同等です。 - .isEnabled()：パラメーターの enabled プロパティを取得します。これは args0.isEnabled() と同等です。 - [0]：配列の最初の値を取得します。これは args0[0] と同等です。式はピリオド (.) で始まらないことに注意してください。 - .get(0) ：リストの最初の値を取得します。これは args0.get(0) と同等です。 - .get("key")：マップから指定されたキーに対応する値を取得します。これは args0.get("key") と同等です。
cond	String	==	比較演算子。有効値： >、 <、 >=、 <=、 ==、 !=
value	String	test	パラメーター値。 expr と index に基づいて取得された値がこの値と比較されます。
operator	String	rawvalue	オペレーター。有効値： - rawvalue：直接比較。 - list：ホワイトリスト。 - mod：Modulo 100 操作。 - deterministic_proportional_steaming_division：パーセンテージ。

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	9D29CBD0-45D3-410B-9826-52F86F90****
Message	string	追加情報。有効値：リクエストが成功した場合、success が返されます。リクエストが失敗した場合、特定のエラーコードが返されます。	success
TraceId	string	呼び出しの詳細を照会するために使用されるトレース ID。	0a98a02315955564772843261e****
Data	object	グレースケールルールに関する情報。
CurrentPage	integer	現在のページ番号。	1
PageSize	integer	ページングクエリにおける 1 ページあたりのエントリ数。値は 1 のみです。	1
TotalSize	integer	エントリの総数。値は 1 のみです。	1
Result	array<object>	返された結果。
	array<object>	返されるデータ。
GreyTagRouteId	integer	ルール ID。	1
Name	string	ルール名。	rule-name
Description	string	ルールの説明。	test
ScRules	array<object>	Spring Cloud のグレースケールルール。
	array<object>	ルールの詳細。
path	string	Spring Cloud アプリケーションのグレースケールルールに対応するパス。	/path
condition	string	グレースケールルールの条件パターン。有効値： AND：リスト内のすべての条件を満たす必要があります。 OR：リスト内のいずれかの条件を満たす必要があります。	OR
items	array<object>	条件のリスト。
	object	条件のリスト内のデータ。
type	string	比較タイプ。有効値： param：パラメーター。 cookie：Cookie。 header：ヘッダー。	cookie
name	string	パラメーター名。	test
operator	string	オペレーター。有効値： rawvalue：直接比較。 list：ホワイトリスト。 mod：Modulo 100 操作。 deterministic_proportional_steaming_division：パーセンテージ。	rawvalue
value	string	パラメーター値。 type と name に基づいて取得された値がこの値と比較されます。	test
cond	string	比較演算子。有効値： >、 <、 >=、 <=、 ==、 !=。	==
index	integer	このパラメーターは Spring Cloud アプリケーションには適用されません。	N/A
expr	string	このパラメーターは Spring Cloud アプリケーションには適用されません。	N/A
AlbRules	array<object>	Application Load Balancer (ALB) Ingress が設定されているアプリケーション用に作成されたグレースケールルール。
	array<object>	グレースケールルールの詳細。
ingressId	string	Ingress ID。	23
condition	string	グレースケールルールの条件パターン。 AND のみがサポートされており、リスト内のすべての条件を満たす必要があることを示します。	AND
items	array<object>	条件のリスト。
	object	条件のリストの詳細。
type	string	比較タイプ。有効値： sourceIp：送信元 IP。 cookie：Cookie。 header：ヘッダー。	cookie
name	string	パラメーター名。	example
operator	string	オペレーター。有効値：rawvalue のみがサポートされており、直接比較を示します。	rawvalue
value	string	パラメーター値。 type と name に基づいて取得された値がこの値と比較されます。	test
cond	string	== のみがサポートされています。	==
index	integer	このパラメーターは ALB アプリケーションには適用されません。	N/A
expr	string	このパラメーターは ALB アプリケーションには適用されません。	N/A
serviceName	string	サービス名。	s-6366-e3**-99
DubboRules	array<object>	Dubbo サービスのグレースケールルール。
	array<object>	グレースケールルールに関する情報。
serviceName	string	Dubbo サービスの名前。	com.alibaba.edas.boot.EchoService
group	string	グレースケールルールに対応する Dubbo サービスのグループ。	DUBBO
version	string	Dubbo サービスのバージョン。	1.0.0
methodName	string	Dubbo サービスのメソッド名。	echo
condition	string	グレースケールルールの条件パターン。有効値： AND：リスト内のすべての条件を満たす必要があります。 OR：リスト内のいずれかの条件を満たす必要があります。	OR
items	array<object>	条件のリスト。
	object	条件の詳細。
index	integer	パラメーター番号。 0 は最初のパラメーターを示します。	0
expr	string	パラメーター値を取得するために使用される式。構文は Spring Expression Language (SpEL) に従います。有効値：空のままにする：現在のパラメーターの値を取得します。 .name：パラメーターの name プロパティを取得します。これは args0.getName() と同等です。 .isEnabled()：パラメーターの enabled プロパティを取得します。これは args0.isEnabled() と同等です。 [0]：配列の最初の値を取得します。これは args0[0] と同等です。式はピリオド (.) で始まらないことに注意してください。 .get(0)：リストの最初の値を取得します。これは args0.get(0) と同等です。 .get("key")：マップから指定されたキーに対応する値を取得します。これは args0.get("key") と同等です。	.name
operator	string	オペレーター。有効値： rawvalue：直接比較。 list：ホワイトリスト。 mod：Modulo 100 操作。 deterministic_proportional_steaming_division：パーセンテージ。	rawvalue
value	string	パラメーター値。 expr と index に基づいて取得された値がこの値と比較されます。	test
cond	string	比較演算子。有効値： >、 <、 >=、 <=、 ==、 !=。	==
type	string	このパラメーターは Dubbo サービスには適用されません。	N/A
name	string	このパラメーターは Dubbo サービスには適用されません。	N/A
CreateTime	integer	ルールが作成されたときのタイムスタンプ。単位：ミリ秒。	1619007592013
UpdateTime	integer	ルールが更新されたときのタイムスタンプ。単位：ミリ秒。	1609434061000
ErrorCode	string	エラーコード。有効値：リクエストが成功した場合、このパラメーターは返されません。リクエストが失敗した場合、このパラメーターが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	インターフェイスのステータスまたは POP エラーコード。有効値： 2xx：リクエストは成功です。 3xx：リクエストはリダイレクトされます。 4xx：リクエストエラーが発生しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	クエリが成功したかどうかを示します。 true：クエリは成功しました。 false：クエリは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "9D29CBD0-45D3-410B-9826-52F86F90****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "PageSize": 1,
    "TotalSize": 1,
    "Result": [
      {
        "GreyTagRouteId": 1,
        "Name": "rule-name",
        "Description": "test",
        "ScRules": [
          {
            "path": "/path",
            "condition": "OR",
            "items": [
              {
                "type": "cookie",
                "name": "test",
                "operator": "rawvalue",
                "value": "test",
                "cond": "==",
                "index": 0,
                "expr": "N/A"
              }
            ]
          }
        ],
        "AlbRules": [
          {
            "ingressId": "23",
            "condition": "AND",
            "items": [
              {
                "type": "cookie",
                "name": "example",
                "operator": "rawvalue",
                "value": "test",
                "cond": "==",
                "index": 0,
                "expr": "N/A"
              }
            ],
            "serviceName": "s-6366-e3****-99**"
          }
        ],
        "DubboRules": [
          {
            "serviceName": "com.alibaba.edas.boot.EchoService",
            "group": "DUBBO",
            "version": "1.0.0",
            "methodName": "echo",
            "condition": "OR",
            "items": [
              {
                "index": 0,
                "expr": ".name",
                "operator": "rawvalue",
                "value": "test",
                "cond": "==",
                "type": "N/A",
                "name": "N/A"
              }
            ]
          }
        ],
        "CreateTime": 1619007592013,
        "UpdateTime": 1609434061000
      }
    ]
  },
  "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

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

変更履歴

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