文档

CloseConnection - 关闭在线连接

更新时间:
一键部署

主动关闭在线连接,不过设备仍然可能会重连,取决于客户端重连机制。

接口说明

此 API 还在测试阶段,只有上海地区专业版实例可用,且老实例暂不支持

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

微消息队列 MQTT 版实例的 ID。

post-cn-0pp12gl****
ClientIdstring

设备的 Client ID。

GID_test@@@test

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

82B9E503-F4A1-4F30-976F-C6999FF9****
Codeinteger

接口返回码:200:表示成功。 其它:表示错误码。错误码详情,请参见错误码。

200
Messagestring

调用结果信息

operation success.
Successboolean

操作是否成功。true 表示成功,false 表示失败。

True

示例

正常返回示例

JSON格式

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": 200,
  "Message": "operation success.",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.实例权限校验失败,请确认MQTT实例的所属关系以及授权策略。
400PermissionCheckFailedAn error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.资源权限校验失败,请检查实例、Topic和Group ID的所属权限和授权策略。
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。
500InternalErrorAn error occurred while processing your request. Try again later.MQTT后端服务异常,请重试。

访问错误中心查看更多错误码。