创建仪表盘订阅

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

1. 接口描述

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

此接口用于创建仪表盘订阅

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

接口更新时间：2026-02-03 15:23:19。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：CreateDashboardSubscribe
Version 是 否 String 公共参数，本接口取值：2020-10-16
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Name 是 否 String 仪表盘订阅名称。
示例值： 仪表盘-CLS-日报
DashboardId 是 否 String 仪表盘id。
示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Cron 是 否 String 订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。  {秒数} 取值范围： 0  59 {分钟} 取值范围： 0  59  {小时} 取值范围： 0  23  {日期} 取值范围： 1  31 AND (dayOfMonth最后一天： L) {月份} 取值范围： 1  12 {星期} 取值范围： 0  6 【0:星期日， 6星期六】
示例值： "0 0 10 L * ?"
SubscribeData 是 否 DashboardSubscribeData 仪表盘订阅数据。
示例值：查看

3. 输出参数

参数名称 类型 描述
Id Uint64 仪表盘订阅记录Id
示例值： 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: CreateDashboardSubscribe
<Common Parameters>

{
    "Name": "10:00am",
    "DashboardId": "dashboard-0d954d68-4a0d-4a0d-95a6-f9eff0db370f",
    "Cron": "0 40 20 * * ?",
    "SubscribeData": {
        "DashboardTime": [
            "2022-05-01T00:00:00.000",
            "2022-05-31T23:59:59.999"
        ],
        "StyleLayout": 1,
        "TemplateVariables": [
            {
                "Key": "name",
                "Values": [
                    "zhangsan"
                ]
            }
        ],
        "NoticeModes": [
            {
                "ReceiverType": "Uin",
                "Values": [
                    "168053"
                ],
                "ReceiverChannels": [
                    "Sms"
                ]
            },
            {
                "ReceiverType": "Group",
                "Values": [
                    "10721522",
                    "9553840"
                ],
                "ReceiverChannels": [
                    "Sms"
                ]
            },
            {
                "ReceiverType": "Email",
                "Values": [
                    "3333@demo.com",
                    "4a0d@163.com"
                ],
                "ReceiverChannels": []
            }
        ]
    }
}

输出示例

{
    "Response": {
        "RequestId": "6ef60bec-4a0d-4a0d-bb20-270359fb54a7",
        "Id":10001
    }
}