All Products
Search
Document Center

Security Center:DescribeCriteria

Last Updated:Oct 21, 2026

Queries the fuzzy match criteria for asset properties displayed during asset queries.

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

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

MachineTypes

string

No

The Asset Type to query. Valid values:

  • ecs: Queries all ECS servers.

ecs

Value

string

No

The fuzzy match value entered when querying assets.

47.96

SupportAutoTag

boolean

No

Specifies whether the entered fuzzy query field supports automatic matching. Default value: false. Valid values:

  • true: Yes.

  • false: No.

true

ResourceDirectoryAccountId

integer

No

The ID of the Alibaba Cloud account for the member accounts in the resource folder.

Note

You can invoke the DescribeMonitorAccounts operation to obtain this parameter.

127608589417****

Response elements

Element

Type

Description

Example

object

The response data.

RequestId

string

The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.

8E6DDACF-99AF-5939-AFFD-FCCD3B01E724

CriteriaList

array<object>

The list of asset query criteria.

object

The information about the asset query criterion.

Type

string

The type of the query criterion. Valid values:

  • input: You must manually enter the query field.

  • select: You must select the subtype of the query criterion from a drop-down list.

input

Name

string

The name of the corresponding query criterion. Valid values:

  • internetIp: The public IP address.

  • intranetIp: The private IP address.

  • instanceName: The instance name.

  • instanceId: The instance ID.

  • machineType: The instance type.

  • clusterIdList: The list of cluster IDs.

  • vpcInstanceId: The ID of the VPC to which the instance belongs.

  • osName: The operating system.

  • osType: The system type.

  • hcStatus: Whether baseline risks exist.

  • vulStatus: Whether vulnerabilities exist.

  • asapVulStatus: Whether urgent vulnerabilities exist.

  • alarmStatus: Whether security alerts exist.

  • riskStatus: Whether risks exist.

  • clientStatus: Whether the client is online.

  • clientSubStatus: The client sub-status.

  • runningStatus: The running status.

  • tagName: The tag name.

  • vendorAuthAlias: The alias of the authorized account.

  • vendorUid: The ID of the authorized account.

  • vendorUserName: The name of the authorized account.

  • namespace: The namespace.

  • appName: The application name.

  • groupName: The group name.

  • regionId: The region.

  • groupId: The group ID.

  • newInstance: Whether the asset is newly added.

  • containerStatus: Whether containers exist.

  • importance: The asset importance.

  • exposedStatus: Whether the server is exposed.

  • clusterId: The cluster ID.

  • authVersion: The authorized edition.

  • flag: The cloud provider.

  • ipList: The list of IP addresses.

  • uuidList: The list of UUIDs.

  • aiStatus: Whether AI components exist.

  • tagKeyValue: The ECS tag.

  • ecsType: The server type.

  • alisecguardStatus: The self-protection status.

  • alihipsStatus: The AliHips status.

  • alinetStatus: The AliNet status.

  • alidetectStatus: The endpoint engine status.

  • yundunMonitorStatus: The information collection component status.

  • clusterNodeStatus: Whether the instance is a cluster node.

internetIp

Values

string

The specific property values of the asset that correspond to the entered fuzzy match value.

Note
  • If Name is machineType, valid values:

Note
  • 38: Elastic Container Instance.

  • 51: RunD container instance.

  • 52: RunC container instance.

  • If Name is osType, valid values:

Note
  • linux: Linux.

  • windows: Windows.

  • If Name is hcStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is vulStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is asapVulStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is alarmStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is riskStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • UNKNOWN: Unknown.

  • If Name is clientStatus, valid values:

Note
  • online: Online.

  • offline: Offline.

  • pause: Protection paused.

  • If Name is clientSubStatus, valid values:

Note
  • online: Online.

  • offline: Offline.

  • pause: Protection paused.

  • stopped: Stopped.

  • uninstalled: Uninstalled.

  • If Name is runningStatus, valid values:

Note
  • Running: Running.

  • notRunning: Stopped.

  • UNKNOWN: Unknown.

  • If Name is importance, valid values:

Note
  • important: Important.

  • general: General.

  • test: Test.

  • If Name is containerStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is exposedStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is authVersion, valid values:

Note
  • 1: Free Edition.

  • 3: Enterprise Edition.

  • 5: Advanced Edition.

  • 6: Anti-virus Edition.

  • 7: Ultimate Edition.

  • If Name is flag, valid values:

Note
  • 0|8|15: Alibaba Cloud.

  • 1: Non-cloud host.

  • 2: IDC.

  • 3: Tencent Cloud.

  • 4: Huawei Cloud.

  • 5: Azure.

  • 7: AWS.

  • 9: SAE.

  • 10: PAI.

  • 13: ACS.

  • 14: Volcengine.

  • 16: Google Cloud.

  • 17: CTyun.

  • 18: Baidu Cloud.

  • 19: UCloud.

  • 20: Kingsoft Cloud.

  • 21: Oracle Cloud.

  • If Name is aiStatus, valid values:

Note
  • NO: No.

  • YES: Yes.

  • If Name is ecsType, valid values:

Note
  • 8: Simple Application Server.

  • 11: Lingjun.

  • 15: RDS Custom.

  • !8: ECS instance.

  • If Name is alisecguardStatus, valid values:

Note
  • 0: Plugin online.

  • 1: Disabled.

  • 2: Plugin offline.

  • -99: Installation failed.

  • If Name is alihipsStatus, valid values:

Note
  • 0: Plugin online.

  • 1: Disabled.

  • 2: Plugin offline.

  • -99: Installation failed.

  • If Name is alinetStatus, valid values:

Note
  • 0: Plugin online.

  • 1: Disabled.

  • 2: Plugin offline.

  • -99: Installation failed.

  • If Name is alidetectStatus, valid values:

Note
  • 0: Plugin online.

  • 1: Disabled.

  • 2: Plugin offline.

  • -99: Installation failed.

  • If Name is yundunMonitorStatus, valid values:

Note
  • 0: Plugin online.

  • 1: Disabled.

  • 2: Plugin offline.

  • -99: Installation failed.

  • If Name is clusterNodeStatus, valid values:

Note
  • false: No.

  • true: Yes.

47.96.XX.XX

MultiValues

string

The specific structured property values of the asset that correspond to the entered fuzzy match value. The value is in JSON format and contains the following fields:

  • vendor: The provider.

  • regionIds: The 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

Success response

JSON format

{
  "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
400 RdCheckNoPermission Resource directory account verification has no permission.
500 ServerError ServerError
500 RdCheckInnerError Resource directory account service internal error.
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.