You can call this operation to query fuzzy match conditions that return the properties of the queried asset.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCriteria

The operation that you want to perform.

Set the value to DescribeCriteria.
MachineTypes String No ecs

The type of the asset that you want to query. Valid values:

  • ecs: All ECS instances.
  • cloud_product: Alibaba Cloud services except ECS.
Value String No xxx

The value of the fuzzy match condition.

Response parameters

Parameter Type Example Description
RequestId String 3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2

The ID of the request.
CriteriaList Array

The list of search conditions of the queried asset.
Values String NO,YES,UNKNOWN

If the search conditions are options, values of options are returned.

If the search conditions are inputs specified by you, no value is returned.
Name String riskStatus

The names of all properties queried by the search conditions.
Type String input

The type of the search condition. Valid values:

  • input: inputs. You need to manually enter search conditions.
  • select: options. You can select options from the drop-down list.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeCriteria
&<Common request parameters>

Sample success responses

XML format 

<DescribeCriteriaResponse>
    <CriteriaList>
        <Type>input</Type>
        <Values/>
        <Name>internetIp</Name>
    </CriteriaList>
    <CriteriaList>
        <Type>select</Type>
        <Values>NO,YES</Values>
        <Name>vulStatus</Name>
    </CriteriaList>
    <requestId>3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2</requestId>
</DescribeCriteriaResponse>

JSON format 

{
    "CriteriaList": [
      {
        "Type": "input",
        "Values": "",
        "Name": "internetIp"
      },
      {
        "Type": "select",
        "Values": "NO,YES",
        "Name": "vulStatus"
      }
    ],
  "requestId": "3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2"
}

Error codes

For a list of error codes, visit the API Error Center.