ListDeviceCredentialClientId - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries clients that have applied for access credentials in unique-certificate-per-device authentication mode in an ApsaraMQ for MQTT instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mq:MqttInstanceAccess	list	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Cloud Message Queue MQTT version instance, which must match the actual instance ID used by the client. You can obtain this ID from the Instance Details page in the console.	mqtt-xxxxxxxx
GroupId	string	Yes	Group ID of the MQTT version of the micro message queue.	GID_xxx
PageNo	string	Yes	Indicates the page number of the returned results. The starting page is counted from 1.	1
PageSize	string	Yes	The maximum number of query records to display per page. Value range: 1 to 100.	100
NextToken	string	No	Token for starting the next page query.	FFdXXXXXWa

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Public parameters, each request ID is unique and can be used for troubleshooting and problem localization.	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceCredentialClientIdList	object	Returns the information list.
Total	string	Total number of query results.	10
ClientIdList	array	Client list.
ClientIdList	string	Client ID.	GID_test@@@pub-1
PageNo	string	The current page number of the returned query records.	1
PageSize	string	The maximum number of results to display per page.	100
NextToken	string	Indicates whether there is a token (Token) for the next query. Values: For the first query and when there is no next query, this field does not need to be filled. If there is a next query, the value should be the NextToken returned from the previous API call.	634dxxxxx75b5f

Examples

Sample success responses

JSONformat

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

Error codes

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.
404	ApiNotSupport	The specified API is not supported.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history