DescribeSwimmingLane API 概要（スイムレーン構成向け） - SAE - Alibaba Cloud - Serverless App Engine

スイムレーンの詳細を取得します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/cas/gray/describeSwimmingLane HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NamespaceId	string	任意	名前空間 ID。	cn-beijing:test
GroupId	integer	任意	レーングループ ID。	2074
LaneId	integer	任意	スイムレーン ID。	9637

レスポンスフィールド

フィールド	型	説明	例
	object	返される情報。
RequestId	string	リクエスト ID。	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	レスポンスで返されるメッセージ。リクエストが成功した場合、success が返されます。リクエストが失敗した場合、エラーコードが返されます。	success
TraceId	string	トレース ID。この ID を使用して、呼び出しの詳細をクエリできます。	0a98a02315955564772843261e****
Data	object	返されたデータ。
LaneId	integer	レーン ID。	9488
LaneName	string	レーン名。	mse-test
LaneTag	string	レーンのタグ。	{"alicloud.service.tag":"g1"}
Enable	boolean	レーンが有効かどうかを示します。 `true`：有効 `false`：無効	true
EnableRules	boolean	トラフィックルールが有効かどうかを示します。	true
CanaryModel	integer	エンドツーエンドカナリアリリースのモード。有効な値： `0`：コンテンツベースのルーティング `1`：パーセンテージベースのルーティング	0
Apps	array<object>	関連付けられたアプリケーションのリスト。
	object	レーンに関連付けられているアプリケーション。
AppId	string	アプリケーション ID。	6b4c0f64-f679-4580-8105-91eac4******
AppName	string	アプリケーション名。	test
MseAppId	string	MSE インスタンスの ID。	mse-cn-53y49******
MseAppName	string	MSE インスタンスの名前。	sae-test
mseNamespaceId	string	MSE 名前空間の ID。	6733e538-d52f-48e6-91a4-192f91******
AppEntryRule	object	アプリケーションエントリルール。
Paths	array	リクエストパス。
	string	リクエストパス。	/Path
Percentage	integer	パーセンテージベースのルーティングのトラフィックの割合。有効な値：0～100。	50
ConditionJoiner	string	条件を結合する論理演算子。有効な値： `AND`：すべての条件を満たす必要があります。 `OR`：条件の少なくとも 1 つを満たす必要があります。	AND
Conditions	array<object>	一致条件。
	object	一致条件。
Type	string	パラメーターのタイプ。	Header
Name	string	パラメーターの名前。	t
Condition	string	一致演算子。	==
Value	string	一致する値。	g1
Values	array	一致する値。
	string	一致する値。	g1
IndependentPercentageEnable	boolean	パーセンテージベースのカナリアリリースが有効かどうかを示します。	true
PercentageByPath	object	パスとトラフィックの割合をマッピングするオブジェクト。
	integer	トラフィックの割合。	100
MseGatewayEntryRule	object	MSE ゲートウェイのエントリルール。
RouteIds	array	ルート ID のリスト。
	integer	ルート ID。	["1001","1002"]
Routes	array<object>	ルート構成。
	array<object>	ルート構成。
RouteId	integer	ルート ID。	9504
RouteName	string	ルートの名前。	demo
RoutePredicate	object	ルート述語。
PathPredicate	object	パスベースの一致ルール。
Path	string	パス。	/Path
Type	string	一致タイプ。	Header
Percentage	integer	ルールのトラフィックの割合。	100
Conditions	array<object>	一致条件。
	object	一致条件。
Type	string	パラメーターのタイプ。	Header
Name	string	パラメーターの名前。	t
Condition	string	一致演算子。	==
Value	string	一致する値。	g1
PercentageByRoute	object	ルート ID とトラフィックの割合をマッピングするオブジェクト。
	integer	トラフィックの割合。有効な値：1～100。	100
IndependentPercentageEnable	boolean	パーセンテージベースのカナリアリリースが有効かどうかを示します。	true
ConditionJoiner	string	条件を結合する論理演算子。	AND
ErrorCode	string	エラーコード。このパラメーターは、リクエストが失敗した場合にのみ返されます。詳細については、このトピックのエラーコードセクションをご参照ください。
Code	string	返される HTTP ステータスコード。 2xx：成功。 3xx：リダイレクト。 4xx：クライアントエラー。 5xx：サーバーエラー。	200
Success	boolean	リクエストが成功したかどうかを示します。 true：クエリは成功しました。 false：クエリは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "LaneId": 9488,
    "LaneName": "mse-test",
    "LaneTag": "{\"alicloud.service.tag\":\"g1\"}",
    "Enable": true,
    "EnableRules": true,
    "CanaryModel": 0,
    "Apps": [
      {
        "AppId": "6b4c0f64-f679-4580-8105-91eac4******",
        "AppName": "test",
        "MseAppId": "mse-cn-53y49******",
        "MseAppName": "sae-test",
        "mseNamespaceId": "6733e538-d52f-48e6-91a4-192f91******"
      }
    ],
    "AppEntryRule": {
      "Paths": [
        "/Path"
      ],
      "Percentage": 50,
      "ConditionJoiner": "AND",
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1",
          "Values": [
            "g1"
          ]
        }
      ],
      "IndependentPercentageEnable": true,
      "PercentageByPath": {
        "key": 100
      }
    },
    "MseGatewayEntryRule": {
      "RouteIds": [
        0
      ],
      "Routes": [
        {
          "RouteId": 9504,
          "RouteName": "demo\n",
          "RoutePredicate": {
            "PathPredicate": {
              "Path": "/Path",
              "Type": "Header"
            }
          }
        }
      ],
      "Percentage": 100,
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1"
        }
      ],
      "PercentageByRoute": {
        "key": 100
      },
      "IndependentPercentageEnable": true,
      "ConditionJoiner": "AND"
    }
  },
  "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
400	MseGatewayRule.CreateFailed	Create MSE Gateway rule failed.
400	InternalApiError	An exception occurred when calling mse:%s, error message: %s.

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

変更履歴

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