MQTT OpenAPI状态码调整

公告说明

为了更有效地管理OpenAPI，我们对云消息队列 MQTT 版的OpenAPI的HTTP状态码进行调整。

变更内容

• 本次变更只针对OpenAPI的HTTP状态码进行统一调整，不涉及接口的返回结果。

• 接口的HTTP状态码调整如下：

  HTTP status code （变更前）	HTTP status code （变更后）	错误码	错误信息	描述
  500	417	InternalError	An error occurred while processing your request. Try again later.	MQTT后端服务异常，请重试。
  500	403	SystemOverFlow	An error occurred while processing your request. Please try again.	系统限流，请重试。
  500	417	CreateGroupIdError	Failed to create GroupId. Try again later.	创建Group ID请求执行失败，请稍后重试。
  500	417	DeleteGroupIdError	Failed to delete GroupId. Try again later.	删除Group ID请求执行失败，请稍后重试。
  500	417	SendMessageFailed	A storage exception occurred while sending the message. Please try again.	由于后端存储异常，消息发送失败，请重试。
  500	400	RegisterCodeError	Register code error in verification certificate.	注册码错误。
  500	401	RegisterCodeUsed	Register code has been used.	注册码已经被使用过。
  500	401	GetCaNumError	Failed to get ca num. Try again later.	获取CA数量错误。
  500	401	CaNumExceed	CA certificate num exceed.	CA数量超出限制。
  500	401	CertificateContentError	Certificate content error, please check ca/verification certificate content. BasicConstraints extension should be set to true in CA certificate.	用户CA证书或者验证证书内容错误。
  500	401	SnNotUnique	Sn is not unique in global.	SN 不是全局唯一的。
  500	400	MqttInstanceNotFound	Specified instance is not found.	实例不存在。
  500	400	FindCaBySnError	Failed to find the CA by the SN. Please check sn is valid.	SN不存在。
  500	403	MqttOwnerCheckError	Failed to validate the instance permission.	实例权限校验失败。
  500	400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
  500	400	FindDeviceBySnError	Failed to find the device certificate by the SN. Please check sn is valid.	获取设备证书失败。

• 涉及到的接口如下：

  • ApplyToken - 创建临时访问 Token

  • QueryToken - 校验Token的有效性

  • RevokeToken - 吊销 Token

  • CreateGroupId - 创建 Group ID

  • DeleteGroupId - 删除 Group ID

  • ListGroupId - 查看某实例下的所有 Group ID

  • SendMessage - 向云消息队列 MQTT 版发送单条消息

  • QuerySessionByClientId - 查询客户端在线状态

  • BatchQuerySessionByClientIds - 批量查询客户端在线状态

  • CloseConnection - 关闭在线连接

  • GetDeviceCredential - 查询设备的访问凭证

  • RefreshDeviceCredential - 更新设备的访问凭证

  • RegisterDeviceCredential - 为某个设备注册访问凭证

  • UnRegisterDeviceCredential - 注销设备的访问凭证

  • ListDeviceCredentialClientId - 查询已注册访问凭证的设备列表

  • QueryMqttTraceDevice - 查询设备轨迹

  • QueryMqttTraceMessageOfClient - 查询消息轨迹

  • QueryMqttTraceMessagePublish - 查询消息发送轨迹

  • QueryMqttTraceMessageSubscribe - 查询消息消费轨迹

  • RegisterCaCertificate - 注册CA证书

  • ActiveCaCertificate - 激活CA证书

  • InactivateCaCertificate - 注销CA证书

  • ListCaCertificate - 查询CA证书列表

  • GetCaCertificate - 获取CA证书详情

  • GetRegisterCode - 获取CA证书注册码

  • DeleteCaCertificate - 删除CA证书

  • ActiveDeviceCertificate - 激活设备证书

  • InactivateDeviceCertificate - 注销设备证书

  • ListDeviceCertificate - 查询设备证书列表

  • ListDeviceCertificateByCaSn - 查询CA证书下设备证书

  • GetDeviceCertificate - 获取设备证书详情

  • DeleteDeviceCertificate - 删除设备证书

  • DisasterDowngrade - 容灾降级

  • DisasterRecovery - 容灾恢复

变更时间

2025年07月06日至2025年08月06日期间，对现有OpenAPI的HTTP状态码按地域分批完成调整。

变更影响

涉及对接口HTTP状态码有强依赖的业务，请尽快进行修改。

对于此次调整可能带来的不便，敬请谅解。如您有任何问题，请联系云消息队列 MQTT 版技术支持，钉钉群号：116015007918。