Creating or Copying a Dashboard
Function
This API is used to create or copy a dashboard.
Constraints
This API is not supported in the following regions: CN East-Qingdao, LA-Mexico City1, TR-Istanbul, AP-Jakarta, ME-Riyadh, and AP-Manila.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v2/{project_id}/dashboards
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Tenant ID. Constraints: None Value range: Project ID, used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters. Default value: None |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
No |
String |
Definition MIME type of the request body. Constraints: None Value range: The value can contain 1 to 64 characters. Default value: The default type is application/json; charset=UTF-8. Default value: application/json; charset=UTF-8 |
X-Auth-Token |
No |
String |
Definition User token. Constraints: None Value range: The value can contain 1 to 16,384 characters. Default value: None |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dashboard_name |
Yes |
String |
Custom dashboard name. Regex Pattern: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ |
enterprise_id |
No |
String |
Enterprise project ID. Regex Pattern: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ |
dashboard_id |
No |
String |
Dashboard ID. Regex Pattern: ^db([a-z]|[A-Z]|[0-9]){22} |
row_widget_num |
No |
Integer |
How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row. Value range: 0-3 Default value: 3 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
dashboard_id |
String |
Dashboard ID. Regex Pattern: ^db([a-z]|[A-Z]|[0-9]){22} |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Status codes customized by each cloud service when a request error occurs. |
error_msg |
String |
Request error message. |
request_id |
String |
Request ID. |
Example Requests
{ "dashboard_name" : "dashboard_name", "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "row_widget_num" : 3 }
Example Responses
Status code: 201
OK
{ "dashboard_id" : "dbxxxxxxxxx" }
Status Codes
Status Code |
Description |
---|---|
201 |
OK |
400 |
The server failed to process the request. |
401 |
Token authentication is required. |
500 |
Failed to complete the request because of an internal server error. |
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