获取事件

最近更新时间:2025-05-22 14:37:57

我的收藏

1. 接口描述

接口请求域名: tione.tencentcloudapi.com 。

获取任务式建模训练任务,Notebook,在线服务和批量预测任务的事件API

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeEvents。
Version String 公共参数,本接口取值:2021-11-11。
Region String 公共参数,详见产品支持的 地域列表
Service String 服务类型,TRAIN为任务式建模, NOTEBOOK为Notebook, INFER为在线服务, BATCH为批量预测
枚举值:
- TRAIN
- NOTEBOOK
- INFER
- BATCH
示例值:TRAIN
ServiceId String 服务ID,和Service参数对应,不同Service的服务ID获取方式不同,具体如下:
- Service类型为TRAIN:
调用DescribeTrainingTask接口查询训练任务详情,ServiceId为接口返回值中Response.TrainingTaskDetail.LatestInstanceId
- Service类型为NOTEBOOK:
调用DescribeNotebook接口查询Notebook详情,ServiceId为接口返回值中Response.NotebookDetail.PodName
- Service类型为INFER:
调用DescribeModelServiceGroup接口查询服务组详情,ServiceId为接口返回值中Response.ServiceGroup.Services.ServiceId
- Service类型为BATCH:
调用DescribeBatchTask接口查询跑批任务详情,ServiceId为接口返回值中Response.BatchTaskDetail.LatestInstanceId
示例值:train-fsdjl-1
StartTime String 查询事件最早发生的时间(RFC3339格式的时间字符串),默认值为当前时间的前一天
示例值:2021-11-30T16:22:09+08:00
EndTime String 查询事件最晚发生的时间(RFC3339格式的时间字符串),默认值为当前时间
示例值:2021-11-30T16:22:09+08:00
Limit Integer 分页Limit,默认值为100,最大值为100
示例值:100
Offset Integer 分页Offset,默认值为0
示例值:1
Order String 排列顺序(可选值为ASC, DESC ),默认为DESC
示例值:DESC
OrderField String 排序的依据字段(可选值为FirstTimestamp, LastTimestamp),默认值为LastTimestamp
示例值:LastTimestamp
Filters.N Array of Filter 过滤条件
注意:
1. Filter.Name:目前支持ResourceKind(按事件关联的资源类型过滤);Type(按事件类型过滤)
2. Filter.Values:
对于Name为ResourceKind,Values的可选取值为Deployment, Replicaset, Pod等K8S资源类型;
对于Name为Type,Values的可选取值仅为Normal或者Warning;
Values为多个的时候表示同时满足
3. Filter. Negative和Filter. Fuzzy没有使用

3. 输出参数

参数名称 类型 描述
Events Array of Event 事件的列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 此次查询的事件的个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取事件

获取服务相关的事件(k8s事件)信息

输入示例

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

{
    "Service": "INFER",
    "Limit": 10,
    "Offset": 0,
    "Filters": [
        {
            "Name": "ResourceKind",
            "Values": [
                "Pod"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Events": [
            {
                "Id": "44b40fe5-9546-42fd-b75d-557802e0029d",
                "Message": "Created container sidecar-nginx",
                "FirstTimestamp": "2022-01-10T19:22:04+08:00",
                "LastTimestamp": "2022-01-10T19:22:04+08:00",
                "Count": 1,
                "Type": "Normal",
                "ResourceKind": "Pod",
                "ResourceName": "ms-cp6rgw9r-1-864587bdb4-p5cv6"
            }
        ],
        "TotalCount": 1,
        "RequestId": "090e057a-0d4e-488a-978b-83b1636fee99"
    }
}

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 操作失败。