DescribeContainerGroupedFieldDetail - Security Center - Alibaba Cloud Documentation Center

Queries the attribute details of containers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeContainerGroupedFieldDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Criteria	string	Yes	The search conditions that are used to query assets. The value of this parameter is 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\":\"clusterId\",\"value\":\"cfd26658431084c73a48dd97328ba8acf\"}]
GroupField	string	Yes	The filter condition for a grouping and aggregation query. Valid values: pod appName clusterId namespace image containerScan	pod

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	7532B7EE-7CE7-5F4D-BF04-B12447DD****
Data	object	The data returned.
Pod	string	The name of the pod.	node-local-dns-zwsxl
CreateTime	long	The creation time.	1702433618301
ContainerCount	integer	The number of containers.	1
Namespace	string	The namespace.	default
ClusterState	string	The status of the cluster. Valid values: STARTING: The cluster is being started. START_FAILED: The cluster fails to be started. BOOTSTRAPPING: The bootstrap action is being performed for the cluster. RUNNING: The cluster is running. TERMINATING: The cluster is being terminated. TERMINATED: The cluster is terminated. TERMINATED_WITH_ERRORS: The cluster is terminated due to an exception. TERMINATE_FAILED: The cluster fails to be terminated.	RUNNING
RegionId	string	The ID of the region.	cn-shanghai
AppName	string	The name of the application.	node-local-dns
InstanceCount	integer	The number of instances.	1
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
NodeName	string	The name of the node.	shangliang-test
PodCount	integer	The number of pods.	1
ClusterName	string	The name of the cluster.	zhhtest
PodIp	string	The IP address of the pod.	192.168.1.1
ClusterCurrentVersion	string	The version of the current online server in the cluster.	1.14.8-aliyun.1
VulCount	integer	The number of vulnerabilities.	1
AlarmCount	integer	The number of alerts.	1
ClusterId	string	The ID of the cluster.	c8ca91e0907d94efaba7fb0827eb9****

Examples

Sample success responses

JSONformat

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DD****",
  "Data": {
    "Pod": "node-local-dns-zwsxl",
    "CreateTime": 1702433618301,
    "ContainerCount": 1,
    "Namespace": "default",
    "ClusterState": "RUNNING",
    "RegionId": "cn-shanghai",
    "AppName": "node-local-dns",
    "InstanceCount": 1,
    "ClusterType": "ManagedKubernetes",
    "NodeName": "shangliang-test",
    "PodCount": 1,
    "ClusterName": "zhhtest",
    "PodIp": "192.168.1.1",
    "ClusterCurrentVersion": "1.14.8-aliyun.1",
    "VulCount": 1,
    "AlarmCount": 1,
    "ClusterId": "c8ca91e0907d94efaba7fb0827eb9****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.