1. 接口描述
接口请求域名: tem.tencentcloudapi.com 。
创建日志收集配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateLogConfig。 |
Version | 是 | String | 公共参数,本接口取值:2021-07-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
EnvironmentId | 是 | String | 环境 ID 示例值:environment-xxx |
Name | 是 | String | 配置名 示例值:xxx |
InputType | 是 | String | 收集类型,container_stdout 为标准输出;container_file 为文件; 示例值:container_file |
ApplicationId | 否 | String | 应用 ID 示例值:application-xxxx |
LogsetId | 否 | String | 日志集 ID 示例值:xxxx |
TopicId | 否 | String | 日志主题 ID 示例值:xxxx |
LogType | 否 | String | 日志提取模式,minimalist_log 为单行全文;multiline_log 为多行全文;json_log 为 json格式;fullregex_log 为单行正则;multiline_fullregex_log 为多行正则 示例值:minimalist_log |
BeginningRegex | 否 | String | 首行正则表达式,当LogType=multiline_log 时生效 示例值:/xx/ |
LogPath | 否 | String | 收集文件目录,当 InputType=container_file 时生效 示例值:/xxx |
FilePattern | 否 | String | 收集文件名模式,当 InputType=container_file 时生效 示例值:app_*.log |
ExtractRule | 否 | LogConfigExtractRule | 导出规则 示例值:{} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Boolean | 创建是否成功 示例值:true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建日志收集配置
创建日志收集配置
输入示例
POST / HTTP/1.1
Host: tem.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLogConfig
<公共请求参数>
{
"TopicId": "xx",
"Name": "xx",
"EnvironmentId": "xx",
"LogPath": "xx",
"InputType": "xx",
"LogType": "xx",
"FilePattern": "xx",
"ApplicationId": "xx",
"LogsetId": "xx",
"ExtractRule": {
"BeginningRegex": "xxx",
"Keys": [
"xxx"
]
}
}
输出示例
{
"Response": {
"RequestId": "81f74023-563c-437d-abf7-8139449ef178",
"Result": true
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.CreateConfigDataError | 创建配置失败。 |
InternalError.CreateLogConfigError | 创建 LogConfig 错误。 |
InternalError.DefaultInternalError | 服务器繁忙,请稍后再试。 |
InvalidParameterValue.ConfigDataAlreadyExist | 配置已存在。 |
InvalidParameterValue.LogConfigAlreadyExist | LogConfig 配置已存在。 |
InvalidParameterValue.NamespaceNotBelongToAppid | 命名空间不属于用户。 |
InvalidParameterValue.TemIdInvalid | 不是合法的TEM ID。 |
MissingParameter.NamespaceIdNull | 环境ID不能为空。 |
ResourceNotFound.VersionNamespaceNotFound | 找不到版本对应的环境。 |
UnauthorizedOperation.UnauthorizedOperation | 未授权。 |