Referensi API UpdateGatewayAuthConsumer - Microservices Engine - Alibaba Cloud - Microservices Engine

Memperbarui consumer tempat gateway melakukan operasi autentikasi.

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

*Gateway

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	ID unik gateway.	gw-90392d768a3847a7b804c505254d****
EncodeType	string	No	Tipe enkripsi. Nilai yang valid: RSA OCT	RSA
Jwks	string	No	Kunci publik JWT. Format JSON didukung.	{"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
TokenName	string	No	Nama parameter yang diperlukan untuk memverifikasi setiap token. Secara default, setiap token diawali dengan Bearer dan disimpan dalam header Authorization, seperti `Authorization: Bearer <Isi token>`.	Authorization
TokenPass	boolean	No	Menentukan apakah akan mengaktifkan pass-through.	true
TokenPosition	string	No	Posisi parameter yang diperlukan untuk memverifikasi setiap token. Secara default, setiap token diawali dengan Bearer dan disimpan dalam header Authorization, seperti `Authorization: Bearer <Isi token>`.	HEADER
TokenPrefix	string	No	Awalan parameter yang diperlukan untuk memverifikasi setiap token. Secara default, setiap token diawali dengan Bearer dan disimpan dalam header Authorization, seperti `Authorization: Bearer <Isi token>`.	Bearer
KeyName	string	No	Nama kunci yang digunakan untuk autentikasi identitas berbasis JWT.	iss
KeyValue	string	No	Nilai kunci yang digunakan untuk autentikasi identitas berbasis JWT.	abcd
Description	string	No	Deskripsi consumer.	Description
Id	integer	Yes	ID consumer.	63
AcceptLanguage	string	No	Bahasa respons. Nilai yang valid: zh: Cina en: Inggris	zh

Elemen respons

Element	Type	Description	Example
	object	RestResult<List>
RequestId	string	ID permintaan.	EE5C32A1-BC0E-4B79-817C-103E4EDF****
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: `true`: Permintaan berhasil. `false`: Permintaan gagal.	true
Code	integer	Kode status. Nilai 200 dikembalikan jika permintaan berhasil.	200
ErrorCode	string	Kode kesalahan yang dikembalikan.	mse-100-000
HttpStatusCode	integer	Kode status HTTP yang dikembalikan.	200
Message	string	Pesan kesalahan yang dikembalikan.	The request is successfully processed.
DynamicCode	string	Bagian dinamis dalam pesan kesalahan.	code
DynamicMessage	string	Bagian dinamis dalam pesan kesalahan. Parameter ini digunakan untuk menggantikan variabel %s dalam parameter ErrMessage. Catatan Jika nilai kembalian parameter ErrMessage adalah The Value of Input Parameter %s is not valid dan nilai kembalian parameter DynamicMessage adalah DtsJobId, maka parameter DtsJobId yang ditentukan tidak valid.	The specified parameter is invalid.
Data	integer	ID consumer.	2

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "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": 2
}

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.