DescribeCriteria - Security Center

Queries the filter conditions that are used to search for assets in fuzzy match mode.

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:DescribeCriteria	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
MachineTypes	string	No	The type of the asset. Valid values: Set the value to ecs, which specifies to query all Elastic Compute Service (ECS) instances.	ecs
Value	string	No	The keyword that you specify for fuzzy search when you query the asset.	47.96
SupportAutoTag	boolean	No	Specifies whether the keyword that you specify for fuzzy search can be automatically matched. Default value: false. Valid values: true false	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	8E6DDACF-99AF-5939-AFFD-FCCD3B01E724
CriteriaList	array<object>	The information about the search conditions of assets.
Criteria	object
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: internetIp: the public IP address. intranetIp: the private IP address. instanceName: the name of the instance. instanceId: the instance ID. vpcInstanceId: the ID of the virtual private cloud (VPC) to which the instance belongs. osName: the operating system. osType: the operating system type. hcStatus: indicates whether baseline risks exist. vulStatus: indicates whether vulnerabilities exist. alarmStatus: indicates whether security alerts exist. riskStatus: indicates whether risks exist. clientStatus: indicates the status of the client. runningStatus: the running status of the asset. tagName: the name of the tag. groupName: the name of the server group. regionId: the region ID. importance: the importance of the asset. exposedStatus: indicates whether the server is exposed. authVersion: the authorization version. flag: the cloud service provider. ipList: the IP addresses. uuidList :the UUID. tagKeyValue: the ECS tag.	internetIp
Values	string	The attribute values of the assets that match the keyword.	47.96.XX.XX
MultiValues	string	The structured attribute values of the assets that match the keyword. The value of this parameter is in the JSON format and contains the following fields: vendor: providers. regionIds: IDs of supported regions	[{"vendor":0,"regionIds":{"default":["ap-southeast-1","ap-northeast-2","ap-southeast-3","ap-southeast-5","ap-southeast-7","me-central-1"]}},{"vendor":1,"regionIds":{"default":["outside-of-aliyun"]}}]

Examples

Sample success responses

JSONformat

{
  "RequestId": "8E6DDACF-99AF-5939-AFFD-FCCD3B01E724",
  "CriteriaList": [
    {
      "Type": "input",
      "Name": "internetIp",
      "Values": "47.96.XX.XX",
      "MultiValues": "[{\"vendor\":0,\"regionIds\":{\"default\":[\"ap-southeast-1\",\"ap-northeast-2\",\"ap-southeast-3\",\"ap-southeast-5\",\"ap-southeast-7\",\"me-central-1\"]}},{\"vendor\":1,\"regionIds\":{\"default\":[\"outside-of-aliyun\"]}}]"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	no permission	-
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
2022-12-23	API Description Update. The API operation is not deprecated.. The Error code has changed	View Change Details
2022-07-11	The Error code has changed. The response structure of the API has changed	View Change Details