DescribeSearchCondition Asset Filter Conditions Overview - Security Center - Alibaba Cloud - Security Center

Queries filter conditions for asset searches.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	117.220.XX.XX
Lang	string	No	The language of the request and response content. Default value: zh. Valid values: zh: Chinese. en: English.	zh
Type	string	No	The type of the asset. Valid values: ecs: Elastic Compute Service (ECS) instances. cloud_product: cloud services except ECS.	ecs

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, used to locate and troubleshoot issues.	3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F
ConditionList	array<object>	The filter conditions.
	object	The filter condition details.
ConditionType	string	The type of the filter condition. Valid values: system: default filter conditions. user: custom filter conditions.	system
NameKey	string	The key of the filter condition name.	stop_machine
Name	string	The filter condition name.	StopMachine
FilterConditions	string	The filter condition in JSON format, containing the following fields: filterParams: the filter condition parameters in JSON format, containing the following fields: labelKey: the key for rendering. label: the display name. value: the filter condition value in JSON format, containing the following fields: name: the name of the filter item. value: the value of the filter item. LogicalExp: the logical operator for combining filter conditions. Valid values: AND: combines filter conditions with a logical AND. OR: combines filter conditions with a logical OR. Note If the value of ConditionType is system, labelKey is returned. The labelKey field is used only for internationalization rendering.	{\"filterParams\":[{\"labelKey\":\"a\|b\",\"value\":\"{\\\"name\\\":\\\"sadsasd\\\",\\\"value\\\":\\\"dasdsdas\\\"}\"}],\"LogicalExp\":\"OR\"}

Examples

Success response

JSON format

{
  "RequestId": "3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F",
  "ConditionList": [
    {
      "ConditionType": "system",
      "NameKey": "stop_machine",
      "Name": "StopMachine",
      "FilterConditions": "{\\\"filterParams\\\":[{\\\"labelKey\\\":\\\"a|b\\\",\\\"value\\\":\\\"{\\\\\\\"name\\\\\\\":\\\\\\\"sadsasd\\\\\\\",\\\\\\\"value\\\\\\\":\\\\\\\"dasdsdas\\\\\\\"}\\\"}],\\\"LogicalExp\\\":\\\"OR\\\"}"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	no permission
400	InvalidSecurityTokenExpired	Specified SecurityToken is expired.	Specified SecurityToken is expired.
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.