全部产品
Search

搜索本产品

    云安全中心：DescribeContainerInstances - 获取容器的实例信息列表

    文档中心

    云安全中心：DescribeContainerInstances - 获取容器的实例信息列表

    更新时间：Nov 25, 2024

    获取容器的实例信息列表。

    调试

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

    授权信息

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

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

    请求参数

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

    设置搜索资产的条件。该参数 JSON 格式，输入参数时注意大小写。包含一下字段：

    • name：检索项
    • value：检索项值
    • logicalExp：多条件时，检索项之间的关系，取值：
      • OR：表示多个条件间为或的关系。
      • AND：表示多个条件间为与的关系。
    说明 支持使用容器 ID、集群 ID、集群名称、集群类型、风险等级、地域、等条件搜索资产。您可以调用 DescribeContainerCriteria 接口查询支持的搜索条件。
    		[{"name":"flag","value":"0|8","logicalExp":"AND"},{"name":"ecsType","value":"!8","logicalExp":"AND"}][{"name":"clusterType","value":"NotManagedKubernetes","logicalExp":"AND"}]
    LogicalExpstring否

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

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

    指定分页查询时，每页显示的数据最大条数。每页默认显示的数据条数为 20 条，PageSize 参数值为空时，将默认返回 20 条数据。

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

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

    		1

    返回参数

    名称类型描述示例值
    object

    请求返回数据。

    RequestIdstring

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

    		79CFF74D-E967-5407-8A78-EE03B925FDAA
    PageInfoobject

    分页信息。

    CurrentPageinteger

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

    		1
    PageSizeinteger

    分页查询时，每页最多显示的数据条数。

    		20
    TotalCountinteger

    查询结果的总数。

    		45
    Countinteger

    分页查询时，当前页显示的数据条数。

    		3
    ContainerInstanceListarray<object>

    容器资产信息列表。

    ContainerInstanceobject

    容器资产信息。

    ImageRepoTagstring

    镜像的标签。

    		0.3.1.0-dfa2010-aliyun
    AppNamestring

    应用名称。

    		alibaba-log-controller
    PodIpstring

    pod 地址。

    		172.24.XX.XX
    VulCountinteger

    当前容器集群中存在漏洞数量。

    		15
    HcStatusstring

    基线风险状态。取值：

    • NO：没有基线问题
    • YES：有基线问题
    		YES
    ImageIdstring

    镜像 ID。

    		registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****
    ClusterIdstring

    集群 ID。

    		cfb41a869c71e4678a97021582dd8a****
    ImageRepoNamestring

    镜像的仓库名称。

    		log-controller
    HostIpstring

    主机 IP。

    		172.24.XX.XX
    Podstring

    容器组。

    		alibaba-log-controller-6f847f8786-mk2mg
    RiskStatusstring

    是否存在风险 。取值：

    • NO：无风险
    • YES：有风险
    		YES
    VulStatusstring

    容器资产是否存在漏洞。取值：

    • YES：存在漏洞
    • NO：不存在漏洞
    		YES
    AlarmStatusstring

    容器是否存在安全告警。取值：

    • YES：存在安全告警
    • NO：不存在安全告警
    		YES
    Imagestring

    容器镜像。

    		docker.io/library/nginx:latest
    ImageRepoNamespacestring

    镜像仓库命名空间。

    		acs
    ImageDigeststring

    镜像 digest 值。

    		5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****
    Namespacestring

    命名空间。

    		kube-system
    InstanceIdstring

    资产实例 ID。

    		i-2zegzjyotydfkz9****
    NodeInfostring

    节点信息。

    		test
    ImageUuidstring

    镜像 UUID。

    		5f23dfbceec289a49ac94e035e2****
    RegionIdstring

    容器所在的地域的 ID。

    		cn-hangzhou
    UpdateMarkstring

    容器资产的更新标识。

    		79cff74d-e967-5407-8a78-ee03b9****
    ContainerIdstring

    容器 ID。

    		48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****
    NodeNamestring

    节点名称。

    		test
    HcCountinteger

    基线风险数量。

    		1
    ClusterNamestring

    集群名称。

    		test
    RiskCountstring

    风险数量。

    		1
    AlarmCountinteger

    告警数量。

    		1
    CreateTimestamplong

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

    		1670368337000
    Exposedinteger

    是否公网暴露。

    • 1：暴露
    • 0：未暴露
    		1
    ExposedDetailstring

    json 字符串暴露详情。

    		[{\"exposedName\":\"nginx-ingress-lb\",\"exposedType\":\"LoadBalancer\",\"portDOList\":[{\"name\":\"http\",\"nodePort\":32268,\"port\":80,\"targetPort\":80},{\"name\":\"https\",\"nodePort\":32376,\"port\":443,\"targetPort\":443}]}]

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "79CFF74D-E967-5407-8A78-EE03B925FDAA",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 45,
    "Count": 3
  },
  "ContainerInstanceList": [
    {
      "ImageRepoTag": "0.3.1.0-dfa2010-aliyun",
      "AppName": "alibaba-log-controller",
      "PodIp": "172.24.XX.XX",
      "VulCount": 15,
      "HcStatus": "YES",
      "ImageId": "registry-vpc.cn-beijing.aliyuncs.com/acs/log-controller@sha256:5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****",
      "ClusterId": "cfb41a869c71e4678a97021582dd8a****",
      "ImageRepoName": "log-controller",
      "HostIp": "172.24.XX.XX",
      "Pod": "alibaba-log-controller-6f847f8786-mk2mg",
      "RiskStatus": "YES",
      "VulStatus": "YES",
      "AlarmStatus": "YES",
      "Image": "docker.io/library/nginx:latest",
      "ImageRepoNamespace": "acs",
      "ImageDigest": "5b046e2de8c490819125193ee2eb71a66f2cc16c032dcd8b69ead4be1024****",
      "Namespace": "kube-system",
      "InstanceId": "i-2zegzjyotydfkz9****",
      "NodeInfo": "test",
      "ImageUuid": "5f23dfbceec289a49ac94e035e2****",
      "RegionId": "cn-hangzhou",
      "UpdateMark": "79cff74d-e967-5407-8a78-ee03b9****",
      "ContainerId": "48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d****",
      "NodeName": "test",
      "HcCount": 1,
      "ClusterName": "test",
      "RiskCount": "1",
      "AlarmCount": 1,
      "CreateTimestamp": 1670368337000,
      "Exposed": 1,
      "ExposedDetail": "[{\\\"exposedName\\\":\\\"nginx-ingress-lb\\\",\\\"exposedType\\\":\\\"LoadBalancer\\\",\\\"portDOList\\\":[{\\\"name\\\":\\\"http\\\",\\\"nodePort\\\":32268,\\\"port\\\":80,\\\"targetPort\\\":80},{\\\"name\\\":\\\"https\\\",\\\"nodePort\\\":32376,\\\"port\\\":443,\\\"targetPort\\\":443}]}] "
    }
  ]
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-06-21OpenAPI 返回结构发生变更查看变更详情