获取仪表盘订阅列表

最近更新时间: 2026-10-10 00:14:47

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.com。

本接口用于获取仪表盘订阅列表，支持分页

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

接口更新时间：2026-02-03 15:27:17。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeDashboardSubscribes
Version 是 否 String 公共参数，本接口取值：2020-10-16
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters 否 否 Array of Filter dashboardId：按照【仪表盘id】进行过滤。类型：String必选：否  每次请求的Filters的上限为10，Filter.Values的上限为100。
示例值：查看
Offset 否 否 Uint64 分页的偏移量，默认值为0。
示例值： 10
Limit 否 否 Uint64 分页单页限制数目，默认值为20，最大值100。
示例值： 30

3. 输出参数

参数名称 类型 描述
DashboardSubscribeInfos Array of DashboardSubscribeInfo 仪表盘订阅列表
示例值：查看
TotalCount Uint64 总数目
示例值： 1
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
OperationDenied.AccountNotExists 账户不存在。

5. 示例

示例1 获取仪表盘订阅列表

输入示例

POST / HTTP/1.1
Host: cls.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeDashboardSubscribes
<Common Parameters>

{
    "Filters": [],
    "Offset": 10,
    "Limit": 30
}

输出示例

{
  "Response": {
    "RequestId": "cd402dd9-a3aa-47c3-a5c0-5789d1f8875b",
    "TotalCount": 1,
    "DashboardSubscribeInfos": [
      {
        "Id": 21683,
        "Name": "task-2025-08-15",
        "DashboardId": "dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5",
        "Cron": "0 0 10 * * ?",
        "SubscribeData": {
          "DashboardTime": [
            "now-15m",
            "now"
          ],
          "StyleLayout": 0,
          "TemplateVariables": null,
          "NoticeModes": [
            {
              "ReceiverType": "Uin",
              "Values": [
                "10300000",
                "10200000"
              ],
              "ReceiverChannels": [
                "Email"
              ],
              "Url": ""
            }
          ],
          "Timezone": "Asia/regionA",
          "SubscribeLanguage": "zh",
          "JumpDomain": "https://console.cloud.company.com",
          "JumpUrl": ""
        },
        "Uin": 100001127589,
        "SubUin": 100012969012,
        "CreateTime": "2025-08-15 10:29:10",
        "UpdateTime": "2025-08-15 10:31:24",
        "LastTime": "",
        "LastStatus": "invalid"
      }
    ]
  }
}