tencent cloud

APIs

ドキュメントAPIsCloud Log ServiceCross-Account Delivery APIsDescribeCLSDeliverTasks

DescribeCLSDeliverTasks

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-09-16 21:29:21

1. API Description

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

This API is used to get the CLS 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: DescribeCLSDeliverTasks.
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.
Filters.N No Array of Filter
  • taskId Filter by task id. Type: String. Required: No.
  • taskName Filter by task name. Type: String. Required: No.
  • sourceLogsetId Filter by source logset. Type: String. Required: No.
  • targetLogsetId Filter by destination log set. Type: String. Required: No.
    The maximum number of Filters per request is 10, and the maximum number of Filter.Values is 10.
Offset No Integer

Pagination offset. Default value: 0.
Limit No Integer

Number of entries per page. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name Type Description
Infos Array of CLSDeliverTaskInfo

Delivery task information list
Total Integer

Total number of qualified 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 Querying the list of delivery tasks across different accounts

Input Example

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

{
    "Offset": 0,
    "Limit": 1
}

Output Example

{
    "Response": {
        "Infos": [
            {
                "Compliance": 1,
                "CreateTime": 1776754097,
                "DeliverRule": {
                    "DataScope": 3
                },
                "Enable": 0,
                "HasServicesLog": 2,
                "Progress": 0,
                "SourceTopicConfig": {
                    "LogsetId": "e83e2d17-6d97-429d-b073-acbcd625ad5f",
                    "TopicFilterType": 1,
                    "Topics": [
                        {
                            "TopicId": "871710c5-35cd-4d1e-8e79-2fa92c35d612"
                        }
                    ]
                },
                "Status": 0,
                "TargetTopicConfig": {
                    "AccountType": 1,
                    "LogsetId": "b*******-diy-1254139626",
                    "Region": "ap-**************",
                    "TopicId": "12cd155d-feb0-497e-929d-dd0070867599"
                },
                "TaskId": "075210cd-28ac-497c-8575-8e0e5e11e1db",
                "TaskName": "update",
                "Uin": 100001127589,
                "UpdateTime": 1776915747
            }
        ],
        "Total": 7,
        "RequestId": "42c19473-518f-4f2e-810f-a3329cdc6709"
    }
}

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 Request tag service frequency.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
OperationDenied Operation denied.
OperationDenied.ACLFailed ACL verification failed.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate Account arrears.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound.RecordNotExist Record does not exist
前の記事へ: ModifyCLSDeliverTask次の記事へ: DescribeNetworkApplications

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック

キーワードで検索
    Enter keywords to search documentation