ListListenersByConfig API untuk kueri listener konfigurasi Nacos - Microservices Engine - Alibaba Cloud - Microservices Engine

Mengkueri Pendengar berdasarkan informasi konfigurasi.

Deskripsi operasi

Catatan

The current OpenAPI is not the Nacos-SDK API. For information about the Nacos-SDK API, see Official Documentation.

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

get

*Cluster

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

*EngineNamespace

acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RequestPars	string	No	Parameter tidak digunakan lagi, tidak perlu diisi.	...
InstanceId	string	Yes	ID Instans.	mse-cn-m7r1yurp00e
DataId	string	Yes	ID data.	zeekr-clueboss.yml
Group	string	Yes	Kelompok.	prod
NamespaceId	string	No	ID namespace. Nilai default: public.	aaeb4d28-c9eb-4fa2-85f5-d03ce7ee8df1
ExtGrayRules	array<object>	No	Daftar aturan rilis canary tambahan, saat mencocokkan Pendengar, aturan rilis canary tambahan akan digabungkan dengan aturan yang ada untuk pencocokan.
	object	No	Canary rule item
GrayRuleType	string	No	Canary rule type	Tags
GrayRuleName	string	No	The canary version name.	test
GrayRule	string	No	The canary release rule. For a beta release, you can specify one or more client IP addresses for this parameter. You must separate multiple IP addresses with commas (,). For a tag-based canary release, the value is in the format of Tag name=Tag value. You must separate multiple tag values with commas (,).	127.0.0.1
GrayRulePriority	integer	No	The canary version priority.	100
AcceptLanguage	string	No	Bahasa tanggapan. Nilai valid: zh: Tiongkok en: Inggris.	zh

Elemen respons

Element	Type	Description	Example
	object	The data structure.
HttpCode	string	HTTP status code.	202
TotalCount	integer	The count.	7
Listeners	array<object>	The information about listeners.
	array<object>	The data structure.
Ip	string	The IP address.	1.1.1.1
Md5	string	The verification string.	23sdfdf
Status	string	The status.	true
Labels	object	The label of the listener.
	string	The key-value pairs of the label.	a=b
Version	string	The current version of the listener. Valid values: gray and normal.	gray
MatchRuleName	string	The name of the canary rule that matches the current listener	匹配到的灰度规则的名称
MatchRuleType	string	The type of the matched canary rule	Beta
RequestId	string	The request ID.	75E1442F-11EC-567A-9CF0-5A36F7904F39
Message	string	The response message.	success
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number to return.	2
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Contoh

Respons sukses

JSONformat

{
  "HttpCode": "202",
  "TotalCount": 7,
  "Listeners": [
    {
      "Ip": "1.1.1.1",
      "Md5": "23sdfdf",
      "Status": "true",
      "Labels": {
        "key": "a=b"
      },
      "Version": "gray",
      "MatchRuleName": "匹配到的灰度规则的名称",
      "MatchRuleType": "Beta"
    }
  ],
  "RequestId": "75E1442F-11EC-567A-9CF0-5A36F7904F39",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 2,
  "ErrorCode": "mse-100-000",
  "Success": true
}

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.