You can call this operation to query fuzzy match conditions that return the properties of a queried asset.
Debugging
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:
|
Value | String | No | id |
The value of the fuzzy match condition. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CriteriaList | Array |
The list of search conditions. |
|
Name | String | clientStatus |
The name of the property that corresponds to the search condition. |
Type | String | select |
The type of the search condition. Valid values:
|
Values | String | online,offline,pause |
If the search condition is an option, the value of the option is returned. Note If the search condition is an input, no value is returned.
|
RequestId | String | 3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeCriteria
&<Common request parameters>
Sample success responses
XML
format
<DescribeCriteriaResponse>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>internetIp</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>intranetIp</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>InstancePause</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>instanceId</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>vpcInstanceId</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>osName</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>NO,YES</Values>
<Name>vulStatus</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>NO,YES</Values>
<Name>alarmStatus</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>NO,YES,UNKNOWN</Values>
<Name>riskStatus</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>online,offline,pause</Values>
<Name>clientStatus</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>Running,notRunning</Values>
<Name>runningStatus</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>tagName</Name>
</CriteriaList>
<CriteriaList>
<Type>input</Type>
<Values></Values>
<Name>groupName</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>cn-hangzhou,cn-shanghai,cn-shenzhen,cn-beijing,cn-qingdao,cn-zhangjiakou,cn-huhehaote,ap-northeast-1,ap-southeast-1,ap-southeast-2,ap-southeast-3,ap-southeast-5,ap-south-1,cn-hongkong,us-east-1,us-west-1,me-east-1,eu-central-1,other,outside-of-aliyun</Values>
<Name>regionId</Name>
</CriteriaList>
<CriteriaList>
<Type>select</Type>
<Values>important,general,test</Values>
<Name>importance</Name>
</CriteriaList>
<RequestId>E4110E3B-B35D-4BF0-BF0B-68C824CA6268</RequestId>
</DescribeCriteriaResponse>
JSON
format
{
"CriteriaList": [
{
"Type": "input",
"Values": "",
"Name": "internetIp"
},
{
"Type": "input",
"Values": "",
"Name": "intranetIp"
},
{
"Type": "input",
"Values": "",
"Name": "instanceName"
},
{
"Type": "input",
"Values": "",
"Name": "instanceId"
},
{
"Type": "input",
"Values": "",
"Name": "vpcInstanceId"
},
{
"Type": "input",
"Values": "",
"Name": "osName"
},
{
"Type": "select",
"Values": "NO,YES",
"Name": "vulStatus"
},
{
"Type": "select",
"Values": "NO,YES",
"Name": "alarmStatus"
},
{
"Type": "select",
"Values": "NO,YES,UNKNOWN",
"Name": "riskStatus"
},
{
"Type": "select",
"Values": "online,offline,pause",
"Name": "clientStatus"
},
{
"Type": "select",
"Values": "Running,notRunning",
"Name": "runningStatus"
},
{
"Type": "input",
"Values": "",
"Name": "tagName"
},
{
"Type": "input",
"Values": "",
"Name": "groupName"
},
{
"Type": "select",
"Values": "cn-hangzhou,cn-shanghai,cn-shenzhen,cn-beijing,cn-qingdao,cn-zhangjiakou,cn-huhehaote,ap-northeast-1,ap-southeast-1,ap-southeast-2,ap-southeast-3,ap-southeast-5,ap-south-1,cn-hongkong,us-east-1,us-west-1,me-east-1,eu-central-1,other,outside-of-aliyun",
"Name": "regionId"
},
{
"Type": "select",
"Values": "important,general,test",
"Name": "importance"
}
],
"RequestId": "E4110E3B-B35D-4BF0-BF0B-68C824CA6268"
}
Error codes
For a list of error codes, visit the API Error Center.