tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeEvents

Last updated: 2024-11-26 17:43:43

    1. API Description

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

    This API is used to query the availability event list of tencent cloud services. It can be filtered by product, region, or event occurrence date.

    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: DescribeEvents.
    Version Yes String Common Params. The value used for this API: 2023-03-06.
    Region No String Common Params. This parameter is not required.
    EventDate Yes Date event occurrence date
    ProductIds.N No Array of String Query by Product ID(s). Product ID examples: cvm, lb, cdb, cdn, crs.
    RegionIds.N No Array of String 1. Query by Region ID(s). Region ID examples: ap-guangzhou、ap-shanghai、ap-singapore.
    2. The region ID for non-region-specific products should be set to non-regional.

    3. Output Parameters

    Parameter Name Type Description
    Data ProductEventList Detailed event information.
    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 Query event list

    Query for all events that occurred in the regions of Guangzhou and Shanghai on 2023-06-09

    Input Example

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

{
    "ProductIds": [
        "cvm"
    ],
    "RegionIds": [
        "ap-guangzhou",
        "ap-shanghai"
    ],
    "EventDate": "2023-06-09"
}

    Output Example

    {
    "Response": {
        "Data": {
            "EventList": [
                {
                    "ProductId": "cvm",
                    "ProductName": "Cloud Virtual Machine",
                    "RegionId": "ap-chongqing",
                    "RegionName": "ChongQing",
                    "StartTime": "2023-06-09 14:16:00",
                    "EndTime": "2023-06-09 14:28:00",
                    "CurrentStatus": "Normally"
                }
            ]
        },
        "RequestId": "76a0ee91-c081-4a9c-9ba6-ad7e15f06ce4"
    }
}

    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

    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
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Invalid parameter value.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy