Daftar ACL Instans Melalui API ListInstanceAcl untuk Kontrol Akses - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri daftar kontrol akses (ACL) dari sebuah instans.

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

list

*Instance

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

None

Sintaks permintaan

GET /instances/{instanceId}/acl HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans.	rmq-cn-7e22ody****

Parameter permintaan

Parameter	Type	Required	Description	Example
pageNumber	integer	No	Nomor halaman. Halaman dimulai dari halaman 1.	1
pageSize	integer	No	Jumlah entri per halaman.	10
filter	string	No	Kondisi yang Anda tentukan untuk memfilter ACL. Jika Anda tidak menentukan parameter ini, semua ACL akan dikueri.	CID-TEST

Elemen respons

Element	Type	Description	Example
	object	Hasil.
requestId	string	ID permintaan.	DA4D2F89-E2C8-5F04-936B-60D55B055FA7
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	object	Data yang dikembalikan.
pageNumber	integer	Nomor halaman.	1
pageSize	integer	Jumlah entri per halaman.	10
totalCount	integer	Jumlah total entri yang dikembalikan.	24
list	array<object>	Informasi paginasi.
	object	ACL.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
aclType	string	The ACL type. Valid value: APACHE: open source ACL. Valid values: APACHE : 开源 ACL	APACHE
username	string	The username.	test
resourceType	string	The resource type. Valid values: Group Topic Valid values: Group : 消费者组 Topic : 主题	Topic
resourceName	string	The resource name.	test
decision	string	The decision result. Valid values: Deny: Access is denied. Allow: Access is allowed. Valid values: Deny : 拒绝访问 Allow : 允许访问	Allow
actions	array	The types of the operations that are allowed by the ACL.
	string	The type of the operation that is allowed by the ACL. Valid values: SUB: message subscription. Pub: message sending. Valid values: Sub : 订阅 Pub : 发送	Pub
ipWhitelists	array	The IP address whitelists.
	string	The IP address whitelist.	0.0.0.0/0
code	string	Kode kesalahan.	MissingInstanceId
message	string	Pesan kesalahan.	The instance cannot be found.
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	InstanceId
accessDeniedDetail	string	Rincian tentang penolakan akses. Parameter ini hanya dikembalikan jika akses ditolak karena pengguna Resource Access Management (RAM) tidak memiliki izin yang diperlukan.	xxx

Contoh

Respons sukses

JSONformat

{
  "requestId": "DA4D2F89-E2C8-5F04-936B-60D55B055FA7",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 24,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "aclType": "APACHE",
        "username": "test",
        "resourceType": "Topic",
        "resourceName": "test",
        "decision": "Allow",
        "actions": [
          "Pub"
        ],
        "ipWhitelists": [
          "0.0.0.0/0"
        ]
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.