tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeRealtimeLogDeliveryTasks

Last updated: 2024-10-11 15:52:10

1. API Description

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

This API is used to query the real-time log delivery task list.

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: DescribeRealtimeLogDeliveryTasks.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Zone ID.
Offset No Integer The offset of paginated query. Default value: 0.
Limit No Integer The limit of paginated query. Default value: 20. Maximum value: 1000.
Filters.N No Array of AdvancedFilter Filter conditions. The maximum value for Filters.Values is 20. If this field is not filled in, all the real-time log delivery task information under the current zone-id will be returned. Detailed filter conditions are as follows:
  • task-id: Filter by real-time log delivery task ID. Fuzzy search is not supported.
  • task-name: Filter by real-time log delivery task name. Fuzzy search is supported, but only one real-time log delivery task name can be filled in for fuzzy search.
  • entity-list: Filter by entity corresponding to the real-time log delivery task. Fuzzy search is not supported. Example values: domain.example.com or sid-2s69eb5wcms7.
  • task-type: Filter by real-time log delivery task type. Fuzzy search is not supported. Optional values:
    cls: Push to Tencent Cloud CLS;
    custom_endpoint: Push to a user-defined HTTP(S) address;
    s3: Push to an AWS S3-compatible bucket address.
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of real-time log delivery tasks which match the query conditions.
    RealtimeLogDeliveryTasks Array of RealtimeLogDeliveryTask The list of all real-time log delivery tasks which match the query conditions.
    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 Querying All Real-time Log Delivery Task Information for a Specific Site

    Query all real-time log delivery task information for a specified zone ID.

    Input Example

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

{
    "ZoneId": "zone-2ur49nglp1a2",
    "Offset": 0,
    "Limit": 1000
}

    Output Example

    {
    "Response": {
        "RealtimeLogDeliveryTasks": [
            {
                "Area": "overseas",
                "CLS": {
                    "LogSetId": "980611e5-3eb2-430f-a0cc-e1c4e84a9e40",
                    "LogSetRegion": "ap-guangzhou",
                    "TopicId": "d258c060-dc6e-4586-8b7c-6a951667fa7a"
                },
                "CreateTime": "2024-03-26T03:00:39+08:00",
                "CustomEndpoint": null,
                "CustomFields": [],
                "DeliveryConditions": [],
                "DeliveryStatus": "enabled",
                "EntityList": [
                    "qqqq.loliyu.com"
                ],
                "Fields": [
                    "RequestID",
                    "ClientIP",
                    "ClientRegion",
                    "RequestTime",
                    "RequestHost",
                    "RequestBytes",
                    "RequestMethod",
                    "RequestUrl",
                    "RequestUrlQueryString",
                    "RequestUA",
                    "RequestRange",
                    "RequestReferer",
                    "RequestProtocol",
                    "RemotePort",
                    "EdgeCacheStatus",
                    "EdgeResponseStatusCode",
                    "EdgeResponseBytes",
                    "EdgeResponseTime",
                    "EdgeInternalTime",
                    "ClientState",
                    "ClientISP",
                    "EdgeServerID",
                    "EdgeServerIP"
                ],
                "LogFormat": null,
                "LogType": "domain",
                "S3": null,
                "Sample": 0,
                "TaskId": "f0e1686a-1c4e-4f15-967b-5afb2a0803ea",
                "TaskName": "ccc",
                "TaskType": "cls",
                "UpdateTime": "2024-03-26T03:10:13+08:00"
            }
        ],
        "RequestId": "05205d07-f582-444d-b558-b338a3f68857",
        "TotalCount": 1
    }
}

    Example2 Querying Real-time Log Delivery Task Information by Acceleration Domain Name

    Query real-time log delivery task information for a specified acceleration domain name. If TotalCount in returned output result is '0', it indicates that this acceleration domain name has not been added to any Real-time Log Delivery Task.

    Input Example

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

{
    "ZoneId": "zone-2o7b38ba1hvr",
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "entity-list",
            "Values": [
                "domain.example.com"
            ]
        }
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 0,
        "RealtimeLogDeliveryTasks": [],
        "RequestId": "f025c1f0-cb83-41b1-bb7d-565af7e28479"
    }
}

    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
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy