文档

DescribeContainerCriteria - 获取容器列表支持的检索信息

更新时间:

获取容器列表支持的检索信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeContainerCriteriaget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupFieldstring

检索项。取值:

  • pod:pod。
  • appName:应用名称。
  • clusterId:集群编号。
  • namespace:命名空间。
  • image:镜像。
  • containerScan:容器扫描。
clusterId
Valuestring

检索项对应值。支持应用名称、节点名称、命名空间、集群名称、公网 IP、Pod 地址、地域、Pod、实例 ID、集群 ID、容器 ID 模糊搜索。

cfb41a869c71e4678a97021582dd8a****

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
CriteriaListarray<object>

支持检索项信息列表。

Criteriaobject

支持检索项信息。

Typestring

查询条件的类型。取值:

  • input:需要手动输入查询字段。
  • select:需要从下拉列表中选择查询条件的子类型。
input
Namestring

对应的查询条件的名称。

  • instanceId:容器实例 ID。
  • clusterId:集群 ID。
  • regionId:容器地域。
  • clusterName:集群名称。
  • image:镜像名称。
  • imageRepoName:镜像仓名称。
  • imageRepoNamespace:镜像仓命名空间。
  • imageRepoTag:镜像仓标签。
  • imageDigest:镜像 digest。
  • clusterType:集群类型。
  • hostIp:公网 IP。
  • pod:pod。
  • podIp:pod IP。
  • containerId:容器 ID。
  • vulStatus:容器是否存在漏洞。
  • alarmStatus:容器是否存在安全告警。
  • riskStatus:容器是否存在风险。
  • riskLevel:容器风险等级。
  • containerScope:容器类型。
clusterId
Valuesstring

Type(查询条件的类型)为 select(选择型)时,可选项的值。

说明 Type(查询条件的类型)为 input(输入型)时,该参数返回值为空。
ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes

示例

正常返回示例

JSON格式

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "CriteriaList": [
    {
      "Type": "input",
      "Name": "clusterId",
      "Values": "ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。