tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateLogTopicTask

最后更新时间：2022-09-28 19:28:22
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to create a shipping task.

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: CreateLogTopicTask.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
LogSetId Yes String ID of the logset.
LogSetRegion Yes String Region of the logset.
TopicName Yes String Topic name of the logset.
TaskName Yes String Name of the shipping task.
ZoneId Yes String ID of the site.
ZoneName Yes String Name of the site.
EntityType Yes String Type of the shipping entity. Values:
  • domain: L7 acceleration logs;
  • application: L4 acceleration logs;
  • web-rateLiming: Rate limiting logs;
  • web-attack: Web security logs;
  • web-rule: Custom rule logs;
  • web-bot: Bot management logs.
    		•
    Period Yes Integer Retention period of the log topic. Value range: 1–366 (in days).
    EntityList.N No Array of String List of shipping entities.
    Area No String Acceleration region. Values:
  • mainland: Chinese mainland.
  • overseas: Global (outside the Chinese mainland).
    • If this field is not specified, the acceleration region will be determined based on the user’s region.

    3. Output Parameters

    Parameter Name Type Description
    TopicId String ID of the log topic created.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a shipping task

    Input Example

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

{
    "LogSetRegion": "ap-guangzhou",
    "ZoneName": "hello.club",
    "ZoneId": "zone-28569s6od5na",
    "EntityType": "application",
    "Period": 10,
    "TopicName": "test_topic",
    "TaskName": "test_task",
    "EntityList": [
        "test"
    ],
    "LogSetId": "33a900b2-9860-4da0-be91-bcce94c290ce"
}

    Output Example

    {
    "Response": {
        "TopicId": "ace8680b-55b9-498b-a113-056ab68d1da1",
        "RequestId": "40be710a-9706-4b22-865e-c9739111ef1a"
    }
}

    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
    FailedOperation Operation failed.
    FailedOperation.CreateClsLogTopicTaskFailed Failed to create the log topic: The topic/task name already exists.
    LimitExceeded The quota limit has been reached.
    ResourceUnavailable.AvailableDomainNotFound No domain names available.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款