Query gateway authentication consumers using ListGatewayAuthConsumer - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri daftar konsumen tempat gerbang melakukan operasi otentikasi.

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

list

*Gateway

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	ID unik gerbang.	gw-0fe488252dc44d55a9dd57875193****
Name	string	No	Nama konsumen.	test
Type	string	No	Tipe otentikasi. Nilai valid: JWT.	JWT
ConsumerStatus	boolean	No	Status konsumen. Nilai valid: true: diaktifkan false: dinonaktifkan.	true
PageNum	string	Yes	Nomor halaman yang akan dikembalikan.	1
PageSize	string	Yes	Jumlah entri yang akan dikembalikan pada setiap halaman.	10
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Tiongkok en: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	RestResult<List>
RequestId	string	The ID of the request.	dc63-465d-8ef5-20dc18af****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The status code. A value of 200 is returned if the request is successful.	200
ErrorCode	string	The error code that is returned.	mse-100-000
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message returned.	The request is successfully processed.
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	The dynamic part in the error message. This parameter is used to replace the %s variable in the ErrMessage parameter. Catatan If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.	The specified parameter is invalid.
Data	object	The data structure.
TotalSize	integer	The total number of returned entries.	9
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
Result	array<object>	The returned information.
	object	The returned information.
Id	integer	The ID of the consumer.	1
Name	string	The name of the consumer.	test
ConsumerStatus	boolean	The status of the consumer. Valid values: true: enabled false: disabled	true
PrimaryUser	string	The creator.	123
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14centbrveca****
Type	string	The authentication type. Valid values: JWT	JWT
Description	string	The description of the consumer.	Description
GmtCreate	string	The creation time.	2021-09-13 19:24:23
GmtModified	string	The modification time.	2022-01-07 18:07:57

Contoh

Respons sukses

JSONformat

{
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "ConsumerStatus": true,
        "PrimaryUser": "123",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "Type": "JWT",
        "Description": "Description\n",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2022-01-07 18:07:57"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.