Docs

Cloud Native Message Engine

MQTT key

DescribeDeviceCredential - Query MQTT user device access credentials

Call the DescribeDeviceCredential API to query MQTT user device access credentials.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example value: DescribeDeviceCredential

Operation to perform. Set to DescribeDeviceCredential.

Version string required Example value: 2024-09-01

API version. Value: 2024-09-01.

InstanceId string required Example value: mqtt-***

MQTT instance ID.

ClientId string required Example value: cid****

Device ClientID.

Response parameters

Only the unique response parameters of this API are listed below. For more details, see response structure.

InstanceId string Example value: mqtt-***

MQTT instance ID.

ClientId string Example value: cid***

Device ClientID.

UpdateTime long Example value: 1746685669000

Update time.

CreateTime long Example value: 1746685669000

Creation time.

DeviceAccessKeyId string Example value: ddx.2xxs

Device AccessKey ID.

DeviceAccessKeySecret string Example value: Ax.exxdd

Device's AccessKey secret.

Request example

POST /?Action=DescribeDeviceCredential&Version=2024-09-01 HTTP/1.1​
Host: bmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260211T091615Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260211/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "mqtt-***",​
  "ClientId": "cid****"​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "20260212102034049228186155****8",​
    "Action": "DescribeDeviceCredential",​
    "Version": "2024-09-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "InstanceId": "mqtt-***",​
    "ClientId": "cid***",​
    "UpdateTime": 1746685669000,​
    "CreateTime": 1746685669000,​
    "DeviceAccessKeyId": "ddx.2xxs",​
    "DeviceAccessKeySecret": "Ax.exxdd"​
  }​
}​

Error code

The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	Description
200	InternalServiceError	internal service error, please contact with admin	Internal service error. Please contact technical support or submit a ticket.
200	InvalidParameter	parameter is invalid, pls check parameters	Parameter value is invalid.
200	ParameterEncodingError	Failure encoding object into query map	Parameter encoding exception. Please contact technical support or submit a ticket.
200	Unauthorized	authorized error	Authorization error. Please authorize or switch accounts and try again.
400	ClientNotExist	client 55b5f0a9c2c71bb6e13165fa15f474c0 not found	Client does not exist.

Last updated: 2026.02.26 15:24:18