1. 接口描述
接口请求域名: eb.tencentcloudapi.com 。
前置条件:需开启事件存储;事件查询维度值
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLogTagValue。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
StartTime | 是 | Integer | 起始时间 |
EndTime | 是 | Integer | 结束时间 |
EventBusId | 是 | String | 事件集ID 示例值:eb-xxxxxx |
GroupField | 是 | String | 聚合字段,取值范围如下:Source(事件源),RuleIds(命中规则),Subject(实例ID),Region(地域) 示例值:RuleIds |
Page | 是 | Integer | 页数 示例值:1 |
Limit | 是 | Integer | 每页数据大小 示例值:100 |
Filter.N | 否 | Array of LogFilter | 筛选条件 示例值:[{"key":"host","operator":"eq","value":"106.53.106.243"},{"type":"AND","filters":[{"key":"region","operator":"like","value":"guangzhou"},{"key":"type","operator":"eq","value":"cvm:ErrorEvent:GuestReboot"}]},{"type":"OR","filters":[{"key":"field1","operator":"like","value":"access"},{"key":"field2","operator":"eq","value":"custorm"}]}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Results | Array of String | 事件查询维度值结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 事件查询维度值结果
事件查询维度值结果
输入示例
POST / HTTP/1.1
Host: eb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogTagValue
<公共请求参数>
{
"StartTime": 1673233483024,
"EndTime": 1673838283024,
"EventBusId": "eb-xxxxx",
"GroupField": "Source",
"Page": 1,
"Limit": 1000
}
输出示例
{
"Response": {
"Results": [
"cvm.cloud.tencent"
],
"RequestId": "cfa5ba79-4169-44d5-a1c4-a95b8a8b4481"
}
}
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 | 内部错误。 |
InvalidParameterValue.Action | Action 操作参数取值与规范不符,请修正后再试。 |
ResourceNotFound | 资源不存在。 |