Queries the search conditions when you query an asset. You can specify a keyword for fuzzy search.

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: Elastic Compute Service (ECS) instances
  • cloud_product: cloud services except ECS
Value String No 47.96

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

SupportAutoTag Boolean No true

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

  • true: yes
  • false: no

Response parameters

Parameter Type Example Description
RequestId String 8E6DDACF-99AF-5939-AFFD-FCCD3B01E724

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

CriteriaList Array of Criteria

The information about the search conditions.

Type String input

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.
Name String internetIp

The name of the search condition.

Values String 47.96.XX.XX

The attribute values of the assets that match the keyword.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCriteria
&MachineTypes=ecs
&Value=47.96
&SupportAutoTag=true
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCriteriaResponse>
    <RequestId>8E6DDACF-99AF-5939-AFFD-FCCD3B01E724</RequestId>
    <CriteriaList>
        <Type>input</Type>
        <Name>internetIp</Name>
        <Values>47.96.XX.XX</Values>
    </CriteriaList>
</DescribeCriteriaResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "8E6DDACF-99AF-5939-AFFD-FCCD3B01E724",
  "CriteriaList" : [ {
    "Type" : "input",
    "Name" : "internetIp",
    "Values" : "47.96.XX.XX"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 NoPermission no permission The error message returned because you do not have access permissions on the service.
500 ServerError ServerError The error message returned because a server error occurred.

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