All Products
Search

This Product

    Security Center:DescribeCriteria

    Document Center

    Security Center:DescribeCriteria

    Last Updated:Feb 12, 2026

    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.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-sas:DescribeCriteriaget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    MachineTypesstringNo

    The type of the asset. Valid values:

    • Set the value to ecs, which specifies to query all Elastic Compute Service (ECS) instances.
    		ecs
    ValuestringNo

    The keyword that you specify for fuzzy search when you query the asset.

    		47.96
    SupportAutoTagbooleanNo

    Specifies whether the keyword that you specify for fuzzy search can be automatically matched. Default value: false. Valid values:

    • true
    • false
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request, which is used to locate and troubleshoot issues.

    		8E6DDACF-99AF-5939-AFFD-FCCD3B01E724
    CriteriaListarray<object>

    List of asset query condition information.

    Criteriaobject

    Information on asset query conditions.

    Typestring

    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
    Namestring

    The name of the search condition. Valid values:

    • internetIp: Public IP Address.
    • intranetIp: Private IP Address.
    • instanceName: Instance Name.
    • instanceId: Instance ID.
    • machineType: Instance Type.
    • clusterIdList: Cluster ID list.
    • vpcInstanceId: VPC ID.
    • osName: OS.
    • osType: OS type.
    • hcStatus: Whether Baseline Risk Exists.
    • vulStatus: Whether Vulnerability Exists.
    • asapVulStatus: Whether there is an urgent vulnerability.
    • alarmStatus: Whether Alert Exists.
    • riskStatus: Whether there is a risk.
    • clientStatus: Whether it is online.
    • clientSubStatus: Client sub-status.
    • runningStatus: Power-on status.
    • tagName: Tag name.
    • vendorAuthAlias: Authorized account remarks.
    • vendorUid: Authorized account ID.
    • vendorUserName: Authorized account name.
    • namespace: Namespace.
    • appName: Application name.
    • groupName: Group name.
    • regionId: Region.
    • groupId: Group ID.
    • newInstance: Whether it is a new asset.
    • containerStatus: Whether there is a container.
    • importance: Asset importance.
    • exposedStatus: Whether it is an exposed server.
    • clusterId: Cluster ID.
    • authVersion: Authorization version.
    • flag: Cloud provider.
    • ipList: IP list.
    • uuidList: UUID.
    • aiStatus: Whether there is an AI component.
    • tagKeyValue: ECS tag.
    • ecsType: Server type.
    • alisecguardStatus: Self-protection status.
    • alihipsStatus: AliHips status.
    • alinetStatus: AliNet status.
    • alidetectStatus: Endpoint engine status.
    • yundunMonitorStatus: Information collection component status.
    • clusterNodeStatus: Whether it is a cluster node.
    		internetIp
    Valuesstring

    The attribute values of the assets that match the keyword.

    Note
  • When Name is machineType, the enum values are:
    •
    • 38: Elastic Container Instance.
    • 51: RunD Container Instance.
    • 52: RunC Container Instance.
  • When Name is osType, the enum values are:
    •
    • linux: Linux.
    • windows: Windows.
  • When Name is hcStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is vulStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is asapVulStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is alarmStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is riskStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
    • UNKNOWN: Unknown.
  • When Name is clientStatus, the enum values are:
    •
    • online: Online.
    • offline: Offline.
    • pause: Protection Suspended.
  • When Name is clientSubStatus, the enum values are:
    •
    • online: Online.
    • offline: Offline.
    • pause: Protection Suspended.
    • stopped: Server Shutdown.
    • uninstalled: Not Installed.
  • When Name is runningStatus, the enum values are:
    •
    • Running: On.
    • notRunning: Off.
    • UNKNOWN: Unknown.
  • When Name is importance, the enum values are:
    •
    • important: Important.
    • general: Normal.
    • test: Test.
  • When Name is containerStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is exposedStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is authVersion, the enum values are:
    •
    • 1: Basic.
    • 3: Enterprise.
    • 5: Advanced.
    • 6: Anti-virus.
    • 7: Ultimate.
  • When Name is flag, the enum values are:
    •
    • 0|8|15: Alibaba Cloud.
    • 1: External Host.
    • 2: IDC.
    • 3: Tencent Cloud.
    • 4: Huawei Cloud.
    • 5: Azure.
    • 7: AWS.
    • 9: SAE.
    • 10: PAI.
    • 13: ACS.
    • 14: Volcano Cloud.
    • 16: Google Cloud.
  • When Name is aiStatus, the enum values are:
    •
    • NO: No.
    • YES: Yes.
  • When Name is ecsType, the enum values are:
    •
    • 8: Simple Application Server.
    • 11: LINGJUN GPU-accelerated Bare Metal Instance.
    • 15: RDS Custom.
    • !8: Host.
  • When Name is alisecguardStatus, the enum values are:
    •
    • 0: Plug-in Online.
    • 1: Plug-in Disabled.
    • 2: Plug-in Offline.
    • -99: The installation failed.
  • When Name is alihipsStatus, the enum values are:
    •
    • 0: Plug-in Online.
    • 1: Plug-in Disabled.
    • 2: Plug-in Offline.
    • -99: The installation failed.
  • When Name is alinetStatus, the enum values are:
    •
    • 0: Plug-in Online.
    • 1: Plug-in Disabled.
    • 2: Plug-in Offline.
    • -99: The installation failed.
  • When Name is alidetectStatus, the enum values are:
    •
    • 0: Plug-in Online.
    • 1: Plug-in Disabled.
    • 2: Plug-in Offline.
    • -99: The installation failed.
  • When Name is yundunMonitorStatus, the enum values are:
    •
    • 0: Plug-in Online.
    • 1: Plug-in Disabled.
    • 2: Plug-in Offline.
    • -99: The installation failed.
  • When Name is clusterNodeStatus, the enum values are:
    •
    • false: No.
    • true: Yes.
    		47.96.XX.XX
    MultiValuesstring

    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 codeError codeError messageDescription
    400NoPermissionno permission-
    403NoPermissioncaller has no permissionYou are not authorized to do this operation.
    500ServerErrorServerError-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details
    2022-07-11The Error code has changed. The response structure of the API has changedView Change Details