1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
[注意：该版本只满足广州区部分白名单客户使用]
注册事件默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RegisterEvent。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目Id 示例值："1492511691706699776" |
| Name | 是 | String | 事件名称，支持英文、数字和下划线，最长20个字符, 不能以数字下划线开头。 示例值："test_event" |
| EventSubType | 是 | String | 事件分割类型，周期类型: DAY，HOUR，MIN，SECOND 示例值："DAY" |
| EventBroadcastType | 是 | String | 广播：BROADCAST,单播：SINGLE 示例值："SINGLE" |
| TimeUnit | 是 | String | 周期类型为天和小时为HOURS ，周期类型为分钟 ：MINUTES,周期类型为秒：SECONDS 示例值："DAY" |
| Owner | 是 | String | 事件所属人 示例值："tom" |
| EventType | 否 | String | 事件类型，默认值：TIME_SERIES 示例值："TIME_SERIES" |
| DimensionFormat | 否 | String | 对应day： yyyyMMdd，对应HOUR：yyyyMMddHH，对应MIN：yyyyMMddHHmm，对应SECOND：yyyyMMddHHmmss 示例值："yyyyMMdd" |
| TimeToLive | 否 | Integer | 存活时间 示例值：30 |
| Description | 否 | String | 事件描述 示例值："天事件" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | BatchReturn | 成功或者失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"ErrorDesc":null,"ErrorId":null,"Result":true} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 注册事件
注册事件
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterEvent
<公共请求参数>
{
"ProjectId": "1492511691706699776",
"Name": "test_event_11",
"EventType": "TIME_SERIES",
"EventSubType": "DAY",
"EventBroadcastType": "SINGLE",
"DimensionFormat": "yyyyMMdd",
"TimeToLive": 30,
"TimeUnit": "DAYS",
"Owner": "micofywang",
"Description": "test"
}输出示例
{
"Response": {
"Data": {
"ErrorDesc": null,
"ErrorId": null,
"Result": true
},
"RequestId": "d43d2a97-0522-4917-a471-dbc0a8b3c318"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |