Queries the details about containers by group type.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGroupedContainerInstances

The operation that you want to perform.

Set the value to DescribeGroupedContainerInstances.

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

The search conditions. The value of this parameter is in the following format: [{\"name\":\"Name of condition 1\",\"value\":\"Value of condition 1\"},{\"name\":\"Name of condition 2\",\"value\":\"Value of condition 2\"},{},...].

Note Supported search conditions include the instance ID, instance name, virtual private cloud (VPC) ID, region, and public IP address. You can call the DescribeCriteria operation to query the supported search conditions.
LogicalExp String No OR

The logical relationship between search conditions. Valid values:

  • OR
  • AND
GroupField String No pod

The type of the group to query. Valid values:

  • pod
  • appName
  • namespace
  • clusterId
FieldValue String No cas-adad-qeqwe

The search condition based on the group type. This parameter depends on the value of the GroupField parameter.

  • If the GroupField parameter is set to pod, set this parameter to the name of the pod that you want to query.
  • If the GroupField parameter is set to appName, set this parameter to the name of the application that you want to query.
  • If the GroupField parameter is set to namespace, set this parameter to the namespace that you want to query.
  • If the GroupField parameter is set to clusterId, set this parameter to the ID of the cluster that you want to query.
Note Fuzzy match is supported.
PageSize Integer No 100

The number of entries to return on each page. Default value: 20.

Note We recommend that you do not leave this parameter blank.
CurrentPage Integer No 1

The page number of the current page.

Response parameters

Parameter Type Example Description
GroupedContainerInstanceList Array of GroupedContainerInstance

The details about the container.
AlarmCount Integer 1

The number of alerts detected for the current pod, application, namespace, or cluster.
AppName String oss-liveness-probe

The name of the application.
ClusterId String cf3824769c85441b4bf3****

The ID of the cluster.
ClusterName String test

The name of the cluster.
ClusterType String ManagedKubernetes

The type of the cluster. Valid values:

  • Kubernetes: dedicated cluster
  • ManagedKubernetes: standard managed cluster (edge cluster)
  • Ask: standard serverless cluster
CreateTime Long 1600076893000

The timestamp when the cluster was created.
CusterState String running

The status of the cluster. Valid values:

  • running: The cluster is running.
  • stopped: The cluster is stopped.
  • deleted: The cluster is deleted.
  • delete_failed: The cluster fails to be deleted.
  • failed: The cluster fails to be created.
HostIp String 172.XX.XX.114

The IP address of the host in the container cluster.
InstanceCount Integer 9

The number of queried pods, applications, clusters, or namespaces.
InstanceId String i-8vb9ul5xec4tua4q****

The ID of the server.
Namespace String kube-system

The namespace.
Pod String csi-plugin-2n****

The name of the pod.
PodIp String 172.XX.XX.114

The IP address of the pod.
RegionId String cn-hangzhou

The region ID.
RiskInstanceCount Integer 1

The number of at-risk instances.
RiskStatus String NO

Indicates whether risks were detected. Valid values:

  • NO: No risks were detected.
  • YES: Risks were detected.
VulCount Integer 1

The number of vulnerabilities that are detected for the current pod, application, namespace, or cluster.

PageInfo Struct

The page information.
Count Integer 1

The number of entries returned on the current page.
CurrentPage Integer 1

The page number of the current page.
PageSize Integer 20

The number of entries returned per page.
TotalCount Integer 5

The number of queried containers.
RequestId String 4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeGroupedContainerInstances
&<Common request parameters>

Sample success responses

XML format 

<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 format 

{
    "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"
}

Error codes

For a list of error codes, visit the API Error Center.