Kueri daftar hitam dan daftar putih gateway melalui API - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengambil blacklist dan whitelist gateway.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
PageNumber	integer	No	Nomor halaman. Rentang nilai: bilangan bulat lebih besar dari 0. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai default: 1.	1
FilterParams	object	No	parse dari filterParams
GatewayId	integer	No	ID gateway.	81
GatewayUniqueId	string	No	Pengenal unik gateway (apabila GatewayId dan GatewayUniqueId keduanya ada, GatewayId memiliki prioritas).	gw-5017305290e14centbrveca****
ResourceType	string	No	Belum tersedia untuk digunakan.	""
Type	string	No	Belum tersedia untuk digunakan.	""
IsWhite	boolean	No	Belum tersedia untuk digunakan.	""
SearchType	string	No	Tipe pencarian: ROUTE: Pencarian berdasarkan route, isi nama route pada SearchContent DOMAIN: Pencarian berdasarkan nama domain, isi nama domain pada SearchContent IP: Pencarian berdasarkan IP yang ditentukan, isi IP pada SearchContent	IP
SearchContent	string	No	Konten pencarian.	1.1.1.1
OrderItem	string	No	Belum tersedia untuk digunakan.	""
DescSort	boolean	No	Belum tersedia untuk digunakan.	""
AcceptLanguage	string	No	Bahasa untuk menampilkan hasil yang dikembalikan. Nilai: zh (default): Bahasa Mandarin, en: Bahasa Inggris	zh

Elemen respons

Element	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	ID permintaan.	58E06A0A-BD2C-47A0-99C2-B100F353****
Success	boolean	Hasil permintaan. Nilai valid: `true`: Permintaan berhasil. `false`: Permintaan gagal.	true
Code	integer	Kode ini hanya digunakan untuk sinkronisasi dengan success	200
ErrorCode	string	Kode error.	Success
HttpStatusCode	integer	Kode status HTTP.	200
Message	string	Pesan yang dikembalikan.	OK
DynamicCode	string	Placeholder dalam pesan error dinamis. Saat ini tidak digunakan, harap diabaikan.	code
DynamicMessage	string	Pesan dinamis. Saat ini tidak digunakan, harap diabaikan.	The specified parameter is invalid.
Data	object	Data yang dikembalikan.
PageNumber	integer	Nomor halaman dari daftar instance	1
TotalSize	integer	Jumlah total instance yang ditemukan	1
PageSize	integer	Jumlah baris per halaman yang diatur saat input	1
Result	array<object>	Koleksi yang dikembalikan.
	object
Id	integer	The blacklist or whitelist ID.	549
ResourceId	integer	The resource ID.	549
ResourceType	string	Effective granularity: GATEWAY: Gateway global DOMAIN: Domain name ROUTE: Route	GATEWAY
Content	string	The blacklist content.	1.1.1.1
IsWhite	boolean	Indicates whether it is a whitelist.	true
Type	string	The blacklist or whitelist type, currently fixed as IP blacklist or whitelist.	IP
Status	string	The blacklist or whitelist status. on: Enabled off: Disabled	on
GatewayId	integer	The gateway ID.	81
GatewayUniqueId	string	The unique identifier of the gateway.	gw-5017305290e14centbrveca****
GmtCreate	string	The creation time.	2024-08-02T02:43:40.000+0000
GmtModified	string	The modification time.	2024-08-02T02:43:40.000+0000
ResourceIdJsonList	string	The JSON list of resource IDs. If ResourceType is ROUTE, this is a list of route IDs If ResourceType is DOMAIN, this is a list of domain name IDs	[234]
Note	string	The remarks.	禁止的IP列表
ResourceIdNameJson	string	The resource name description.	{}
Name	string	The blacklist name.	test

Contoh

Respons sukses

JSONformat

{
  "RequestId": "58E06A0A-BD2C-47A0-99C2-B100F353****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "OK",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "PageNumber": 1,
    "TotalSize": 1,
    "PageSize": 1,
    "Result": [
      {
        "Id": 549,
        "ResourceId": 549,
        "ResourceType": "GATEWAY",
        "Content": "1.1.1.1",
        "IsWhite": true,
        "Type": "IP",
        "Status": "on",
        "GatewayId": 81,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GmtCreate": "2024-08-02T02:43:40.000+0000",
        "GmtModified": "2024-08-02T02:43:40.000+0000",
        "ResourceIdJsonList": "[234]",
        "Note": "禁止的IP列表",
        "ResourceIdNameJson": "{}",
        "Name": "test"
      }
    ]
  }
}

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.