DescribeContainerGroupedFieldDetail - Query container grouped field details - Security Center

Queries the details of container properties.

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:DescribeContainerGroupedFieldDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Criteria	string	Yes	The conditions for searching assets. This parameter is in JSON format. Separate multiple conditions with commas (,). Example: `[{"name":"riskStatus","value":"YES"},{"name":"riskLevel","value":"2"}]`. Note You can search for assets by conditions such as instance ID, instance name, VPC ID, region, and public IP address. Call DescribeCriteria to query the supported search conditions.	[{\"name\":\"clusterId\",\"value\":\"cfd26658431084c73a48dd97328ba8acf\"}]
GroupField	string	Yes	The search item. Valid values: pod: pod. appName: application name. clusterId: cluster ID. namespace: namespace. image: image. containerScan: container scan.	pod

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7532B7EE-7CE7-5F4D-BF04-B12447DD****
Data	object	The returned data.
Pod	string	The POD name.	node-local-dns-zwsxl
CreateTime	integer	The creation time. The value is a UNIX timestamp in milliseconds.	1702433618301
ContainerCount	integer	The number of containers.	1
Namespace	string	The namespace.	default
ClusterState	string	The cluster status. Valid values: STARTING: Starting. START_FAILED: Failed to start. BOOTSTRAPPING: Initializing bootstrap actions. RUNNING: Running. TERMINATING: Terminating. TERMINATED: Terminated. TERMINATED_WITH_ERRORS: Terminated due to an exception. TERMINATE_FAILED: Failed to terminate.	RUNNING
RegionId	string	The region ID.	cn-shanghai
AppName	string	The application name.	node-local-dns
InstanceCount	integer	The number of instances.	1
ClusterType	string	The cluster type. Valid values: Kubernetes: dedicated Kubernetes cluster. ManagedKubernetes: standard managed cluster (edge cluster). Ask: standard serverless cluster.	ManagedKubernetes
NodeName	string	The node name.	shangliang-test
PodCount	integer	The number of PODs.	1
ClusterName	string	The cluster name.	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 cluster ID.	c8ca91e0907d94efaba7fb0827eb9****

Examples

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.