日志服务获取仪表盘

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

本接口用于获取仪表盘

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDashboards。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	否	String	公共参数，本接口不需要传递此参数。
Offset	否	Integer	分页的偏移量，默认值为0。示例值：1
Limit	否	Integer	分页单页限制数目，默认值为20，最大值100。示例值：5
Filters.N	否	Array of Filter	- dashboardId 按照【仪表盘id】进行过滤，类型：String，必选：否。 - 示例值：dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - 示例值：业务大盘 - dashboardRegion 按照【仪表盘地域】进行过滤（兼容老的仪表盘），通过云API创建的仪表盘该属性，类型：String，必选：否。 - 参考地域和访问域名 - 示例：ap-guangzhou - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - 示例值： `<br/> "Filters":[<br/> {<br/> "Key": "tagKey",<br/> "Values": [<br/> "tag-key-test"<br/> ]<br/> }<br/> ]<br/>` - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否， - 参考示例1 使用。 `<br/> "Filters": [<br/> {<br/> "Key": "tag:tag-key-test",<br/> "Values": [<br/> "12"<br/> ]<br/> }<br/> ]<br/>` 每次请求的Filters的上限为10，Filter.Values的上限为100。
TopicIdRegionFilter.N	否	Array of TopicIdAndRegion	按照topicId和regionId过滤。 - topicId:日志主题Id。 - 通过获取日志主题列表获取日志主题Id。 - 示例值：439a5304-08f9-484b-9c4d-46ff57133816 - regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	仪表盘的数量示例值：10
DashboardInfos	Array of DashboardInfo	仪表盘详细明细
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 通过tag:key获取仪表盘

通过tag:key获取仪表盘

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDashboards
<公共请求参数>

{
    "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"
                    }
                ]
            }
        ],
        "RequestId": "6bf3355c-xxxx-xxxx-89c8-76c3ca37bae9"
    }
}

示例2 通过dashboardId获取仪表盘

获取仪表盘

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDashboards
<公共请求参数>

{
    "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": "",
                "RoleName": "",
                "Tags": [
                    {
                        "Key": "team",
                        "Value": "value1"
                    }
                ],
                "UpdateTime": "2023-12-01 15:53:29"
            }
        ],
        "RequestId": "56c8e3f5-xxxx-xxxx-acd0-8d2062df093f",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.TagQpsLimit	请求标签服务限频。
InternalError	内部错误。
InvalidParameter	参数错误。
LimitExceeded	超过配额限制。
LimitExceeded.Tag	tag超过限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。

获取仪表盘

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 通过tag:key获取仪表盘

输入示例

输出示例

示例2 通过dashboardId获取仪表盘

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码