Overview API Kontrol Akses Daftar Hitam dan Daftar Putih Gateway - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri blacklist atau daftar putih suatu gerbang.

Catatan

API ini telah ditinggalkan. Kami merekomendasikan migrasi ke mse(2019-05-31) - GatewayBlackWhiteList guna memperoleh fungsionalitas yang lebih baik dan dukungan berkelanjutan. Meskipun API yang telah ditinggalkan ini masih dapat diakses sementara, tidak akan ada pembaruan atau perbaikan bug lebih lanjut.

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

get

*Gateway

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ResourceType	string	No	Tipe Sumber daya.	GATEWAY
Type	string	No	Tipe.	IP
GatewayUniqueId	string	No	ID unik gerbang.	gw-32d5c9769c1842b1a2cc3426c59e****
IsWhite	boolean	No	Apakah akan mengaktifkan daftar putih.	true
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Bahasa Tionghoa en: Bahasa Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The data structure.
RequestId	string	The ID of the request.	89CBC928-4F57-51FA-A413-EE0F4CD87200
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned.	You are not authorized to perform this operation.
Code	integer	The status code returned. A value of 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The data of the node.
Id	integer	The ID.	275
ResourceId	integer	The ID of the resource.	1
ResourceType	string	The type of a resource.	GATEWAY
Content	string	The content of the blacklist.	text
Type	string	The type.	IP
IsWhite	boolean	Indicates whether the whitelist is enabled.	true
Status	string	The status of the blacklist or whitelist.	on
GatewayId	integer	The ID of the gateway.	1
GatewayUniqueId	string	The unique ID of the gateway.	gw-7ea3da97b96543e19f6c597c****
GmtCreate	string	The creation time.	2022-01-07T10:07:57.000+0000
GmtModified	string	The modification time.	2022-01-07T10:07:57.000+0000

Contoh

Respons sukses

JSONformat

{
  "RequestId": "89CBC928-4F57-51FA-A413-EE0F4CD87200",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. ",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 275,
    "ResourceId": 1,
    "ResourceType": "GATEWAY",
    "Content": "text",
    "Type": "IP",
    "IsWhite": true,
    "Status": "on",
    "GatewayId": 1,
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000"
  }
}

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.