1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
创建环境日志资源
环境开通后,若用户需要开启检索日志功能,需调用此接口进行日志资源的开通。
注意:日志资源的开通为异步操作,接口调用成功后并不代表日志资源已立即可用。
如何确认日志开通状态:
可通过 DescribeEnvs 接口轮询查询日志开通结果,建议每 5 秒轮询一次,最长等待 5 分钟。在返回的数据结构 EnvInfo 中,检查 LogServices 字段下 LogServiceInfo 是否包含有效的日志主题(Topic)等相关信息,以此判断日志资源是否已成功开通:
- 已开通:
LogServiceInfo中存在日志主题 ID 等有效信息 - 未开通 / 开通中:
LogServiceInfo为空或相关字段缺失
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateEnvResource。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值:wzr-0gp9mmjwba501429 |
| Resources.N | 是 | Array of String | 资源类型。代表本次开通哪些资源。 可取值以及含义: - log : 表示日志资源,当前仅支持 log(日志资源类型),后续版本可能扩展,该数组不能为空,且每个元素必须为合法的资源类型值 示例值:["log"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开通环境下日志资源
用户在开通环境成功后,如果需要查询服务上报日志,需要调用此接口开通日志资源
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEnvResource
<公共请求参数>
{
"EnvId": "wzr-0gp9mmjwba501429",
"Resources": [
"log"
]
}
输出示例
{
"Response": {
"RequestId": "44e44515-8ef8-4ffe-a301-b6c1cb23795a"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| MissingParameter.Param | 缺少必要参数。 |
| ResourceInUse.LogExist | 环境下日志资源已存在,无需重新开通日志资源 |
| ResourceUnavailable | 资源不可用。 |