Creating a Dashboard
Function
This API is used to create dashboards.
URI
POST /v1/{project_id}/dashboards/create
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For how to obtain the project ID, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Workspace-Id |
Yes |
String |
Workspace ID. For how to obtain it, see Obtaining a Workspace ID. |
X-Auth-Token |
Yes |
String |
User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Dashboard name. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Dashboard ID. |
name |
String |
Dashboard name. |
create_user_name |
String |
Creator. |
create_date |
Long |
Creation time. |
update_user_name |
String |
User who performs the update. |
update_date |
Long |
Update timestamp. |
status |
Integer |
Dashboard status. The options include:
Enumerated values:
|
Example Request
Create a dashboard.
https://{endpoint}/v1/{project_id}/dashboards/create { "name" : "newDashboard" }
Example Response
Status code: 200
The dashboard is successfully created.
{ "id" : "009b3d3e-xxxx-4cc3-xxxx-dc54cd42424d", "name": "New Dashboard", "create_user_name" : "xxxx", "create_date" : 1706062051243, "update_user_name" : "xxxx", "update_date" : 1706062051243, "status" : 0 }
Status Codes
Status Code |
Description |
---|---|
200 |
The dashboard is successfully created. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot