DescribeContainerCriteria - Security Center - Alibaba Cloud Documentation Center

Obtains the filter conditions that you can use to filter the 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:DescribeContainerCriteria	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupField	string	No	The filter condition. Valid values: pod: pod appName: application name clusterId: cluster ID namespace: namespace image: image containerScan: container scan	clusterId
Value	string	No	The value of the filter condition. The value can be an application name, node name, namespace, cluster name, public IP address, pod address, region, pod, instance ID, cluster ID, or container ID. Fuzzy match is supported.	cfb41a869c71e4678a97021582dd8a****

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
CriteriaList	array<object>	An array that consists of information about the filter condition.
Criteria	object	The information about the filter condition.
Type	string	The type of the search condition. Valid values: input: The search condition needs to be specified. select: The search condition is an option that can be selected from the drop-down list.	input
Name	string	The name of the search condition. Valid values: instanceId: the ID of the container instance. clusterId: the cluster ID. regionId: the ID of the region in which the container resides. clusterName: the name of the cluster. image: the name of the image. imageRepoName: the name of the image repository. imageRepoNamespace: the namespace of the image repository. imageRepoTag: the tag of the image repository. imageDigest: the image digest. ClusterType: the type of the cluster. hostIp: the public IP address. pod: the pod. podIp: the IP address of the pod. containerId: the container ID. vulStatus: indicates whether vulnerabilities exist in the container. alarmStatus: indicates whether alerts are generated for the container. riskStatus: indicates whether risks exist in the container. riskLevel: the risk level of the container. containerScope: the type of the container.	clusterId
Values	string	The values of the search condition. This parameter is returned only if the value of Type is set to select. Note If the value of Type is set to input, the return value of this parameter is empty.	ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes

Examples

Sample success responses

JSONformat

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "CriteriaList": [
    {
      "Type": "input",
      "Name": "clusterId",
      "Values": "ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes"
    }
  ]
}

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.