DescribeSearchCondition - Security Center - Alibaba Cloud Documentation Center

Queries the filter conditions that are used to search for assets.

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:DescribeSearchCondition	get	All Resources ``	none	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 content within the request and response. 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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	3AEC47AF-8CFA-485E-AC9A-3A8ABC06EA7F
ConditionList	array<object>	An array that consists of the filter conditions.
Condition	object	The information about the filter condition.
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. The value of this parameter is in the JSON format and contains the following fields: filterParams: the parameters of the filter condition. The value of this field is in the JSON format and contains the following fields: labelKey: the key for rendering. label: the display name. value: the value of the filter condition. The value of this field is in the JSON format and contains the following fields: name: the name of the filter item. value: the value of the filter item. LogicalExp: the logical relationship among the filter conditions. Valid values: AND: The filter conditions are evaluated by using a logical AND. OR: The filter conditions are evaluated by using 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

Sample success responses

JSONformat

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

Change history

Change time	Summary of changes	Operation
2024-10-08	The Error code has changed	View Change Details
2022-12-23	API Description Update. The API operation is not deprecated.. The Error code has changed	View Change Details