日志服务创建云产品日志投递任务-云产品接入相关接口-API 中心-腾讯云

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateCloudProductLogTask。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID 示例值：ins-r8hr2upy
AssumerName	是	String	云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS 示例值：CDB
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 示例值：CDB-AUDIT
CloudProductRegion	是	String	云产品地域。不同日志类型(LogType)地域入參格式存在差异，请参考如下示例： - CDS所有日志类型：ap-guangzhou - CDB-AUDIT: gz - TDSQL-C-AUDIT: gz - MongoDB-AUDIT: gz - MongoDB-SlowLog：ap-guangzhou - MongoDB-ErrorLog：ap-guangzhou - TDMYSQL-SLOW：gz - DCDB所有日志类型：gz - MariaDB所有日志类型：gz - PostgreSQL所有日志类型：gz - BH所有日志类型：overseas-polaris(国内站海外)/fsi-polaris(国内站金融)/general-polaris(国内站普通)/intl-sg-prod(国际站) - APIS所有日志类型：gz 示例值：ap-guangzhou
ClsRegion	是	String	CLS目标地域示例值：ap-guangzhou
LogsetName	否	String	日志集名称，未填LogsetId时必填。若日志集不存在, 将自动创建示例值：logset
LogsetId	否	String	日志集ID，若指定则代表选择已有日志集。选择已有日志集时，LogsetName可以不填示例值：92cdd6d4-da98-4a6e-9494-175b44338680
TopicName	否	String	日志主题名称，在未填TopicId时必填。若日志主题不存在，将自动创建示例值：topic
TopicId	否	String	日志主题ID，若指定则代表选择已有日志主题，选择已有日志主题时，TopicName可以不填示例值：92cdd6d4-da98-4a6e-9494-175b44338680
Extend	否	String	日志配置拓展信息，一般用于存储额外的日志投递配置

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
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

     {
  "InstanceId": "ins-r8hr2upy",
  "AssumerName": "cls",
  "LogType": "default",
  "CloudProductRegion": "ap-guangzhou",
  "ClsRegion": "ap-guangzhou",
  "LogsetName": "test-logset",
  "TopicName": "test-topic"
}

输出示例

{
    "Response": {
        "TopicId": "92cdd6d4-da98-4a6e-9494-175b44338680",
        "TopicName": "test-topic",
        "LogsetId": "92cdd6d4-da98-4a6e-9494-175b44338680",
        "LogsetName": "test-logset",
        "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。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

创建云产品日志投递任务

本页目录：