设备证书是由CA根证书签发给客户端设备使用的数字证书，用于客户端和服务端连接时，服务端对客户端进行安全认证。认证通过后服务端和客户端可基于证书内的加密密钥进行安全通信，若认证不通过则服务端拒绝客户端接入。 本接口用于查询由指定CA证书签发且已在微消息队列MQTT版服务端注册的所有设备证书。
接口说明
- 仅铂金版和专业版实例支持使用 ListDeviceCertificateByCaSn 接口。
- 单用户请求频率限制为 500 次/秒。如有特殊需求，请联系云消息队列 MQTT 版技术支持，钉钉群号：35228338。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mq:ListDeviceCertificateByCaSn | list | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MqttInstanceId | string | 是 | CA 证书所绑定的实例 ID，即云消息队列 MQTT 版的实例 ID。 | post-cn-7mz2d****** |
| PageNo | string | 是 | 查询第几页的返回结果。起始页从第 1 页开始计算。 | 2 |
| PageSize | string | 是 | 每页最多显示几条查询记录。 取值范围：1~100。 | 10 |
| CaSn | string | 是 | 待查询 CA 证书的 SN 序列码，表示查询哪一个 CA 证书下所有已注册的设备证书。 | 007269004887****** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"Total": 1,
"PageNo": 2,
"PageSize": 10,
"DeviceCertificateVOS": [
{
"ValidBegin": 1654137303000,
"ValidEnd": 1969497303000,
"DeviceSn": "356217374433******",
"DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
"Status": 1,
"CaSn": "00f26900ba87******",
"DeviceName": "mqtt_device"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 参数校验失败，可能缺失或者传入值非法。 |
| 400 | MqttOwnerCheckError | Failed to validate the instance permission | 实例权限校验失败 |
| 403 | PermissionCheckFailed | Failed to verify API permissions. | ram权限检查失败 |
| 500 | FindDeviceBySnError | Failed to find the device certificate by the SN. Please check sn is valid | 获取设备证书失败 |
| 500 | MqttInstanceNotFound | Specified instance is not found | 实例不存在 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-02-18 | OpenAPI 错误码发生变更 | 查看变更详情 |
控制台操作
除了调用 ListDeviceCertificateByCaSn 接口，您还可以通过微消息队列 MQTT 版控制台查看指定 CA 证书下所有已注册的设备证书。具体操作，请参见设备证书管理。