调用DescribeGroupedContainerInstances接口根据分组类型查询对应的容器列表信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeGroupedContainerInstances

需要执行的操作。

取值:DescribeGroupedContainerInstances

Criteria String [{\"name\":\"riskStatus\",\"value\":\"YES\"},{\"name\":\"internetIp\",\"value\":\"1.2.3.4\"}]

设置搜索资产的条件。该参数格式为:[{\"name\":\"条件1名称\",\"value\":\"条件1值\"},{\"name\":\"条件2名称\",\"value\":\"条件2值\"},{},...]。

说明 支持使用实例ID、实例名称、所属VPC ID、地域、公网IP地址等条件搜索资产。您可以调用DescribeCriteria查询支持的搜索条件。
LogicalExp String OR

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

  • OR:表示多个条件间为的关系。
  • AND:表示多个条件间为的关系。
GroupField String pod

指定要查询的分组类型。取值:

  • pod:容器组。
  • appName:应用名称。
  • namespace:命名空间。
  • clusterId:集群ID。
FieldValue String cas-adad-qeqwe

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

  • GroupField选择为pod:指定要查询的容器组名称。
  • GroupField选择为appName:指定要查询的应用名称。
  • GroupField选择为namespace:指定要查询的命名空间。
  • GroupField选择为clusterId:指定要查询的集群ID。
说明 以上搜索条件均支持模糊搜索。
PageSize Integer 100

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

说明 建议PageSize取值不要为空。
CurrentPage Integer 1

分页查询时,指定当前页的页码。

返回数据

名称 类型 示例值 描述
GroupedContainerInstanceList Array of GroupedContainerInstance

容器资产信息列表。

AlarmCount Integer 1

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

AppName String oss-liveness-probe

应用名称。

ClusterId String cf3824769c85441b4bf3****

集群ID。

ClusterName String test

集群名称。

ClusterType String ManagedKubernetes

集群类型。取值:

  • Kubernetes:Kubernetes专有版。
  • ManagedKubernetes:标准托管集群(边缘集群)。
  • Ask:标准Serverless集群。
CreateTime Long 1600076893000

创建集群时间戳。

CusterState String running

集群运行状态。取值:

  • running:集群正在运行。
  • stopped:集群已经停止运行。
  • deleted:集群已经被删除。
  • delete_failed:删除集群失败。
  • failed:创建集群失败。
HostIp String 172.XX.XX.114

容器集群的主机IP。

InstanceCount Integer 9

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

InstanceId String i-8vb9ul5xec4tua4q****

服务器实例ID。

Namespace String kube-system

命名空间。

Pod String csi-plugin-2n****

容器组名称。

PodIp String 172.XX.XX.114

容器组IP。

RegionId String cn-hangzhou

地域ID。

RiskInstanceCount Integer 1

存在风险的实例数量。

RiskStatus String NO

风险状态。取值:

  • NO:无风险。
  • YES:有风险。
VulCount Integer 1

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

PageInfo Struct

数据分页信息。

Count Integer 1

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

CurrentPage Integer 1

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

PageSize Integer 20

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

TotalCount Integer 5

查询到的容器列表总数量。

RequestId String 4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D

阿里云为该请求生成的唯一标识符。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeGroupedContainerInstances
&<公共请求参数>

正常返回示例

XML 格式

<DescribeGroupedContainerInstancesResponse>
      <GroupedContainerInstanceList>
            <HostIp>192.XX.XX.124</HostIp>
            <InstanceCount>1</InstanceCount>
            <Pod>sca-test-0</Pod>
            <ClusterId>c690a0789419f4284a4e0a29e12fe****</ClusterId>
            <InstanceId>i-2zed0b4u6c43ru8t****</InstanceId>
            <PodIp>172.XX.XX.87</PodIp>
            <RiskInstanceCount>1</RiskInstanceCount>
            <CreateTime>1597821279000</CreateTime>
            <ClusterName>hh**</ClusterName>
            <RiskStatus>YES</RiskStatus>
            <VulCount>3</VulCount>
      </GroupedContainerInstanceList>
      <GroupedContainerInstanceList>
            <HostIp>192.XX.XX.126</HostIp>
            <InstanceCount>1</InstanceCount>
            <Pod>sca-test-1</Pod>
            <ClusterId>c690a0789419f4284a4e0a29e12fe****</ClusterId>
            <InstanceId>i-2zed0b4u6c43ru8t****</InstanceId>
            <PodIp>172.XX.XX.133</PodIp>
            <RiskInstanceCount>1</RiskInstanceCount>
            <CreateTime>1597821280000</CreateTime>
            <ClusterName>hh**</ClusterName>
            <RiskStatus>YES</RiskStatus>
            <VulCount>3</VulCount>
      </GroupedContainerInstanceList>
      <PageInfo>
            <TotalCount>3</TotalCount>
            <PageSize>20</PageSize>
            <CurrentPage>1</CurrentPage>
      </PageInfo>
      <RequestId>A15E4CEC-9ADB-4A03-942C-A02535A5F17A</RequestId>
</DescribeGroupedContainerInstancesResponse>

JSON 格式

{
	"GroupedContainerInstanceList": [{
		"HostIp": "192.XX.XX.124",
		"InstanceCount": 1,
		"Pod": "sca-test-0",
		"ClusterId": "c690a0789419f4284a4e0a29e12fe****",
		"InstanceId": "i-2zed0b4u6c43ru8t****",
		"PodIp": "172.XX.XX.87",
		"RiskInstanceCount": "1",
		"CreateTime": 1597821279000,
		"ClusterName": "hh**",
		"RiskStatus": "YES",
		"VulCount": 3
	}, {
		"HostIp": "192.XX.XX.126",
		"InstanceCount": 1,
		"Pod": "sca-test-1",
		"ClusterId": "c690a0789419f4284a4e0a29e12fe****",
		"InstanceId": "i-2zed0b4u6c43ru8t****",
		"PodIp": "172.XX.XX.133",
		"RiskInstanceCount": "1",
		"CreateTime": 1597821280000,
		"ClusterName": "hh**",
		"RiskStatus": "YES",
		"VulCount": 3
	}],
	"PageInfo": {
		"TotalCount": 3,
		"PageSize": 20,
		"CurrentPage": 1
	},
	"RequestId": "A15E4CEC-9ADB-4A03-942C-A02535A5F17A"
}

错误码

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