ListInstances - ApsaraMQ for RocketMQ

Mengambil daftar instans ApsaraMQ for RocketMQ di wilayah tertentu.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah layanan manajemen API yang dapat Anda gunakan untuk mengelola dan mengambil informasi mengenai resource layanan Alibaba Cloud. Integrasi OpenAPI hanya berlaku pada control plane. Jangan gunakan OpenAPI pada core data plane untuk mengirim atau menerima pesan, karena hal ini dapat menimbulkan risiko terhadap tautan data Anda.

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

rocketmq:ListInstances

list

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/*

None

Sintaks permintaan

GET /instances HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
filter	string	No	Kondisi filter. Jika Anda tidak menentukan parameter ini, semua instans akan ditanyakan.	rmq-cn-7e22ody****
pageNumber	integer	No	Nomor halaman. Nilai valid: 1 hingga 100.000.000. Jika Anda menentukan nilai kurang dari 1, sistem menggunakan 1. Jika Anda menentukan nilai lebih dari 100.000.000, sistem menggunakan 100.000.000.	1
pageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai valid: 10 hingga 200. Jika Anda menentukan nilai kurang dari 10, sistem menggunakan 10. Jika Anda menentukan nilai lebih dari 200, sistem menggunakan 200.	10
resourceGroupId	string	No	ID kelompok sumber daya tempat instans tersebut berada.	rg-acfmx7caj******
tags	string	No	Daftar tag resource yang digunakan untuk memfilter instans.	[{"key": "rmq-test", "value": "test"}]
seriesCodes	array	No	Kode seri utama instans. Nilai valid: standard: Edisi Standar ultimate: Edisi Platinum professional: Edisi Profesional dedicated: Edisi Eksklusif shared: Edisi Shared
	string	No	Kode seri utama instans.	standard
storageSecretKey	string	No	Kunci enkripsi penyimpanan.	xxxxx

Elemen respons

Element	Type	Description	Example
	object	Result<MyPage<InstanceDto>>
requestId	string	ID permintaan. ID ini unik untuk setiap permintaan. Gunakan ID ini untuk pemecahan masalah.	84445A20-2B50-5306-A3C0-AF99FC1833C6
success	boolean	Menunjukkan apakah panggilan berhasil.	true
data	object	Data yang dikembalikan.
pageNumber	integer	Nomor halaman.	1
pageSize	integer	Jumlah entri per halaman.	10
totalCount	integer	Total jumlah entri.	100
list	array<object>	Data terpaginasi.
	array<object>
regionId	string	ID wilayah tempat instans berada.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
instanceName	string	Nama instans.	test instance
status	string	Status instans. Nilai valid: RELEASED RUNNING STOPPED CHANGING CREATING Valid values: RELEASED : Dilepas RUNNING : Berjalan STOPPED : Dihentikan CHANGING : Sedang diubah CREATING : Sedang dibuat	RUNNING
startTime	string	Waktu saat instans dibuat.	2022-08-01 00:00:00
expireTime	string	Waktu kedaluwarsa instans.	2022-09-01 00:00:00
releaseTime	string	Waktu saat instans dilepas.	2022-09-07 00:00:00
userId	string	ID pengguna pemilik instans.	6W0xz2uPfiwp****
commodityCode	string	Kode komoditas instans seri ApsaraMQ for RocketMQ 5.x, seperti ons_rmqsub_public_cn.	ons_rmqsub_public_cn
serviceCode	string	Kode layanan instans. Kode layanan untuk ApsaraMQ for RocketMQ adalah rmq.	rmq
seriesCode	string	Kode seri utama instans. Nilai valid: standard: Edisi Standar Ultimate: Edisi Platinum Enterprise professional: Edisi Profesional shared: Edisi Shared dedicated: Edisi Eksklusif Valid values: standard : Edisi Standar ultimate : Edisi Platinum professional : Edisi Profesional	standard
subSeriesCode	string	Kode sub-seri instans. Nilai valid: cluster_ha: Edisi Kluster Ketersediaan Tinggi single_node: Edisi Node Tunggal serverless: Edisi Serverless Valid values: cluster_ha : Edisi Ketersediaan Tinggi single_node : Edisi Node Tunggal	cluster_ha
paymentType	string	Metode penagihan instans. Nilai valid: PayAsYouGo: Pay-as-you-go Subscription: Subscription Valid values: PayAsYouGo : Pay-as-you-go (postpaid) Subscription : Subscription (prepaid)	Subscription
remark	string	Catatan untuk instans.	This is remark for instance.
topicCount	integer	Jumlah topik yang dibuat dalam instans.	20
groupCount	integer	Jumlah kelompok konsumen yang dibuat dalam instans.	10
createTime	string	Waktu pembaruan versi instans.	2022-08-01 00:00:00
updateTime	string	Waktu terakhir instans dimodifikasi.	2022-08-02 00:00:00
resourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-acfmx7caj******
tags	array<object>	Daftar tag resource.
	object	Tag resource.
key	string	Kunci tag resource.	key
value	string	Nilai tag resource.	value
productInfo	object	Informasi produk.
traceOn	boolean	Menunjukkan apakah fitur jejak pesan diaktifkan. true: diaktifkan false: dinonaktifkan Parameter ini belum berlaku. Fitur jejak pesan didukung secara default terlepas dari apakah parameter ini diaktifkan atau tidak.	true
capacityType	string	Mode kapasitas: provisioned: reserved dan elastic ondemand: pay-as-you-go	provisioned
code	string	Kode kesalahan.	MissingPageNumber
message	string	Pesan kesalahan.	Parameter pageNumber is mandatory for this action .
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	PageNumber
dynamicMessage	string	Pesan kesalahan dinamis.	pageNumber

Contoh

Respons sukses

JSONformat

{
  "requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 100,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "instanceName": "test instance",
        "status": "RUNNING",
        "startTime": "2022-08-01 00:00:00",
        "expireTime": "2022-09-01 00:00:00",
        "releaseTime": "2022-09-07 00:00:00",
        "userId": "6W0xz2uPfiwp****",
        "commodityCode": "ons_rmqsub_public_cn",
        "serviceCode": "rmq",
        "seriesCode": "standard",
        "subSeriesCode": "cluster_ha",
        "paymentType": "Subscription",
        "remark": "This is remark for instance.",
        "topicCount": 20,
        "groupCount": 10,
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-02 00:00:00",
        "resourceGroupId": "rg-acfmx7caj******",
        "tags": [
          {
            "key": "key",
            "value": "value"
          }
        ],
        "productInfo": {
          "traceOn": true,
          "capacityType": "provisioned"
        }
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "Parameter pageNumber is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "PageNumber",
  "dynamicMessage": "pageNumber"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.