ListDeviceCredentialClientId - ApsaraMQ for MQTT

Mengambil daftar klien yang telah mendaftarkan kredensial akses dalam mode autentikasi sertifikat unik per perangkat pada instans ApsaraMQ for MQTT.

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

list

*Instance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans Cloud Message Queue MQTT versi, yang harus sesuai dengan ID instans aktual yang digunakan oleh client. Anda dapat memperoleh ID ini dari halaman Instance Details di Konsol.	mqtt-xxxxxxxx
GroupId	string	Yes	Group ID versi MQTT dari micro message queue.	GID_xxx
PageNo	string	No	Menunjukkan nomor halaman hasil yang dikembalikan. Halaman awal dimulai dari 1.	1
PageSize	string	Yes	Jumlah maksimum catatan kueri yang ditampilkan per halaman.Rentang nilai: 1 hingga 100.	100
NextToken	string	No	Token untuk memulai kueri halaman berikutnya.	FFdXXXXXWa

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	Parameter publik, setiap ID permintaan bersifat unik dan dapat digunakan untuk troubleshooting dan pelokalan masalah.	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceCredentialClientIdList	object	Mengembalikan daftar informasi.
Total	string	Jumlah total hasil kueri.	10
ClientIdList	array	Daftar client.
	string	Client ID.	GID_test@@@pub-1
PageNo	string	Nomor halaman saat ini dari catatan kueri yang dikembalikan.	1
PageSize	string	Jumlah maksimum hasil yang ditampilkan per halaman.	100
NextToken	string	Menunjukkan apakah terdapat token (Token) untuk kueri berikutnya. Nilai: Untuk kueri pertama dan ketika tidak ada kueri berikutnya, bidang ini tidak perlu diisi. Jika terdapat kueri berikutnya, nilai harus berupa NextToken yang dikembalikan dari panggilan API sebelumnya.	634dxxxxx75b5f

Contoh

Respons sukses

JSONformat

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "DeviceCredentialClientIdList": {
    "Total": "10",
    "ClientIdList": [
      "GID_test@@@pub-1"
    ],
    "PageNo": "1",
    "PageSize": "100",
    "NextToken": "634dxxxxx75b5f"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ApplyTokenOverFlow	You have applied for tokens too many times. Please try again later.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.
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	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.
400	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
400	DeviceCredentialNotFound	Device Credential Not Found.Check if the device certificate is registered.
400	DeviceCredentialNumExceed	The number of device credentia exceeds the limit. Please revoke unused device certificates.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.