RegisterEvent

Last updated: 2025-11-13 20:55:22

RegisterEvent

Last updated: 2025-11-13 20:55:22

1. API Description

Domain name for API request: wedata.intl.tencentcloudapi.com.

[Note: This version is only available for partial allowlisted customers in the Guangzhou region]

. This API is used to register events. This API is deprecated. Use API RegisterDsEvent.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: RegisterEvent.
Version	Yes	String	Common Params. The value used for this API: 2021-08-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore, eu-frankfurt, na-ashburn, na-siliconvalley.
ProjectId	Yes	String	Project ID
Name	Yes	String	Event Name, supports English, numbers, and underscores, up to 20 characters long, cannot start with a number or underscore.
EventSubType	Yes	String	Event Segmentation Type, cycle types: DAY, HOUR, MIN, SECOND
EventBroadcastType	Yes	String	Broadcast: BROADCAST, Unicast: SINGLE
TimeUnit	Yes	String	For cycle types of day and hour: HOURS, For minutes: MINUTES, For seconds: SECONDS
Owner	Yes	String	Event Owner
EventType	No	String	Required. event type. default value: TIME_SERIES.
DimensionFormat	No	String	Required. corresponds to day: yyyyMMdd, corresponds to HOUR: yyyyMMddHH, corresponds to MIN: yyyyMMddHHmm, corresponds to SECOND: yyyyMMddHHmmss. default value: yyyyMMdd.
TimeToLive	No	Integer	Uptime
Description	No	String	Event Description

3. Output Parameters

Parameter Name	Type	Description
Data	BatchReturn	Success or FailureNote: This field may return null, indicating that no valid value can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Registration Event

Registration Event

Input Example

POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RegisterEvent
<Common request parameters>

{
    "ProjectId": "1492511691706699776",
    "Name": "test_event_11",
    "EventType": "TIME_SERIES",
    "EventSubType": "DAY",
    "EventBroadcastType": "SINGLE",
    "DimensionFormat": "yyyyMMdd",
    "TimeToLive": 30,
    "TimeUnit": "DAYS",
    "Owner": "micofywang",
    "Description": "test"
}

Output Example

{
    "Response": {
        "Data": {
            "ErrorDesc": null,
            "ErrorId": null,
            "Result": true
        },
        "RequestId": "d43d2a97-0522-4917-a471-dbc0a8b3c318"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation	Operation Failure.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud