Tencent Cloud

Download PDF

DescribeEventCases

Last updated: 2024-06-21 15:10:34

Download PDF

1. API Description

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

Find Event Instances Based on Conditions

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: DescribeEventCases.
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.
ProjectId	Yes	String	Project ID
Category	Yes	String	Event Instance Catalog, Example Value: - Expired: expired - Not Expired: consuming - All: all
PageNumber	Yes	Integer	Page Number
PageSize	Yes	Integer	Number of items per page
EventName	No	String	Event name
EventSubType	No	String	Event Segmentation Type
CreationTimeStart	No	String	Minimum Creation Time of Event Instance
CreationTimeEnd	No	String	Maximum Creation Time of Event Instance
EventTriggeredTimeStart	No	String	Minimum Trigger Time of Event Instance
EventTriggeredTimeEnd	No	String	Maximum Trigger Time of Event Instance
LogTimeStart	No	String	Minimum Consumption Time of Event Instance
LogTimeEnd	No	String	Maximum Consumption Time of Event Instance
Dimension	No	String	Event Instance Data Timestamp
TimeToLive	No	String	Event Instance Validity Period
SortItem	No	String	Sort Fields
SortType	No	String	Sorting Order

3. Output Parameters

Parameter Name	Type	Description
Data	EventCaseAuditLogVOCollection	Event Instance Pagination Query Results Note: 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 Search for Event Instances

Input Example

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

{
    "ProjectId": "1253824234232",
    "Category": "",
    "PageNumber": 1,
    "PageSize": 10,
    "EventName": "test_day_event",
    "EventType": "",
    "EventSubType": "",
    "EventBroadcastType": "",
    "Status": "",
    "CreationTimeStart": "",
    "CreationTimeEnd": "",
    "EventTriggeredTimeStart": "",
    "EventTriggeredTimeEnd": "",
    "LogTimeStart": "",
    "LogTimeEnd": "",
    "Dimension": ""
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "CaseId": "7b55e80c3a7949428c34b02ab82b09b7",
                    "Description": null,
                    "Dimension": "20240409",
                    "EventBroadcastType": null,
                    "EventName": "test_event_mico",
                    "EventSubType": "DAY",
                    "EventTriggerTimestamp": "2024-04-11T06:45:06.198Z",
                    "EventType": "TIME_SERIES",
                    "LogTimestamp": "2024-04-11T07:37:40.410Z",
                    "Status": "CONSUMING",
                    "TTL": 30,
                    "TimeUnit": "DAYS"
                }
            ],
            "PageCount": 1,
            "PageNumber": 1,
            "PageSize": 20,
            "TotalCount": 1,
            "TotalPage": 1
        },
        "RequestId": "ed042b6e-e2de-4425-9868-b994d5d18fd8"
    }
}

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.

tencent cloud

Recent Pages

DescribeEventCases

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Search for Event Instances

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeEventCases

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Search for Event Instances

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?