1. 接口描述
接口请求域名: mqtt.tencentcloudapi.com 。
注册设备证书
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RegisterDeviceCertificate。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 集群id 示例值:mqtt-12345 |
DeviceCertificate | 是 | String | 设备证书 |
CaSn | 是 | String | 关联的CA证书SN 示例值:12345 |
ClientId | 否 | String | 客户端ID 示例值:client1 |
Format | 否 | String | 证书格式 示例值:pem |
Status | 否 | String | ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活 示例值:ACTIVE |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
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-jbgwp4ae",
"DeviceCertificate": "-----BEGIN CERTIFICATE-----\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\nBQAwgZIxCzAJBgNVBAYTAmNuMQ0wCwYDVQQIDAR4aWFuMQ0wCwYDVQQHDARodXlp\nMREwDwYDVQQKDAhqZWhhbnN1bjEWMBQGA1UECwwNdW5pdCBqZWhhbnN1bjEVMBMG\nA1UEAwwMc3Vuamlhbnhpb25nMSMwIQYJKoZIhvcNAQkBFhRqZWhhbnN1bkB0ZW5j\nZW50LmNvbTAeFw0yNDA1MDYwODU0NDNaFw0yNTA5MTgwODU0NDNaMIGBMQswCQYD\nVQQGEwJDTjELMAkGA1UECAwCWkoxCzAJBgNVBAcMAkhaMQwwCgYDVQQKDANBTEkx\nDTALBgNVBAsMBE1RVFQxFjAUBgkqhkiG9w0BCQEWB3h4eEB4eHgxIzAhBgNVBAMM\nGm1xdHQtdGVzdC54eHguYWxpeXVuY3MuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOC\nAQ8AMIIBCgKCAQEArSMP1QFvggJVAth6Zhnf7NMWi+JP9TvnfzYl1xAWsWfX2ocN\nC+AumAQl7I0C2UMUppDHIRiikdAwqmoMLFkuTYCoPnTrk8FpQx+/bLXGNZzwgAKN\n8Y0dbEanl5y6UFXDB6ZsYhRJmjBEZoUj6xCeBzXxP2Uu0FPFAF5haLwt03gQMcWi\nEMHLdj/jFKUGoLns/eQUdE5wbsZjGrCmk5hEeJxa9vAw40W0cgwsVi0E8qt5FCj7\n11DeQsvZ5NlQVyOT6YOStElE2zuWtMjzsgk7ryW2qWANv62hRxY8dDmPXO5oimK8\nAzNjakiN40OmOhzwfiG3noItixlQywWppuTrfwIDAQABo4GeMIGbMB8GA1UdIwQY\nMBaAFEaWXAdZRRy3HPvjV6NBAYZYGhDfMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgL0\nMEEGA1UdEQQ6MDiCEyoubXF0dC5hbGl5dW5jcy5jb22CIW1xdHQtdGVzdC5jbi1x\naW5nZGFvLmFsaXl1bmNzLmNvbTAdBgNVHQ4EFgQUz7CdvXCtki2X9i6zIQwKVJ7q\n/LwwDQYJKoZIhvcNAQELBQADggEBAB7Y/susqeC85RtXw9CHcOmcb/17G7svgxFZ\nLecOwEFxxaqwNVp/ae6TVkPvrMPStpVJmpS7ikYz37J16/n1mks/s+7fkGwAwfCI\nD+vGR+Hcvu2RsiTPwDMRhFwj92ZclnSyBjtPa1pgS1Nq0oCJ85G+nyxYBAjDQqzO\n05jNRO+E4/L+WrYhLE6M72amFMLbVGs170wHTiXtzokfUdflj9mNQs3pfLFNsyCt\nasDfqJX4Kie/MIwv/YKcB9pZ4NsonEgD3OfjJ6pFEHEH4ZiOVHuTT6C52XpCYMWA\najvuaaIlJp7GgOZxxPInOVXPmBlBlp28AiMlmxSfSAuMpUF0I8w=\n-----END CERTIFICATE-----\n",
"CaSn": "1b1e3bf3702110125887a3a721a7e66f05522513",
"ClientId": "1111"
}
输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"RequestId": "49af88f0-6571-4aa4-af92-9261f28c0ed9"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InstanceNotReady | FailedOperation.InstanceNotReady |
ResourceNotFound.Instance | ResourceNotFound.Instance |