预览仪表盘订阅

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

1. 接口描述

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

此接口用于预览仪表盘订阅

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：SearchDashboardSubscribe
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Id	否	否	Uint64	仪表盘订阅Id。示例值： 0
DashboardId	是	否	String	仪表盘id。示例值： dashboard-1bd7e27b-6181-4771-a78d-08d061eab0ca
Name	否	否	String	仪表盘订阅名称。示例值：仪表盘-CLS-日报
SubscribeData	是	否	DashboardSubscribeData	仪表盘订阅数据。示例值：查看

3. 输出参数

参数名称	类型	描述
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: SearchDashboardSubscribe
<Common Parameters>

{
    "Name": "task-oss-2023-02-28_10:19",
    "DashboardId": "dashboard-0d954d68-4a0d-4a0d-95a6-f9eff0db370f",
    "SubscribeData": {
        "DashboardTime": [
            "now-d",
            "now"
        ],
        "NoticeModes": [
            {
                "ReceiverType": "Uin",
                "ReceiverChannels": [
                    "Email"
                ],
                "Values": [
                    "11223344demo"
                ]
            }
        ],
        "JumpDomain": "domain.com",
        "SubscribeLanguage": "zh",
        "Timezone": "Asia/regionA"
    }
}

输出示例

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