消息队列 MQTT 版注册设备证书

1. 接口描述

接口请求域名： mqtt.tencentcloudapi.com 。

注册设备证书（仅一机一证场景生效），可参考自定义 X.509 证书实现 “一机一证”

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RegisterDeviceCertificate。
Version	是	String	公共参数，本接口取值：2024-05-16。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。示例值：mqtt-12345
DeviceCertificate	是	String	设备证书内容，可参考使用 CA 证书生成服务端/客户端证书生成示例值：-----BEGIN CERTIFICATE-----END CERTIFICATE-----
CaSn	是	String	关联的CA证书SN 示例值：7439e17052ff2edbeda4f5db379a69fd8c5f48a5
ClientId	否	String	客户端ID，需要关联该证书的客户端ID。根据实际业务使用填写示例值：VIN0001
Format	否	String	证书格式，默认为PEM，当前仅支持PEM格式示例值：PEM
Status	否	String	客户端证书状态，默认激活状态（ACTIVE） ACTIVE：激活 INACTIVE：未激活示例值：ACTIVE

3. 输出参数

参数名称	类型	描述
InstanceId	String	腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。示例值：mqtt-xxxx
CaSn	String	关联的CA证书SN 示例值：f2ed1027c42c66c03a15b06ef39765bc
DeviceCertificateSn	String	设备证书的SN 示例值：f2ed1027c42c66c03a15b06ef39765bc
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterDeviceCertificate
<公共请求参数>

{
    "InstanceId": "mqtt-g839agr2",
    "DeviceCertificate": "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIRAICF9S7OW9iDCN9tmNlwdxYwDQYJKoZIhvcNAQEFAAOCAQEAJ5a40Jc63eGlrz6M92YpiodMA8C8RMo2\neWfUCxMPSHCWzSiQtf84fwVXUqCOgfd9RHYZQx+bSBEKzt2Nxb15xNMXFzYEm8S0\nlQUacxx1N7w/fOed16c+VPMvwhLJSkO7oCbUl8X+hZDY6D326A6muaW0KsBTld4p\nociDefD8oNH+u4qCrcoAPNuhbG44dcqOrrHFlX0offDYjPLAoIgTb8Q/DwhuLg1b\nQuw/YMVFLMrMO2wzbu12PzEYmbohbk6Cv0viRFsxd/HUWPNYxi6HnoqpCKBnDwlZ\nc/GuUTJ7tFmkb4bKNK81rViXHt3x2fVG6yJwrVw6m3KjhrOKro82AA==\n-----END CERTIFICATE-----",
    "CaSn": "956a30da927b4e4b020592d55ad7bc7c"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "CaSn": "956a30da927b4e4b020592d55ad7bc7c",
        "DeviceCertificateSn": "8085f52ece5bd88308df6d98d9707716",
        "InstanceId": "mqtt-g839agr2",
        "RequestId": "05e8b3d9-9cee-478f-9d68-b70fda94c61f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.InstanceNotReady	FailedOperation.InstanceNotReady
ResourceNotFound.Ca	ResourceNotFound.Ca
ResourceNotFound.Instance	ResourceNotFound.Instance

注册设备证书

本页目录：