文档中心>日志服务>API 文档>云产品接入相关接口>查看云产品日志投递任务列表

查看云产品日志投递任务列表

最近更新时间:2024-11-14 01:21:48

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

云产品接入使用相关接口

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCloudProductLogTasks。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 分页的偏移量,默认值为0。
Limit Integer 分页单页限制数目,默认值为100,最大值100。
Filters.N Array of Filter - assumerName
- 按照【云产品标识】进行过滤。
- 类型:String
- 必选:否
- 枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
- logType
- 按照【日志类型】进行过滤。
- 类型:String
- 必选:否
- 枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
- instanceId
- 按照【实例ID】进行过滤。
- 类型:String
- 必选:否

3. 输出参数

参数名称 类型 描述
Tasks Array of CloudProductLogTaskInfo 日志配置详情列表
TotalCount Integer 日志配置总数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeCloudProductLogTasks

输入示例

POST / HTTP/1.1
      Host: xxx.tencentcloudapi.com
      Content-Type: application/json
      X-TC-Action: DescribeCloudProductLogTasks
      <公共请求参数>

      {
  "Offset": 0,
  "Limit": 0,
  "Filters": [
    {
      "Key": "AsummerName",
      "Values": [
        "cls"
      ]
    }
  ]
}

输出示例

{
    "Response": {
        "Tasks": [
            {
                "ClsRegion": "ap-guangzhou",
                "InstanceId": "ins-r8hr2upy",
                "LogsetId": "92cdd6d4-da98-4a6e-9494-175b44338680",
                "TopicId": "92cdd6d4-da98-4a6e-9494-175b44338680",
                "Extend": ""
            }
        ],
        "TotalCount": 1,
        "RequestId": "92cdd6d4-da98-4a6e-9494-175b44338680"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。