1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
获取容器事件列表
参数限制
- 当类型是 instance 时,GroupId是必填项
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeContainerEvents。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| ResourceType | 是 | String | event 的资源类型, 仅支持 group 示例值:group | 
| ResourceId | 是 | String | 部署组ID,按照【部署组ID】进行过滤,可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看;也可以调用CreateGroup创建新的项目。 示例值:group-df3fsd23 | 
| Offset | 否 | Integer | 偏移量,取值从0开始 示例值:0 | 
| Limit | 否 | Integer | 分页个数,默认为20, 取值应为1~50 示例值:1 | 
| GroupId | 否 | String | 部署组ID,可通过调用DescribeContainerGroups查询已创建的部署组列表或登录控制台进行查看;也可以调用CreateContainGroup创建新的部署组。 示例值:group-df3fsd23 | 
| Kind | 否 | String | event的资源种类 示例值:Deployment | 
| Type | 否 | String | event 的事件级别 示例值:Normal | 
| ResourceName | 否 | String | 资源名称 示例值:groupName-5b6bf7b6c5-d9jnm | 
| SearchWord | 否 | String | 关键词查询 示例值:group-df3fsd23 | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | TsfPageContainerEvent | events 分页列表 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 DescribeContainerEvents
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeContainerEvents
&ResourceType=instance
&ResourceId=test-event-6f46bcb6b-sxfcr
&GroupId=group-9yn2q8yd
&Offset=0
&Limit=20
&<公共请求参数>输出示例
{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "Content": [
                {
                    "FirstTimestamp": 0,
                    "LastTimestamp": 0,
                    "Type": "instance",
                    "Kind": "SERVER",
                    "Name": "test-event",
                    "Reason": "this is a reason",
                    "Message": "this is a msg",
                    "Count": 0
                }
            ]
        },
        "RequestId": "96561cf1-738a-47d6-943b-dec7ebbccabe"
    }
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.ContainergroupKubernetesApiInvokeError | 调用 kube-api-server 失败。 | 
| FailedOperation.ContainergroupKubernetesConnectError | 调用 kube-api-server 失败。 | 
| FailedOperation.UnhandledException | 模块未处理异常。 | 
| InternalError.ContainergroupKuberneteApiInvokeError | 访问TKE服务失败。 | 
| InternalError.ContainergroupKuberneteConnectError | 连接TKE服务失败。 | 
| InternalError.UnhandledException | 模块未处理异常。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue.ResourceTypeError | ResourceType 不支持。 | 
| ResourceNotFound.ClusterNotExist | 无法获取命名空间所属集群。 | 
| ResourceNotFound.ContainergroupGroupNamespaceClusterNotFound | 无法找到该部署组所属集群和命名空间。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |