Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to obtain the dashboard.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDashboards. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Offset | No | Integer | Page offset. Default value: 0 |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
| Filters.N | No | Array of Filter | -dashboardId filter by [dashboard id], type: String, required: No. -Example value: dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 -dashboardName: Filter by fuzzy search as dashboard name. Type: String. Required: No. -Example value: Business dashboard -dashboardRegion filter by dashboard region (compatible with legacy dashboards). This property for dashboards created via cloud API, type: String, required: No. -See Regions and Availability Zones -Example: ap-guangzhou - tagKey - String - Required: No - Filter by the tag key. -Example value:
-tag:tagKey Filter by [tag key-value pair]. Replace tagKey with a specific tag key. Type: String. Required: No. -Refer to Example 1 for usage.
Each request can have up to 10 Filters. The upper limit of Filter.Values is 100. |
| TopicIdRegionFilter.N | No | Array of TopicIdAndRegion | Filter is performed by topicId and regionId. -topicId: Log topic id. - Obtain the log topic Id through Get Log Topic List. -Example value: 439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1: Guangzhou -4: Shanghai -5: Hong Kong (China) - 7: Shanghai Finance - 8: Beijing -9: Singapore - 11: Shenzhen Finance - 15: Silicon Valley - 16: Chengdu - 17: Frankfurt - 18: Seoul - 19: Chongqing - 22: Virginia - 23: Bangkok - 25: Tokyo - 33: Nanjing - 36: Tianjin -39: Taipei (China) - 46: Beijing Finance -72: Jakarta -74: Sao Paulo -78: Shanghai Autonomous Driving Cloud |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of dashboards |
| DashboardInfos | Array of DashboardInfo | Dashboard details |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Search for a dashboard by tag:key
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDashboards
<Common request parameters>
{
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Key": "tag:bowww-tag-key",
"Values": [
"bowww-tag-value"
]
}
]
}{
"Response": {
"TotalCount": 1,
"DashboardInfos": [
{
"DashboardId": "dashboard-47bf0f13-xxxx-xxxx-bb78-5b60229177ea",
"DashboardName": "API-TEST2",
"Data": "",
"CreateTime": "2023-07-05 20:46:25",
"UpdateTime": "2023-08-25 11:18:18",
"DashboardRegion": "",
"DashboardTopicInfos": [],
"AssumerUin": 0,
"RoleName": "",
"AssumerName": "",
"Tags": [
{
"Key": "bowww-tag-key",
"Value": "bowww-tag-value"
},
{
"Key": "bowww-tag-key1",
"Value": "bowww-tag-value1"
}
],
"FolderName": "default folder"
"FolderId": "0"
}
],
"RequestId": "6bf3355c-xxxx-xxxx-89c8-76c3ca37bae9"
}
}Obtaining the Dashboard
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDashboards
<Common request parameters>
{
"Limit": 1,
"Filters": [
{
"Values": [
"dashboard-7ff51cf1-xxxx-xxxx-9fbb-6a9743225f92"
],
"Key": "dashboardId"
}
],
"Offset": 0
}{
"Response": {
"DashboardInfos": [
{
"AssumerName": "",
"AssumerUin": 0,
"CreateTime": "2023-12-01 15:53:29",
"DashboardId": "dashboard-7ff51cf1-xxxx-xxxx-9fbb-6a9743225f92",
"DashboardName": "E32E23",
"DashboardRegion": "",
"DashboardTopicInfos": [],
"Data": "",
"FolderId": "0",
"FolderName": "default folder"
"RoleName": "",
"Tags": [
{
"Key": "team",
"Value": "value1"
}
],
"UpdateTime": "2023-12-01 15:53:29"
}
],
"RequestId": "56c8e3f5-xxxx-xxxx-acd0-8d2062df093f",
"TotalCount": 1
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.TagQpsLimit | Request tag service frequency. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| LimitExceeded | The quota limit is exceeded. |
| LimitExceeded.Tag | The tag number exceeds the limit. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | Account arrears. |
| OperationDenied.AccountNotExists | The account does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback