文档

DescribeCriteria - 查询资产时的查询条件

更新时间:

查询资产时能显示的资产属性模糊匹配的查询条件。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeCriteriaRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
MachineTypesstring

查询的资产类型。取值:

  • ecs :表示查询所有 ECS 服务器。
ecs
Valuestring

查询资产时输入的模糊匹配值。

47.96
SupportAutoTagboolean

设置输入的模糊查询字段是否支持自动匹配。默认 false,取值:

  • true:是
  • false:否
true

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

8E6DDACF-99AF-5939-AFFD-FCCD3B01E724
CriteriaListobject []

资产查询条件的信息。

Typestring

查询条件的类型。取值:

  • input:需要手动输入查询字段。
  • select:需要从下拉列表中选择查询条件的子类型。
input
Namestring

对应的查询条件的名称。

  • internetIp:公网 IP。
  • intranetIp:私网 IP。
  • instanceName:实例名称。
  • instanceId:实例 ID。
  • vpcInstanceId:所属 VPC ID。
  • osName:操作系统。
  • osType:系统类型。
  • hcStatus:是否有基线问题。
  • vulStatus:是否有漏洞问题。
  • alarmStatus:是否有安全告警。
  • riskStatus:是否存在风险。
  • clientStatus:是否在线。
  • runningStatus:开机状态。
  • tagName:标签名称。
  • groupName:分组名称。
  • regionId:地域。
  • importance:资产重要性。
  • exposedStatus:是否是暴露服务器。
  • authVersion:授权版本。
  • flag:云厂商。
  • ipList:IP 列表。
  • uuidList:UUID。
  • tagKeyValue:ECS 标签。
internetIp
Valuesstring

输入的模糊匹配值对应的资产的具体属性值。

47.96.XX.XX
MultiValuesstring

输入的模糊匹配值对应的资产的具体结构化属性值。JSON 格式,包含以下字段:

  • vendor:供应商
  • regionIds:支持地域
[{"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"]}}]

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400NoPermissionno permission无此服务的访问权限。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2022-12-23OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-07-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)