ListDeviceCredentialClientId - 查询已注册访问凭证的设备列表_云消息队列 MQTT 版(MQTT )-阿里云帮助中心

用于查询指定实例下有哪些设备申请了设备访问凭证（一机一密）。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	云消息队列 MQTT 版实例的 ID，一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面获取该 ID。	mqtt-xxxxxxxx
GroupId	string	是	微消息队列 MQTT 版的 Group ID。	GID_xxx
PageNo	string	是	查询第几页的返回结果。起始页从第 1 页开始计算。	1
PageSize	string	是	每页最多显示几条查询记录。取值范围：1~100。	100
NextToken	string	否	下一页查询开始的 Token。	FFdXXXXXWa

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceCredentialClientIdList	object	返回信息列表。
Total	string	查询结果总数。	10
ClientIdList	array	客户端列表。
	string	客户端 ID。	GID_test@@@pub-1
PageNo	string	当前返回的查询记录是第几页。	1
PageSize	string	每页显示的最大结果数。	100
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	634dxxxxx75b5f

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	ApplyTokenOverFlow	You have applied for tokens too many times. Please try again later.	申请Token频率过高，系统限流，请重试。
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	解析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.	实例权限校验失败，请确认MQTT实例的所属关系以及授权策略。
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.	资源权限校验失败，请检查实例、Topic和Group ID的所属权限和授权策略。
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.	MQTT后端服务异常，请重试。
500	SystemOverFlow	An error occurred while processing your request. Please try again.	系统限流，请重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史