Obtain filter conditions for containers using DescribeContainerCriteria - Security Center - Alibaba Cloud - Security Center

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupField	string	No	The search field. 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 search field. Fuzzy match is supported for application names, node names, namespaces, cluster names, public IP addresses, pod addresses, regions, pods, instance IDs, cluster IDs, and container IDs.	cfb41a869c71e4678a97021582dd8a****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
CriteriaList	array<object>	The list of supported search criteria.
	object	The supported search criteria.
Type	string	The type of the query condition. Valid values: input: You must manually enter the query field. select: You must select a subtype of the query condition from a drop-down list.	input
Name	string	The name of the query condition. instanceId: container instance ID. clusterId: cluster ID. regionId: container region. clusterName: cluster name. image: image name. imageRepoName: image repository name. imageRepoNamespace: image repository namespace. imageRepoTag: image repository tag. imageDigest: image digest. clusterType: cluster type. hostIp: public IP address. pod: pod. podIp: pod IP address. containerId: container ID. vulStatus: whether the container has vulnerabilities. alarmStatus: whether the container has security alerts. riskStatus: whether the container has risks. riskLevel: container risk level. containerScope: container type.	clusterId
Values	string	The available options when Type (the type of the query condition) is select. Note When Type (the type of the query condition) is input, this parameter returns an empty value.	ManagedKubernetes,NotManagedKubernetes,PrivateKubernetes

Examples

Success response

JSON format

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