ListGatewayAuth - Microservices Engine - Alibaba Cloud Documentation Center

Mengambil daftar aturan otentikasi gerbang.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListGatewayAuth

get

*Semua Sumber daya.

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah instans yang ditampilkan per halaman.	10
OrderItem	string	No	Belum tersedia untuk digunakan.	{}
DescSort	boolean	No	Pesanan pengurutan.	false.
FilterParams	object	No	Kondisi filter. Lihat contoh.
Name	string	No	Nama parameter.	rutain-test.
Type	string	No	Tipe.	JWT.
Status	boolean	No	Status aktif.	true.
IsWhite	boolean	No	Mode daftar putih.	true.
GatewayUniqueId	string	No	ID unik gerbang.	gw-5017305290e14centbrveca****
		No	Bahasa hasil yang dikembalikan. Nilai valid: zh (default): bahasa Mandarin, en: bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan.	EC1EED4A-B147-597B-B949-FD3131AB4298
HttpStatusCode	integer	Kode status HTTP.	200
Message	string	Paket error.	Permintaan berhasil diproses.
Code	integer	Kode status. Nilai 200 menunjukkan keberhasilan.	200
Success	boolean	Hasil permintaan. Nilai valid:	true.
Data	object	Data yang dikembalikan.
TotalSize	integer	Jumlah total entri.	9
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	10
Result	array<object>	Hasil yang dikembalikan.
	array<object>	Hasil yang dikembalikan.
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

Contoh

Respons sukses

JSONformat

{
  "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
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
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

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.