DescribeGroupedContainerInstances API Reference - Security Center - Alibaba Cloud - Security Center

Queries containers by group type.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeGroupedContainerInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Criteria	string	No	The search conditions for assets. Specify the value in the JSON format. Separate multiple search conditions with commas (,). Example: `[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"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.	[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]
LogicalExp	string	No	The logical relationship that you want to use to evaluate multiple search conditions. Valid values: OR: Search conditions are evaluated by using a logical OR. AND: Search conditions are evaluated by using a logical AND.	OR
GroupField	string	Yes	The group type that you want to use to query containers. Valid values: pod appName namespace clusterId image	pod
FieldValue	string	No	The keyword that you want to use to query containers. 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. If the GroupField parameter is set to image, set this parameter to the name of the image that you want to query. Note Fuzzy match is supported.	cas-adad-qeqwe
PageSize	integer	No	The number of entries to return on each page. Default value: 20. Note We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	4E5BFDCF-B9DD-430D-9DA4-151BCB581C9D
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 20.	20
TotalCount	integer	The total number of container assets returned.	25
Count	integer	The number of container assets returned on the current page.	20
GroupedContainerInstanceList	array<object>	The information about the container.
	object
RiskLevel	string	The risk level. Valid values: high medium low	low
HostIp	string	The IP address of the host in the container cluster.	172.114.XX.XX
Pod	string	The name of the pod.	csi-plugin-2n****
RiskStatus	string	Indicates whether risks were detected. Valid values: NO YES	NO
CreateTime	integer	The timestamp when the cluster was created. Unit: milliseconds.	1600076893000
Namespace	string	The namespace of the cluster.	kube-system
CusterState	string	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 failed to be deleted. failed: The cluster failed to be created.	running
InstanceId	string	The ID of the server.	i-8vb9ul5xec4tua4q****
RegionId	string	The region ID of the instance.	cn-hangzhou
AppName	string	The name of the application.	oss-liveness-probe
InstanceCount	integer	The number of pods, applications, clusters, or namespaces.	9
ClusterType	string	The type of the cluster. Valid values: Kubernetes: dedicated Kubernetes cluster. ManagedKubernetes: standard managed cluster (edge cluster). Ask: serverless Kubernetes (ASK) cluster.	ManagedKubernetes
ClusterName	string	The name of the cluster.	test
PodIp	string	The IP address of the pod.	172.114.XX.XX
VulCount	integer	The number of vulnerabilities that are detected for the current pod, application, namespace, or cluster.	1
AlarmCount	integer	The number of alerts that are detected for the current pod, application, namespace, or cluster.	1
RiskInstanceCount	integer	The number of at-risk instances.	1
ClusterId	string	The ID of the cluster.	cf3824769c85441b4bf3****
Image	string	The container image.	registry-vpc.ap-southeast-5.aliyuncs.com/log-service-release/sls-connector:1.1.77
ImageRepoNamespace	string	The namespace of the image repository.	name001
ImageRepoName	string	The name of the image repository.	test-003
ImageRepoTag	string	The tag that is added to the image repository.	dev-20220512-2
ImageDigest	string	The digest value of the image.	58e58c013f70bbfde140c8a55c1078074b3483479428d4069aa946827fd566cf
ImageUuid	string	The UUID of the image.	e4bdec1d9ba7e0967111a7ea467c****
HcCount	integer	The number of baseline risks that are detected for the current pod, application, namespace, or cluster.	20
SyncOpen	integer	Indicates whether the synchronization of cluster audit logs is enabled. Valid values: 0: disabled. 1: enabled.	1
SyncStatus	integer	The status of the synchronization of cluster audit logs. Valid values: 0: The synchronization failed. 1: The synchronization is successful.	1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	IllegalParam	Illegal param
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.