在鸿云文档Appearance
updateMqInfo
调用该接口更新mq实例信息。
使用说明
更新mq实例信息，转发规则会根据你配置的实例信息，转发到mq具体的topic上。
接口地址
/gateway/openapi
请求方式
POST
请求参数
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| tokenauthorization | String | 平台颁发的token |
| apiCode | String | 固定值：updateMqInfo |
UpdateMqInfoRequest
| 名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| mqId | String | 是 | mq实例唯一标识 |
| mqType | String | 是 | mq类型，当前仅支持kafka，固定值：kafka |
| mqName | String | 是 | mq实例名称 |
| mqUrl | String | 是 | mq连接地址，如：192.168.19.71:10003 |
| mqUsername | String | 是 | mq用户名 |
| mqPassword | String | 是 | mq密码 |
返回数据
UpdateMqInfoResponse
| 名称 | 类型 | 描述 |
|---|---|---|
| code | String | 调用成功，返回0，调用失败，查看错误信息。 |
| msg | String | 调用成功，提示"操作成功"，调用失败，查看错误信息。 |
| data | Object | 返回结果。结果内容详情，查看下方示例。 |
| mqId | String | mq实例Id。 |
示例
请求示例
json
{
"mqId": "8636e954c00c448cad0015a556ce78aa",
"mqType": "kafka",
"mqName": "kafka002",
"mqUrl": "127.0.0.1:9091",
"mqUsername": "admin123",
"mqPassword": "123"
}返回示例
json
{
"code": "0",
"msg": "操作成功",
"data": {
"mqId": "7797c5745e89476d85125b79965370b9"
}
}错误码
| 错误码 | 错误码取值 | 解决方案 |
|---|---|---|
| iot.mq.isnull | mq实例对象为空。 | 请确保传递入参。 |
| iot.mq.paramCheckFail | mq参数校验失败。 | 请确保按照文档要求传递正确的入参。 |
| iot.mq.nameExist | mq实例名称已存在。 | 请保持mq实例名称唯一。 |