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

get

*Gateway

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	任意	認証 ID。	1100
GatewayId	integer	任意	ゲートウェイ ID。このパラメーターまたは `GatewayUniqueId` を指定します。	2274
GatewayUniqueId	string	任意	一意のゲートウェイ ID。このパラメーターまたは `GatewayId` を指定します。両方を指定した場合、`GatewayUniqueId` が優先されます。	gw-6f0dbd108a0249d2b675b3ef50b*****
AcceptLanguage	string	任意	応答の言語。有効な値： `zh` (デフォルト)：中国語 `en`：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	応答スキーマ。
RequestId	string	リクエスト ID。	9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6
HttpStatusCode	integer	HTTP ステータスコード。	200
Message	string	返されたメッセージ。	OK
Code	integer	応答コード。この値は `Success` パラメーターと同期されます。`Success` が `true` の場合、このパラメーターの値は `200` です。	200
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	object	認証の詳細。
Id	integer	認証 ID。	1100
Name	string	認証の名前。	test
GatewayUniqueId	string	関連付けられたゲートウェイの一意の ID。	gw-6f0dbd108a0249d2b675b3ef50b*****
GatewayId	integer	関連付けられたゲートウェイの ID。	2274
Type	string	認証タイプ。有効な値： `JWT` `OIDC` `IDaaS` `ExternalAuthZ`：カスタム認証サービスを表します。	JWT
Issuer	string	トークンの発行者。このパラメーターは、認証タイプが `JWT` または `OIDC` の場合にのみ返されます。タイプが `JWT` の場合、このパラメーターは JWT クレームの発行者 (`iss`) を示します。タイプが `OIDC` の場合、このパラメーターは OIDC クレームの発行者 (`iss`) を示します。	https://example.com/auth
Jwks	string	JWT 公開鍵 (JSON 形式)。	{\n \"keys\":[\n {\n \"kty\": \"RSA\",\n \"e\": \"AQAB\",\n \"use\": \"sig\",\n \"kid\": \"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\",\n \"alg\": \"RS256\",\n \"n\": \"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\"\n }\n ]\n}\n
IsWhite	boolean	権限付与モード。 `true`：ホワイトリストモード。リスト内のホストとパスへのリクエストは認証をバイパスできます。他のすべてのリクエストには認証が必要です。 `false`：ブラックリストモード。リスト内のホストとパスへのリクエストには認証が必要です。他のすべてのリクエストは認証をバイパスできます。	true
GmtCreate	string	認証が作成された時刻 (GMT)。	2024-02-19T02:41:03.000+0000
GmtModified	string	認証が最後に変更された時刻 (GMT)。	2024-02-19T02:41:03.000+0000
TokenPosition	string	JWT の場所。 `HEADER`：トークンはリクエストヘッダーで渡されます。	HEADER
TokenName	string	トークンを伝達するリクエストヘッダーの名前。通常、これは `Authorization` です。	Authorization
TokenNamePrefix	string	JWT トークンのプレフィックス。	Bearer
TokenPass	boolean	認証後にトークンをバックエンドサービスに渡すかどうかを指定します。	true
Status	boolean	認証が有効かどうかを示します。	false
RedirectUrl	string	OIDC または IDaaS 認証が成功した場合のリダイレクト URL。この URL は、ご利用の ID プロバイダーで設定されたものと一致する必要があります。	https://yourdomain/path
ClientId	string	OIDC または IDaaS サービスに登録されたアプリケーション ID。	example-app
ClientSecret	string	OIDC または IDaaS サービスに登録されたアプリケーションシークレット。	xxxxx
CookieDomain	string	OIDC または IDaaS 認証が成功した後にログインセッションを維持するために使用されるクッキードメイン。	hello.com
ScopesList	string	OIDC 認証のスコープ。	["openid","email"]
LoginUrl	string	IDaaS 認証のユーザーサインインページの URL。	https://daxxxxcn.aliyunidaas.com/
Sub	string	JWT クレームの主題 (`sub`)。認証タイプが `JWT` の場合に返されます。	https://example.com/auth
ExternalAuthZ	object	カスタム認証の詳細。
ServiceId	integer	認証サービス ID。	15300
PrefixPath	string	認証 API のパス。	/auth
TokenKey	string	トークンを含むリクエストヘッダー (例：`Authorization`、`Cookie`)。	Authorization
AllowRequestHeaders	array	許可されるリクエストヘッダー。
	string	許可されるリクエストヘッダーの名前。	x-req
AllowUpstreamHeaders	array	許可されるレスポンスヘッダー。
	string	許可されるレスポンスヘッダーの名前。	x-resp
Timeout	integer	認証サービスのタイムアウト (秒単位)。	10
IsRestrict	boolean	カスタム認証モード。 `true`：厳格モード。認証サービスが利用できない場合 (接続障害や 5xx エラーなど)、ゲートウェイはクライアントリクエストを拒否します。 `false`：緩いモード。認証サービスが利用できない場合、ゲートウェイはクライアントリクエストが認証をバイパスすることを許可します。	true
Service	object	認証サービスの詳細。
Name	string	認証サービスの名前。	httpbin-auth-service
SourceType	string	認証サービスのソースタイプ。	K8s
GroupName	string	認証サービスが属するグループ。	test
Namespace	string	認証サービスの名前空間。	default
WithRequestBody	boolean	リクエストボディを認証サービスに転送するかどうかを指定します。	true
BodyMaxBytes	integer	リクエストボディの最大サイズ (バイト単位)。	4000000
WithRematchRoute	boolean	認証後にルートを再一致させるかどうかを指定します。
ResourceList	array<object>	権限付与ルールのリスト。これらのルールは論理和 (OR) を使用して結合されます。各ルール内では、すべての一致条件が満たされる必要があります (論理積 AND)。
	array<object>	権限付与ルール。
Id	integer	権限付与ルールの ID。	1303
AuthId	integer	このルールが属する認証の ID。	2274
DomainId	integer	ルール内のドメイン名の ID。	1765
DomainName	string	ルール内のドメイン名。	example.com
Path	string	ルールのパスパターン。	/test
IsWhite	boolean	権限付与モード。 `true`：ホワイトリストモード。リスト内のホストとパスへのリクエストは認証をバイパスできます。他のすべてのリクエストには認証が必要です。 `false`：ブラックリストモード。リスト内のホストとパスへのリクエストには認証が必要です。他のすべてのリクエストは認証をバイパスできます。	true
GatewayId	integer	関連付けられたゲートウェイの ID。	2274
GatewayUniqueId	string	関連付けられたゲートウェイの一意の ID。	gw-6f0dbd108a0249d2b675b3ef50b*****
GmtCreate	string	権限付与ルールが作成された時刻 (GMT)。	2024-02-19T03:32:38.000+0000
GmtModified	string	権限付与ルールが最後に変更された時刻 (GMT)。	2024-02-19T03:32:38.000+0000
MatchType	string	リクエストパスの一致タイプ。有効な値： `EQUAL`：完全一致 `PRE`：プレフィックス一致 `REGULAR`：正規表現一致	EQUAL
IgnoreCase	boolean	パスの一致で大文字と小文字を区別するかどうかを指定します。 `true`：パスの一致で大文字と小文字は区別されません。 `false`：パスの一致で大文字と小文字は区別されます。	true
AuthResourceHeaderList	array<object>	リクエストヘッダーに基づく一致条件のリスト。このパラメーターはカスタム認証にのみ適用されます。
	object
HeaderKey	string	リクエストヘッダーの名前。	x-req
HeaderMethod	string	一致条件。有効な値： `EQUAL`：等しい `NOT_EQUAL`：等しくない `EXIST`：存在する `NOT_EXIST`：存在しない `INCLUDE`：含む `EXCLUDE`：含まない `PREFIX`：前方一致 `SUFFIX`：後方一致 `REGEX`：正規表現に一致する	EQUAL
HeaderValue	string	一致させるヘッダー値。	123
AuthResourceMode	integer	権限付与リソースモード。有効な値： `0`：シンプルモード `1`：複雑モード	0
AuthResourceConfig	string	複雑モードの YAML 設定。	permissions: - not_rule: or_rules: rules: - and_rules: rules: - url_path: path: ignore_case: false prefix: /version - and_rules: rules: - url_path: path: ignore_case: false prefix: /header

例

成功レスポンス

JSONJSON

{
  "RequestId": "9C96CDF8-9E6C-XXXX-XXXX-8F87A10117E6",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 1100,
    "Name": "test",
    "GatewayUniqueId": "gw-6f0dbd108a0249d2b675b3ef50b*****",
    "GatewayId": 2274,
    "Type": "JWT",
    "Issuer": "https://example.com/auth",
    "Jwks": "{\\n  \\\"keys\\\":[\\n    {\\n      \\\"kty\\\": \\\"RSA\\\",\\n      \\\"e\\\": \\\"AQAB\\\",\\n      \\\"use\\\": \\\"sig\\\",\\n      \\\"kid\\\": \\\"1rGufmH1YN8rqM9ZOLgo7eEST3AnL89Y-m-XGFioLoA\\\",\\n      \\\"alg\\\": \\\"RS256\\\",\\n      \\\"n\\\": \\\"rM2GIc0YTMqwNCwXnjKbW5QndkCEZgyLu3uQUnyZF7HvMTekiTvQg_39mg3dV1eaYYkYfZBogyroJBqAQXhk6VVCxlBjFVp2xstJPVWngMOOlcafwN_BKdN-EQ06O_Uu__e7gNKI3DunkNk0cNaFETE7d4meRYyTlgEzYgsrW05_ufR0BKoddL3E5JsCpUxRjH9ICbodBx0U74W6Dcci-R2EA1DBrEcboE6n90uoJs6UJNriAK_71nAsYonihU5aQFFnyPTkJHfRwHK6JlME6rn-b-rpLSpdyc6U1nOFZP2DEpz8U5FrYoLYSZIU-MQGxDhCnGc_rxl2IyP9B2qcCQ\\\"\\n    }\\n  ]\\n}\\n",
    "IsWhite": true,
    "GmtCreate": "2024-02-19T02:41:03.000+0000",
    "GmtModified": "2024-02-19T02:41:03.000+0000",
    "TokenPosition": "HEADER",
    "TokenName": "Authorization",
    "TokenNamePrefix": "Bearer ",
    "TokenPass": true,
    "Status": false,
    "RedirectUrl": "https://yourdomain/path",
    "ClientId": "example-app",
    "ClientSecret": "xxxxx",
    "CookieDomain": "hello.com",
    "ScopesList": "[\"openid\",\"email\"]",
    "LoginUrl": "https://daxxxxcn.aliyunidaas.com/",
    "Sub": "https://example.com/auth",
    "ExternalAuthZ": {
      "ServiceId": 15300,
      "PrefixPath": "/auth",
      "TokenKey": "Authorization",
      "AllowRequestHeaders": [
        "x-req"
      ],
      "AllowUpstreamHeaders": [
        "x-resp"
      ],
      "Timeout": 10,
      "IsRestrict": true,
      "Service": {
        "Name": " httpbin-auth-service",
        "SourceType": "K8s",
        "GroupName": "test",
        "Namespace": "default"
      },
      "WithRequestBody": true,
      "BodyMaxBytes": 4000000,
      "WithRematchRoute": false
    },
    "ResourceList": [
      {
        "Id": 1303,
        "AuthId": 2274,
        "DomainId": 1765,
        "DomainName": "example.com",
        "Path": "/test",
        "IsWhite": true,
        "GatewayId": 2274,
        "GatewayUniqueId": "gw-6f0dbd108a0249d2b675b3ef50b*****",
        "GmtCreate": "2024-02-19T03:32:38.000+0000",
        "GmtModified": "2024-02-19T03:32:38.000+0000",
        "MatchType": "EQUAL",
        "IgnoreCase": true,
        "AuthResourceHeaderList": [
          {
            "HeaderKey": "x-req",
            "HeaderMethod": "EQUAL",
            "HeaderValue": "123"
          }
        ]
      }
    ],
    "AuthResourceMode": 0,
    "AuthResourceConfig": "permissions:\n  - not_rule:\n      or_rules:\n        rules:\n        - and_rules:\n            rules:\n            - url_path:\n                path:\n                  ignore_case: false\n                  prefix: /version\n        - and_rules:\n            rules:\n            - url_path:\n                path:\n                  ignore_case: false\n                  prefix: /header"
  }
}

エラーコード

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

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

変更履歴

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