调用DescribeCriteria获取查询资产时能显示的资产属性模糊匹配的查询条件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCriteria

要执行的操作。

取值:DescribeCriteria

MachineTypes String ecs

查询的资产类型。取值:

  • ecs :表示查询所有ECS服务器。
  • cloud_product :表示查询所有其他云产品。
Value String id

指定获取模糊匹配筛选的值。

返回数据

名称 类型 示例值 描述
CriteriaList Array

资产查询的属性条件列表。

Name String clientStatus

该查询条件所对应的资产属性名称。

Type String select

查询条件的类型。取值:

  • input:输入项。需要手动输入。
  • select:选择项。需要从下拉列表中选择。
Values String online,offline,pause

查询条件类型为选择项的情况下,选择项的值。

说明 查询条件为输入项的情况下,该参数返回值为空。
RequestId String 3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2

阿里云为该请求生成的唯一标识符。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCriteria
&<公共请求参数>

正常返回示例

XML 格式

<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>instanceName</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 格式

{
	"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"
}

错误码

访问错误中心查看更多错误码。