tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeScheduledSqlInfo

Last updated: 2024-04-15 19:58:27

1. API Description

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

This API is used to access the scheduled SQL analysis 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: DescribeScheduledSqlInfo.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
Offset No Integer Page offset. Default value: 0
Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100.
Name No String Task name.
TaskId No String Task ID.
Filters.N No Array of Filter
  • srcTopicName: Filter by Source Log Topic Name, fuzzy match. Type: String. Required: No
  • dstTopicName: Filter by Destination Log Topic Name, fuzzy match. Type: String. Required: No
  • srcTopicId: Filter by Source Log Topic ID. Type: String. Required: No
  • dstTopicId: Filter by Destination Log Topic ID. Type: String. Required: No
  • bizType: Filter by Topic Type, 0: log topic; 1: metric topic. Type: String. Required: No
  • status: Filter by Task Status, 1: running; 2: stopped. Type: String. Required: No
  • taskName: Filter by Task Name, fuzzy match. Type: String. Required: No
  • taskId: Filter by Task ID, fuzzy match. Type: String. Required: No
    		•

    3. Output Parameters

    Parameter Name Type Description
    ScheduledSqlTaskInfos Array of ScheduledSqlTaskInfo Scheduled SQL Task List Information
    TotalCount Integer Total number of tasks
    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 Accessing the Scheduled SQL Task List

    Input Example

    POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScheduledSqlInfo
<Common request parameters>
{}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb5xxxx",
        "ScheduledSqlTaskInfos": [
            {
                "Status": 1,
                "EnableFlag": 2,
                "UpdateTime": "2023-07-28 11:36:00",
                "Name": "test",
                "DstResource": {
                    "TopicId": "6ef60bec-0242-43af-bb20-270359fb5xxx",
                    "Region": "ap-guangzhou",
                    "BizType": 1,
                    "MetricName": "pv"
                },
                "ProcessTimeWindow": "@m-15m,@m",
                "ProcessPeriod": 5,
                "ProcessStartTime": "2023-07-28 11:36:00",
                "SrcTopicRegion": "ap-guangzhou",
                "SrcTopicName": "test-topic",
                "ScheduledSqlContent": "* | select count(*) as pv",
                "SrcTopicId": "6ef60bec-0242-43af-bb20-270359fb5xxxx",
                "ProcessDelay": 60,
                "TaskId": "6ef60bec-0242-43af-bb20-270359fb5xxxx",
                "ProcessType": 1,
                "CreateTime": "2023-07-28 11:36:00",
                "ProcessEndTime": "2023-07-28 11:36:00",
                "SyntaxRule": 0
            }
        ]
    }
}

    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.TagQpsLimit The frequency of tag service requests is limited.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    OperationDenied Operation denied.
    OperationDenied.ACLFailed ACL verification failed.
    OperationDenied.AccountDestroy The account has been terminated.
    OperationDenied.AccountIsolate The account has overdue payments.
    OperationDenied.AccountNotExists The account does not exist.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.TopicNotExist The log topic does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy