全部产品
Search

搜索本产品

    云安全中心：DescribeGroupedContainerInstances - 查询容器列表信息

    文档中心

    云安全中心：DescribeGroupedContainerInstances - 查询容器列表信息

    更新时间：Nov 25, 2024

    根据分组类型查询对应的容器列表信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    Criteriastring否

    设置搜索资产的条件。该参数为 JSON 格式，多个条件之间使用半角逗号（,）分隔。例如：[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]。

    说明 支持使用实例 ID、实例名称、所属 VPC ID、地域、公网 IP 地址等条件搜索资产。您可以调用 DescribeCriteria 查询支持的搜索条件。
    		[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]
    LogicalExpstring否

    设置多个搜索条件间生效的逻辑关系。取值：

    • OR：表示多个条件间为或的关系。
    • AND：表示多个条件间为与的关系。
    		OR
    GroupFieldstring是

    要查询的分组类型。取值：

    • pod：容器组。
    • appName：应用名称。
    • namespace：命名空间。
    • clusterId：集群 ID。
    • image：镜像。
    		pod
    FieldValuestring否

    设置不同分组类型的搜索条件。根据 GroupField 选择的类型您需要设置以下搜索条件：

    • GroupField 选择为 pod：指定要查询的容器组名称。
    • GroupField 选择为 appName：指定要查询的应用名称。
    • GroupField 选择为 namespace：指定要查询的命名空间。
    • GroupField 选择为 clusterId：指定要查询的集群 ID。
    • GroupField 选择为 image：指定要查询的镜像名称。
    说明 以上搜索条件均支持模糊搜索。
    		cas-adad-qeqwe
    PageSizeinteger否

    设置分页查询时，每页显示的容器资产的数量。默认值为 20，表示每页显示 20 条容器资产信息。

    说明 建议 PageSize 取值不要为空。
    		20
    CurrentPageinteger否

    设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。

    		1

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

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

    		4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
    PageInfoobject

    数据分页信息。

    CurrentPageinteger

    分页查询时，当前页的页码。

    		1
    PageSizeinteger

    分页查询时，每页显示的容器资产的数量。默认值为 20，表示每页显示 20 条容器资产信息。

    		20
    TotalCountinteger

    查询到的容器资产的总数量。

    		25
    Countinteger

    分页查询时，当前页显示的容器资产信息的条数。

    		20
    GroupedContainerInstanceListarray<object>

    查询到的容器资产信息的列表。

    GroupedContainerInstanceobject

    容器资产信息。

    RiskLevelstring

    风险的等级。取值：

    • high：高危
    • medium：中危
    • low：低危
    		low
    HostIpstring

    容器集群的主机 IP。

    		172.114.XX.XX
    Podstring

    容器组名称。

    		csi-plugin-2n****
    RiskStatusstring

    风险状态。取值：

    • NO：无风险。
    • YES：有风险。
    		NO
    CreateTimelong

    创建集群时间戳，单位为毫秒。

    		1600076893000
    Namespacestring

    集群的命名空间。

    		kube-system
    CusterStatestring

    集群的运行状态。取值：

    • running：集群正在运行。
    • stopped：集群已经停止运行。
    • deleted：集群已经被删除。
    • delete_failed：删除集群失败。
    • failed：创建集群失败。
    		running
    InstanceIdstring

    服务器实例的 ID。

    		i-8vb9ul5xec4tua4q****
    RegionIdstring

    实例所在的地域的 ID。

    		cn-hangzhou
    AppNamestring

    应用名称。

    		oss-liveness-probe
    InstanceCountinteger

    查询到的容器组数量、应用数量、集群数量或命名空间数量。

    		9
    ClusterTypestring

    集群的类型。取值：

    • Kubernetes：Kubernetes 专有版。
    • ManagedKubernetes：标准托管集群（边缘集群）。
    • Ask：标准 Serverless 集群。
    		ManagedKubernetes
    ClusterNamestring

    集群名称。

    		test
    PodIpstring

    容器组 IP。

    		172.114.XX.XX
    VulCountinteger

    在当前容器组、应用、命名空间或集群中检测出的漏洞数量。

    		1
    AlarmCountinteger

    在当前容器组、应用、命名空间或集群中检测出的告警数量。

    		1
    RiskInstanceCountinteger

    存在风险的实例数量。

    		1
    ClusterIdstring

    集群 ID。

    		cf3824769c85441b4bf3****
    Imagestring

    容器镜像。

    		registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77
    ImageRepoNamespacestring

    镜像仓库命名空间。

    		name001
    ImageRepoNamestring

    镜像仓库名称。

    		test-003
    ImageRepoTagstring

    镜像仓库标签。

    		dev-20220512-2
    ImageDigeststring

    镜像 digest 值。

    		58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf
    ImageUuidstring

    镜像 UUID。

    		e4bdec1d9ba7e0967111a7ea467c****
    HcCountinteger

    在当前容器组、应用、命名空间或集群中检测出的基线总数。

    		20
    SyncOpeninteger

    集群日志审计同步开关。取值：

    • 0：关闭。
    • 1：开启。
    		1
    SyncStatusinteger

    集群日志审计同步状态。取值：

    • 0：同步失败。
    • 1：同步成功。
    		1

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 25,
    "Count": 20
  },
  "GroupedContainerInstanceList": [
    {
      "RiskLevel": "low",
      "HostIp": "172.114.XX.XX",
      "Pod": "csi-plugin-2n****",
      "RiskStatus": "NO",
      "CreateTime": 1600076893000,
      "Namespace": "kube-system",
      "CusterState": "running",
      "InstanceId": "i-8vb9ul5xec4tua4q****",
      "RegionId": "cn-hangzhou",
      "AppName": "oss-liveness-probe",
      "InstanceCount": 9,
      "ClusterType": "ManagedKubernetes",
      "ClusterName": "test",
      "PodIp": "172.114.XX.XX",
      "VulCount": 1,
      "AlarmCount": 1,
      "RiskInstanceCount": 1,
      "ClusterId": "cf3824769c85441b4bf3****",
      "Image": "registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77",
      "ImageRepoNamespace": "name001",
      "ImageRepoName": "test-003",
      "ImageRepoTag": "dev-20220512-2",
      "ImageDigest": "58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf",
      "ImageUuid": "e4bdec1d9ba7e0967111a7ea467c****",
      "HcCount": 20,
      "SyncOpen": 1,
      "SyncStatus": 1
    }
  ]
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2024-01-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2021-12-21OpenAPI 错误码发生变更查看变更详情