ListGatewayAuth - 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:ListGatewayAuth

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりに表示されるインスタンスの数。	10
OrderItem	string	任意	まだ使用できません。	{}
DescSort	boolean	任意	ソートの順序。	false。
FilterParams	object	任意	フィルター条件。例を参照してください。
Name	string	任意	パラメーター名。	rutain-test。
Type	string	任意	タイプ。	JWT。
Status	boolean	任意	有効化ステータス。	true。
IsWhite	boolean	任意	ホワイトリストモード。	true。
GatewayUniqueId	string	任意	ゲートウェイの一意の ID。	gw-5017305290e14centbrveca****
		任意	返される結果の言語。有効な値: zh (デフォルト): 中国語、en: 英語。	zh

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	EC1EED4A-B147-597B-B949-FD3131AB4298
HttpStatusCode	integer	HTTP 状態コード。	200
Message	string	エラーメッセージ。	リクエストが正常に処理されました。
Code	integer	状態コード。値が 200 の場合は成功を示します。	200
Success	boolean	リクエスト結果。有効な値:	true。
Data	object	返されたデータ。
TotalSize	integer	エントリの総数。	9
PageNumber	integer	ページ番号。	1
PageSize	integer	ページサイズ。	10
Result	array<object>	返された結果。
	array<object>	返された結果。
Id	integer		549
Name	string		test
GatewayUniqueId	string		gw-e2d226bba4b2445c9e29fa7f8216****
GatewayId	integer		1
Type	string		JWT
Issuer	string		https://example.com/auth
Jwks	string		{\"keys\":[{\"kty\":\"oct\",\"k\":\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\",\"alg\":\"HS256\"}]}
TokenPosition	string		HEADER
TokenName	string		Authorization
TokenNamePrefix	string		Bearer
GmtCreate	string		2021-09-13 19:24:23
GmtModified	string		2021-09-13 19:24:23
TokenPass	boolean		true
IsWhite	boolean		true
Status	boolean		true
RedirectUrl	string		http://test.com/oauth2/callback
ClientId	string		app_mnvxaavggw7hcdcnr6usi6***
ClientSecret	string		CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
CookieDomain	string		test.com
ScopesList	string		["openid"]
LoginUrl	string		https://daxxxxcn.aliyunidaas.com/
Sub	string		example-app
ExternalAuthZ	object
ServiceId	integer		45186
PrefixPath	string		/auth
TokenKey	string		Authorization
AllowRequestHeaders	array
	string		x-req
AllowUpstreamHeaders	array
	string		x-resp
Timeout	integer		30
WithRequestBody	boolean		true
WithRematchRoute	boolean		true
BodyMaxBytes	integer		1024
IsRestrict	boolean		true
Service	object
Name	string		updatetime
SourceType	string		MSE
GroupName	string		com.mse.console.test.3YXO
Namespace	string		default
AuthResourceMode	integer		0

例

成功レスポンス

JSONJSON

{
  "RequestId": "EC1EED4A-B147-597B-B949-FD3131AB4298",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 549,
        "Name": "test",
        "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
        "GatewayId": 1,
        "Type": "JWT",
        "Issuer": "https://example.com/auth",
        "Jwks": "{\\\"keys\\\":[{\\\"kty\\\":\\\"oct\\\",\\\"k\\\":\\\"9V9lpiuAQsME1efQChI0kEQz6fdVlJbDRFFa1lvEB_A\\\",\\\"alg\\\":\\\"HS256\\\"}]}",
        "TokenPosition": "HEADER",
        "TokenName": "Authorization",
        "TokenNamePrefix": "Bearer",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2021-09-13 19:24:23",
        "TokenPass": true,
        "IsWhite": true,
        "Status": true,
        "RedirectUrl": "http://test.com/oauth2/callback",
        "ClientId": "app_mnvxaavggw7hcdcnr6usi6***",
        "ClientSecret": "CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****",
        "CookieDomain": "test.com",
        "ScopesList": "[\"openid\"]",
        "LoginUrl": "\t\nhttps://daxxxxcn.aliyunidaas.com/",
        "Sub": "example-app",
        "ExternalAuthZ": {
          "ServiceId": 45186,
          "PrefixPath": "/auth",
          "TokenKey": "Authorization",
          "AllowRequestHeaders": [
            "x-req"
          ],
          "AllowUpstreamHeaders": [
            "x-resp"
          ],
          "Timeout": 30,
          "WithRequestBody": true,
          "WithRematchRoute": true,
          "BodyMaxBytes": 1024,
          "IsRestrict": true,
          "Service": {
            "Name": "updatetime",
            "SourceType": "MSE",
            "GroupName": "com.mse.console.test.3YXO",
            "Namespace": "default"
          }
        },
        "AuthResourceMode": 0
      }
    ]
  }
}

エラーコード

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

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

変更履歴

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