Domain name for API request: cls.intl.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.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| 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 is filtered by [source log topic name] with fuzzy matching. Type: String. Required: No. Example: business log topic 1. Get the log topic name by get log topic list. -Filter dstTopicName by [target log topic name] with fuzzy matching. Type: String. Required: No. Example: Business log topic 2. Get the log topic name by getting the log topic list. - srcTopicId is filtered by [source log topic ID]. Type: String. Required: No. Example: a4478687-2382-4486-9692-de7986350f6b. Get the log topic id by get log topic list. -dstTopicId is filtered by [target log topic ID]. Type: String. Required: No. Example: bd4d3375-d72a-4cd2-988d-d8eda2bd62b0. Get log topic ID by get log topic list. -bizType is filtered by [topic type], 0: log topic; 1: metric topic. Type: String. Required: No. -Status is filtered by [task status]: 1: running; 2: stop; 3: exception. Type: String. Required: no. -Filter the taskName by [task name] with fuzzy matching. Type: String. Required: No. Example: metricTask. Search the task name by retrieving the scheduled SQL analysis task list. -taskId is filtered by [task ID] with fuzzy matching. Type: String. Required: No. Example: 9c64f9c1-a14e-4b59-b074-5b73cac3dd66. Obtain the task ID by retrieving the scheduled SQL analysis task list. |
| 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. |
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScheduledSqlInfo
<Common request parameters>
{
"Offset": 0,
"Limit": 1
}
{
"Response": {
"RequestId": "e1700c27-xxxx-xxxx-806f-eece0a0e756e",
"ScheduledSqlTaskInfos": [
{
"CreateTime": "2024-12-25 15:07:41",
"DstResource": {
"BizType": 0,
"CustomMetricLabels": [],
"CustomTime": "",
"MetricLabels": [],
"MetricName": "",
"Region": "ap-chengdu",
"TopicId": "d30a5165-xxxx-xxxx-9e94-fb733d2c1c0e"
},
"EnableFlag": 1,
"FullQuery": 1,
"HasServicesLog": 2,
"Name": "scheduler_sql_delete_task",
"ProcessDelay": 60,
"ProcessEndTime": "",
"ProcessPeriod": 1,
"ProcessStartTime": "2024-12-25 15:07:00",
"ProcessTimeWindow": "@m-1m,@m",
"ProcessType": 1,
"ScheduledSqlContent": "* | select count(*) as c limit 10000",
"SrcTopicId": "fe4e7d35-xxxx-xxxx-82e1-2762471b0928",
"SrcTopicName": "",
"SrcTopicRegion": "ap-chengdu",
"Status": 1,
"SyntaxRule": 1,
"TaskId": "44bb210d-xxxx-xxxx-8f7d-7fc5170553d4",
"UpdateTime": "2024-12-25 15:07:41"
}
],
"TotalCount": 15
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.Timeout | Operation timed out |
| 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. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan