You need to enable JavaScript to run this app.
Cloud Native Message Engine

Cloud Native Message Engine

Copy page
Download PDF
MQTT listener
CreateDashboardEndpoint - Create a dashboard access endpoint
Copy page
Download PDF
CreateDashboardEndpoint - Create a dashboard access endpoint
Call the CreateDashboardEndpoint API to create a dashboard access endpoint.​
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.
​
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: CreateDashboardEndpoint​
The operation to be performed: CreateDashboardEndpoint.​
​
Version string required Example value: 2024-09-01​
API version: 2024-09-01.​
​
InstanceId string required Example value: mqtt-**​
MQTT instance ID.​
​
​
Response parameters​
Only the unique response parameters of this API are listed below. For more details, see response structure.​
Message string Example value: success​
Operation message.​
​
Status string Example value: SUCCESS​
Operation status.​
​
​
Request example​
​
POST /?Action=CreateDashboardEndpoint&Version=2024-09-01 HTTP/1.1​
Host: bmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260211T082225Z​
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-**"​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "2026021***8413712402700481CA44",​
"Action": "CreateDashboardEndpoint",​
"Version": "2024-09-01",​
"Service": "bmq",​
"Region": "cn-beijing"​
},​
"Result": {​
"Message": "success",​
"Status": "SUCCESS"​
}​
}​
​
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 server error. Please contact technical support or submit a ticket.​
200​
Unauthorized​
authorized error​
Authorization error. Please grant authorization or switch accounts and try again.​
200​
InvalidParameter​
parameter is invalid, pls check parameters​
Invalid parameter value.​
200​
ParameterEncodingError​
Failure encoding object into query map​
Parameter encoding error. Please contact technical support or submit a ticket.​
​
​
Last updated: 2026.02.26 15:24:19