1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
注册事件
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RegisterDsEvent。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值：1470547050521227264 |
| Name | 是 | String | 事件名称 示例值：test_event |
| EventSubType | 是 | String | 事件周期类型 1、分钟：MIN 2、小时 ：HOUR 3、天：DAY 示例值：DAY |
| TimeToLive | 是 | String | 事件存活时间，值为大于0的整数 示例值：1 |
| TimeUnit | 是 | String | 事件存活时间单位 1、天：DAYS 2、分钟：MINUTES 示例值：DAYS |
| Owner | 是 | String | 事件所属人，账号昵称 示例值：zhangsan |
| Description | 是 | String | 事件描述 示例值：description |
| ValidConsumeCount | 否 | Integer | 事件消费有效次数 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | EventDsDto | 事件信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 注册事件（新建事件）
新建事件
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterDsEvent
<公共请求参数>
{
"ProjectId": "1470547050521227264",
"Name": "event_0811_01",
"EventSubType": "DAY",
"TimeToLive": "30",
"TimeUnit": "DAYS",
"Owner": "wenjieyao",
"Description": "1"
}输出示例
{
"Response": {
"Data": {
"CreationTs": null,
"Description": "1",
"DimensionFormat": "yyyyMMdd",
"EventBroadcastType": "BROADCAST",
"EventSubType": "DAY",
"EventType": "TIME_SERIES",
"Listeners": null,
"Name": "event_0811_01",
"Owner": "wenjieyao",
"ProjectId": "1470547050521227264",
"ProjectName": "",
"Properties": null,
"TimeToLive": 30,
"TimeUnit": "DAYS"
},
"RequestId": "bd5bbfc6-41e6-4e8f-a64e-f656b236b779"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
