Kueri instans terdaftar Nacos dengan ListAnsInstances untuk discovery layanan - MSE - Alibaba Cloud - Microservices Engine

Mengkueri instans aplikasi yang terdaftar dengan instans Nacos Microservices Engine (MSE).

Deskripsi operasi

Catatan

Operasi ini tidak disediakan dalam SDK Nacos. Untuk informasi tentang SDK Nacos, lihat dokumentasi resmi.

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

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RequestPars	string	No	Parameter permintaan yang diperluas dalam format JSON.	{}
PageNum	integer	Yes	Nomor halaman yang akan dikembalikan.	1
PageSize	integer	Yes	Jumlah entri yang akan dikembalikan pada setiap halaman.	10
ClusterId `deprecated`	string	No	ID instans Nacos. Catatan Operasi ini berisi parameter InstanceId dan ClusterId. Anda harus menentukan salah satunya.	mse-09k1q11****
ServiceName	string	Yes	Nama layanan.	name
GroupName	string	No	Nama grup kontak.	test
NamespaceId	string	No	ID namespace.	12233****
ClusterName	string	No	Alias instans Nacos.	mse-7413****
InstanceId	string	No	ID instans. Catatan Operasi ini berisi parameter InstanceId dan ClusterId. Anda harus menentukan salah satunya.	mse_prepaid_public_cn-tl327w****
AcceptLanguage	string	No	Bahasa respons. Nilai yang valid: zh: Bahasa Mandarin en: Bahasa Inggris	zh

Elemen respons

Element	Type	Description	Example
	object
HttpCode	string	Kode status HTTP yang dikembalikan.	202
TotalCount	integer	Jumlah total instans yang dikembalikan.	7
RequestId	string	ID permintaan.	52BA6DA6-A702-4362-A32F-DFF79655****
Message	string	Pesan yang dikembalikan.	The request was successfully processed.
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
PageNumber	integer	Nomor halaman yang akan dikembalikan.	1
Data	array<object>	Detail data.
	array<object>
DefaultKey	string	Kunci default.	30.5.XX.XX:unknown
Ephemeral	boolean	Menunjukkan apakah informasi tentang node ephemeral diperoleh. Nilai yang valid: `true`: ya `false`: tidak	true
Marked	boolean	Menunjukkan apakah instans ditandai. Nilai yang valid: `true`: Penandaan instans berhasil. `false`: Penandaan instans gagal.	true
Ip	string	Alamat IP publik.	30.5.XX.XX
InstanceId	string	ID instans.	30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService
Port	integer	Nomor port.	8080
LastBeat	integer	Waktu heartbeat terakhir.	20201010
OkCount	integer	Jumlah keberhasilan yang dihitung.	0
Weight	integer	Bobot.	1
InstanceHeartBeatInterval	integer	Interval heartbeat instans. Satuan: detik.	5000
IpDeleteTimeout	integer	Periode timeout untuk menghapus alamat IP.	30000
App	string	Nama aplikasi.	app
FailCount	integer	Jumlah kegagalan yang dihitung.	0
Healthy	boolean	Status kesehatan instans. Nilai yang valid: `true`: Instans dalam keadaan sehat. `false`: Instans dalam keadaan tidak sehat.	true
Enabled	boolean	Status efektif instans. Nilai yang valid: `true`: Instans berlaku. `false`: Instans tidak berlaku.	true
DatumKey	string	Kunci referensi.	30.5.XX.XX:unknown:DEFAULT
ClusterName	string	Nama kluster.	DEFAULT
InstanceHeartBeatTimeOut	integer	Periode timeout heartbeat instans.	15000
ServiceName	string	Nama layanan.	DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::
Metadata	object	Metadata.	[int]
ErrorCode	string	Kode kesalahan yang dikembalikan jika permintaan gagal.	mse-100-000
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: `true`: Permintaan berhasil. `false`: Permintaan gagal.	true

Contoh

Respons sukses

JSONformat

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "DefaultKey": "30.5.XX.XX:unknown",
      "Ephemeral": true,
      "Marked": true,
      "Ip": "30.5.XX.XX",
      "InstanceId": "30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService",
      "Port": 8080,
      "LastBeat": 20201010,
      "OkCount": 0,
      "Weight": 1,
      "InstanceHeartBeatInterval": 5000,
      "IpDeleteTimeout": 30000,
      "App": "app",
      "FailCount": 0,
      "Healthy": true,
      "Enabled": true,
      "DatumKey": "30.5.XX.XX:unknown:DEFAULT",
      "ClusterName": "DEFAULT",
      "InstanceHeartBeatTimeOut": 15000,
      "ServiceName": "DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::",
      "Metadata": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "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.