1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询镜像拦截事件详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeImageDenyEventDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| EventID | 是 | Integer | 事件ID 示例值:1002 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EventID | Integer | 事件ID 示例值:1 |
| EventType | String | 事件类型 EVENT_RISK:风险事件类型,EVENT_PRIVILEGE:特权 示例值:EVENT_RISK |
| RuleName | String | 规则名称 示例值:name01 |
| RuleID | String | 规则RuleID 示例值:1 |
| RuleType | String | 规则类型 示例值:GLOBAL |
| RuleStatus | Integer | 规则启用状态 0:开启,1:关闭 示例值:0 |
| RuleEffectStatus | String | 规则策略状态 IN_THE_TEST :观察中,IN_EFFECT:生效中 示例值:IN_THE_TEST |
| RuleInfo | Array of String | 规则内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:rule info |
| RuleDescription | String | 规则描述 示例值:rule desc |
| ImageID | String | 镜像ID 示例值:sha256:707540fd8a54ab3ebc086ecc96d2d6143fd92c1cac4d0b23353e1b7078b5937b |
| ImageName | String | 镜像名称 示例值:name1 |
| NodeName | String | 节点名称 示例值:nodeName |
| NodeIP | String | 内网IP 示例值:127.0.0.1 |
| PublicIP | String | 外网IP 示例值:10.2.0.1 |
| QUUID | String | 主机Quuid 示例值:5a540076-d38a-4078-aa98-e7c86371d322 |
| FoundTime | String | 首次生成时间 示例值:2006-01-02 15:04:05 |
| LatestFoundTime | String | 最近生成时间 示例值:2006-01-02 15:04:05 |
| EventCount | Integer | 事件数量 示例值:1 |
| DealBehavior | String | 执行动作: BEHAVIOR_ALERT:告警, BEHAVIOR_HOLDUP_SUCCESSED:拦截 示例值:BEHAVIOR_ALERT |
| PodName | String | Pod名称 示例值:name2 |
| RuleEffectTime | String | 规则开始拦截时间 示例值:2006-01-02 15:04:05 |
| Description | String | 事件描述 示例值:event desc |
| StartParam | String | 镜像启动参数 示例值:/etc/ |
| Solution | String | 解决方案 示例值:solution content |
| PodIP | String | pod ip 示例值:127.0.0.1 |
| PodStatus | String | pod状态 示例值:RUNNING |
| ClusterID | String | 集群id 示例值:cls-4waue9dh |
| NodeType | String | 节点类型 示例值:NOMRAL |
| NodeID | String | 节点id 示例值:eklet-subnet-1ewk3avk |
| NodeUniqueID | String | 节点唯一id 示例值:eb7b9af448345924bab44fc90a1b4e3b |
| NodeSubNetID | String | 节点子网id 示例值:subnet01 |
| NodeSubNetName | String | 节点子网名称 示例值:subnet02 |
| NodeSubNetCIDR | String | 节点子网cidr 示例值:10.10.2.0/24 |
| ClusterName | String | 集群名称 示例值:prom-g62znlhv |
| ImageRegistryInfo | ImageRegistryInfo | 镜像仓库信息 示例值:{} |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询镜像拦截事件详情
查询镜像拦截事件详情
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageDenyEventDetail
<公共请求参数>
{
"EventID": "10"
}
输出示例
{
"Response": {
"ClusterID": "cls-4waue9dh",
"ClusterName": "prom-g62znlhv",
"DealBehavior": "BEHAVIOR_HOLDUP_SUCCESSED",
"Description": "该镜像命中拦截规则(id:ce25d78c-d247-4e2f-80ee-190e089ea434)触发拦截操作, 规则详情:该镜像存在存在漏洞: 按漏洞分类",
"EventCount": 185,
"EventID": 2414001,
"EventType": "EVENT_RISK",
"FoundTime": "2024-11-02 00:03:32",
"ImageID": "sha256:d41059c812a8741c15695046857b90747aef9c7f9d67733962d7bbb025b9d159",
"ImageName": "registry.tce.com/etcd/etcd:3.4.18.amd64",
"LatestFoundTime": "2024-11-02 15:42:37",
"NodeID": "eklet-subnet-1ewk3avk",
"NodeIP": "10.206.1.2",
"NodeName": "tcs-10-206-67-153",
"NodeSubNetCIDR": "172.16.64.0/20",
"NodeSubNetID": "subnet-1ewk3avk",
"NodeSubNetName": "subnet-1ewk3avk",
"NodeType": "NORMAL",
"NodeUniqueID": "eb7b9af448345924bab44fc90a1b4e3b",
"PodIP": "127.0.0.1",
"PodName": "pod1",
"PodStatus": "RUNNING",
"PublicIP": "127.0.0.1",
"QUUID": "46d3b4de-add7-4378-af19-ad34baeb6b4b",
"RequestId": "b610c113-b940-4c0c-b937-b8edf518ef92",
"RuleDescription": "测试",
"RuleEffectStatus": "IN_EFFECT",
"RuleEffectTime": "2024-10-30 10:52:56",
"RuleID": "ce25d78c-d247-4e2f-80ee-190e089ea434",
"RuleInfo": [
"IMAGE_DENY_VUL_CLASS"
],
"RuleName": "name01",
"RuleStatus": 1,
"RuleType": "RULE_RISK",
"Solution": "CVE漏洞:将存在漏洞的组件更新到对应修复版本",
"StartParam": "/opt/containerd/bin/runc runc --root /var/run/docker/runtime-runc/moby --log /run/docker/containerd/daemon/io.containerd.runtime.v1.linux/moby/9deace634eeb3fc28f7ac7bdbdeae6e917c89d1fc668892b25af20555fbd2832/log.json --log-format json create --bundle /var/run/docker/containerd/daemon/io.containerd.runtime.v1.linux/moby/9deace634eeb3fc28f7ac7bdbdeae6e917c89d1fc668892b25af20555fbd2832 --pid-file /var/run/docker/containerd/daemon/io.containerd.runtime.v1.linux/moby/9deace634eeb3fc28f7ac7bdbdeae6e917c89d1fc668892b25af20555fbd2832/init.pid 9deace634eeb3fc28f7ac7bdbdeae6e917c89d1fc668892b25af20555fbd2832",
"ImageRegistryInfo": {
"Name": "registry01",
"Type": "tcr",
"Address": "ccr.ccs.tencentyun.com/t-pot/logstash"
}
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter.MissingParameter | 缺少必须参数。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnknownParameter | 未知参数错误。 |