帮你快速理解、总结文档立即下载
文档中心>日志服务>API 文档>云产品接入相关接口>创建云产品日志投递

创建云产品日志投递

最近更新时间：2026-07-16 01:34:05

我的收藏

本页目录：

1. 接口描述

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

内部云产品接入使用相关接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateCloudProductLogCollection。
Version 是 String 公共参数，本接口取值：2020-10-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String

实例ID

  • 通过各个接入云产品官方文档获取

示例值：ins-r8hrxxx
AssumerName 是 String

云产品标识。支持以下产品

  • APIS
  • BH
  • CDB
  • CDS
  • CFS
  • CLB
  • CSIP
  • CWP
  • DCDB
  • DNSPod
  • EMR
  • HTTPDNS
  • KHL
  • llmsgw
  • MariaDB
  • MDP
  • MongoDB
  • PostgreSQL
  • TCSS
  • TDSQL-C
  • TDStore
  • TencentDB-Redis
  • TEO
  • TokenHub
  • TSE

示例值：CDB
LogType 是 String

各云产品支持的日志类型如下：

assumer_name支持的 log_type
APISAPIS-ACCESS
BHBH-COMMANDLOG, BH-FILELOG
CDBCDB-AUDIT
CDSCDS-AUDIT, CDS-RISK
CFSCFS-AUDIT
CLBCMR-SPEND
CSIPCSIP
CWPCWP
DCDBDCDB-AUDIT, DCDB-ERROR, DCDB-SLOW
DNSPodDNSPod-RESOLVELOG
EMREMR-OPERATION
HTTPDNSHTTPDNS-RESOLVELOG
MariaDBMariaDB-AUDIT, MariaDB-ERROR, MariaDB-SLOW
MDPMDP-SSAI
MongoDBMongoDB-AUDIT, MongoDB-ErrorLog, MongoDB-OperationLog, MongoDB-SlowLog
PostgreSQLPostgreSQL-AUDIT, PostgreSQL-ERROR, PostgreSQL-SLOW
TCSSTCSS
TDSQL-CTDSQL-C-AUDIT
TDStoreTDMYSQL-SLOW
TencentDB-RedisRedis-AUDIT, Redis-ERROR, Redis-SLOW
TEOTEO-INEFERENCE
llmsgwllmsgw-mcp-security-alarm

示例值：CDB-AUDIT
CloudProductRegion 是 String

云产品地域。不同 LogType 入参格式存在差异：

格式 A：短 region 码（gz / sh / bj …）

  • APIS 全部日志类型：如 gz
  • CDB-AUDIT
  • TDSQL-C-AUDIT
  • TDMYSQL-SLOW
  • DCDB 全部日志类型
  • MariaDB 全部日志类型
  • PostgreSQL 全部日志类型
  • MongoDB-AUDIT（注意与 SlowLog/ErrorLog/OperationLog 不同）
  • TencentDB-Redis 全部日志类型
  • EMR-OPERATION

格式 B：长 region 码（ap-guangzhou / ap-shanghai / ap-singapore …）

  • CDS 全部日志类型：如 ap-guangzhou
  • MongoDB-SlowLog / MongoDB-ErrorLog / MongoDB-OperationLog
  • DNSPod-RESOLVELOG
  • HTTPDNS-RESOLVELOG
  • MDP-SSAI
  • CFS-AUDIT
  • TEO-INEFERENCE
  • TokenHub-ActivityLog / TokenHub-AuditLog
  • llmsgw-mcp-security-alarm
  • CSIP / TCSS / TSE / CWP / KHL 等

格式 C：BH 专用 Polaris 名

  • BH 全部日志类型：overseas-polaris（中国香港及其他海外）/ fsi-polaris（金融区）/ general-polaris（普通区）/ intl-sg-prod（国际站）

示例值：ap-guangzhou
ClsRegion 是 String

CLS目标地域


示例值：ap-guangzhou
LogsetName 否 String

日志集名称，未填LogsetId时必填。若日志集不存在, 将自动创建


示例值：logset
TopicName 否 String

日志主题名称，在未填TopicId时必填。 若日志主题不存在，将自动创建


示例值：topic
Extend 否 String

日志配置扩展信息， 一般用于存储额外的日志投递配置


示例值：{"ServiceName":["HDFS","KNOX","YARN","ZOOKEEPER"],"Policy":0}
LogsetId 否 String

日志集id


示例值：92cdd6d4-da98-4a6e-9494-175b44338680
TopicId 否 String

日志主题id


示例值：92cdd6d4-da98-4a6e-
Tags.N 否 Array of Tag

标签描述列表，通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。

3. 输出参数

参数名称 类型 描述
TopicId String

日志主题ID


示例值：92cdd6d4-da98-4a6e-9494-175b44338680
TopicName String

日志主题名称


示例值：test-topic
LogsetId String

日志集ID


示例值：92cdd6d4-da98-4a6e-9494-175b44338680
LogsetName String

日志集名称


示例值：test-logset
Status Integer

-1 创建中，1创建完成


示例值：1
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建云产品投递任务

输入示例

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

{
    "InstanceId": "cdb-9edkkbdc",
    "AssumerName": "CDB",
    "LogType": "CDB-AUDIT",
    "CloudProductRegion": "qy",
    "ClsRegion": "ap-qingyuan",
    "LogsetName": "test-logset",
    "TopicName": "test-topic"
}

输出示例

{
    "Response": {
        "LogsetId": "c227837e-29e6-4597-a22d-15265d8179c6",
        "LogsetName": "test-logset",
        "RequestId": "1acc4a4a-8231-4439-8a30-d082a95b9b43",
        "Status": 1,
        "TopicId": "9e041c76-869b-4eec-a54e-7f22f53e1afc",
        "TopicName": "test-topic"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.CloudProductInvocationError 调用云产品接口异常
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
ResourceNotFound.LogsetNotExist 指定的日志集不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。
UnsupportedOperation 操作不支持。
中国站