Gunakan API QueryCustomAuthConnectBlack untuk mengkueri ID klien dalam daftar hitam koneksi-ApsaraMQ untuk MQTT-Alibaba Cloud

Menanyakan ID klien dalam daftar hitam koneksi.

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

mq:QueryCustomAuthConnectBlack

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans ApsaraMQ for MQTT.	post-111****
ClientId	string	No	ID client yang akan ditanyakan.	GID_test@@@test
NextToken	string	No	Token yang menandai posisi akhir dari halaman hasil sebelumnya. Untuk memperoleh batch data berikutnya, panggil kembali operasi ini dengan menggunakan nilai NextToken yang dikembalikan oleh permintaan sebelumnya. Jika Anda memanggil operasi ini untuk pertama kali atau ingin menanyakan semua hasil, atur NextToken ke string kosong.	xOfRU60sGEwN1OlFBIL8Ew==
Size	integer	Yes	Jumlah client yang akan ditanyakan. Nilai maksimum: 100.	100

Elemen respons

Element	Type	Description	Example
	object	Skema respons.
RequestId	string	ID permintaan.	020F6A43-19E6-4B6E-B846-44EB31DF****
Code	integer	Kode status HTTP. Kode status 200 menunjukkan bahwa permintaan berhasil. Kode status lain menunjukkan bahwa permintaan gagal. Untuk daftar kode kesalahan, lihat Error codes.	200
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true dan false.	True
Message	string	Pesan yang dikembalikan.	operation success.
Data	object	Data yang dikembalikan.
Results	array<object>	Hasil yang dikembalikan.
	object
ClientId	string	ID client.	GID_TEST@@@test
Effect	string	Menunjukkan apakah akses diizinkan atau ditolak.	ALLOW
PermitAction	string	Izin yang diberikan.	CONNECT
NextToken	string	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru.	AAAAAZ0cM0HTqLXvgm7oMHWXcvc=

Contoh

Respons sukses

JSONformat

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "ClientId": "GID_TEST@@@test",
        "Effect": "ALLOW",
        "PermitAction": "CONNECT"
      }
    ],
    "NextToken": "AAAAAZ0cM0HTqLXvgm7oMHWXcvc="
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
404	ApiNotSupport	The specified API is not supported.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.