1. 接口描述
接口请求域名: mqtt.tencentcloudapi.com 。
修改MQTT JWKS 认证器
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyJWTAuthenticator。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID 示例值:mqtt-xxxx |
Algorithm | 否 | String | 算法:hmac-based,public-key 示例值:hmac-based |
From | 否 | String | 设备连接时传递jwt的key; username-使用用户名字段传递; password-使用密码字段传递 示例值:username |
Secret | 否 | String | 密码 示例值:open |
PublicKey | 否 | String | 公钥 示例值: -----BEGIN CERTIFICATE----- MIIECDCCAvCgAwIBAgIUG/L3CDia0Tl2KKs8bDOxY2t+SfUwDQYJKoZIhvcNAQEN 9w0BAQ0FAAOCAQEAtXGaYSOlseeXzq9lapF0SWcI/UhRXSfomwLeF+PvH3meF04r 2Hdl/IvY0jfKuc/olOPDxF3mK3/Lf7nk/68fKG7ytmVJrBXCGUN8R2AuTmeRsbK8 qEf2C8DgIw9KAPHtPY7ZupRzRskVeZHUy6N1pKYjlQk80451SwNwnfU8gni10BaJ dd1vc7JbPm90IQjb+OcfuflFwfl8yiQLWy1oJdwGwEN/f4PFoRKP4dizyn9+0+Ki 5M8AINMMlYrfXRWHVyr8N/Pj8l4QNo3cJiUeXIpoSc39oNiYbdfTs1f3sJCT8lIG 8lCCucEU4bX5ZPwMJ9QMTJ6xORLenDIk2orY7Q== -----END CERTIFICATE----- |
Text | 否 | String | JSKS文本 示例值:text |
Remark | 否 | String | 说明 示例值:remark |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyJWTAuthenticator
<公共请求参数>
{
"InstanceId": "mqtt-mmgej724",
"Algorithm": "hmac-based",
"From": "username",
"Secret": "secret1",
"Remark": "remark1"
}
输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"RequestId": "1440f718-1578-494b-aab0-8fe0bf7095cd"
}
}
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.PublicKeyVerifyFailed | FailedOperation.PublicKeyVerifyFailed |
MissingParameter | 缺少参数错误。 |