tencent cloud

APIs

DescribeDlcDelivers

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-06-10 15:02:22

1. API Description

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

This API is used to search alarm channel callback configuration lists.

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: DescribeDlcDelivers.
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.
TopicId Yes String Log topic ID.
-Obtain the log topic Id through Get Log Topic List.
Filters.N No Array of Filter - taskId
Filter by [task id].
Type: String
Required: No

- name
Filter by [task name].
Type: String
Required: No

- tableName
Filter by [data table].
Type: String
Required: No

- statusFlag
Filter by [status]. Supported values: "1", "2", "3", "4". Meanings: 1: RUNNING, 2: STOPPED, 3: FINISHED, 4: FAILED.
Type: String
Required: No

Each request can have up to 10 Filters. The upper limit of Filter.Values is 10.
Offset No Integer Page offset. Default value: 0
Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name Type Description
Infos Array of DlcDeliverInfo List of alarm channel callback configurations.
Total Integer Total number of notification content configurations that meet the 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 Obtaining dlc Delivery Tasks Under a Log Topic

Input Example

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

{
    "TopicId": "6bf3355c-3c88-4566-89c8-76c3ca37bae9",
    "Offset": 0,
    "Limit": 1
}

Output Example

{
    "Response": {
        "Infos": [
            {
                "BizType": 0,
                "CreateTime": 1742466273,
                "DeliverType": 0,
                "DlcInfo": {
                    "FieldInfos": [
                        {
                            "ClsField": "cls_1",
                            "DlcField": "dlc_1",
                            "DlcFieldType": "string"
                        },
                        {
                            "ClsField": "dlc_2",
                            "Disable": true,
                            "DlcField": "dlc_2",
                            "DlcFieldType": "int"
                        }
                    ],
                    "PartitionInfos": [
                        {
                            "ClsField": "cls_1",
                            "DlcField": "dlc_1",
                            "DlcFieldType": "string"
                        }
                    ],
                    "TableInfo": {
                        "DataDirectory": "/a/a/a/a",
                        "DatabaseName": "database_name",
                        "TableName": "table_name"
                    }
                },
                "HasServicesLog": 2,
                "Interval": 300,
                "MaxSize": 5,
                "Name": "test10",
                "StartTime": 1741005340,
                "Status": 1,
                "TaskId": "b0266f31-3224-4a6d-856c-01ba021939b9",
                "TopicId": "6bf3355c-3c88-4566-89c8-76c3ca37bae9",
                "Uin": 100001127589,
                "UpdateTime": 1742466273
            }
        ],
        "RequestId": "4162c1e2-abaf-457e-b25c-4ba5b6a13bd8",
        "Total": 10
    }
}

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.TagQpsLimit The frequency of tag service requests is limited.
InternalError Internal error.
InvalidParameter Incorrect parameter.
MissingParameter Missing 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.

Ajuda e Suporte

Esta página foi útil?

comentários