AI 助理
文档备案控制台
官方文档
首页 云安全中心 开发参考 API参考指南 API目录 资产管理 DescribeCriteria - 查询资产时的查询条件

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

更新时间：
复制 MD 格式
产品详情
我的收藏

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeCriteria

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
MachineTypes

string

否

查询的资产类型。取值：

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

ecs
Value

string

否

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

47.96
SupportAutoTag

boolean

否

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

  • true：是。

  • false：否。

true
ResourceDirectoryAccountId

integer

否

资源目录成员账号主账号 ID。

说明

调用 DescribeMonitorAccounts 接口可以获取该参数。

127608589417****

返回参数

名称

类型

描述

示例值

object

请求返回数据。

RequestId

string

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

8E6DDACF-99AF-5939-AFFD-FCCD3B01E724
CriteriaList

array<object>

资产查询条件的信息列表。

object

资产查询条件的信息。

Type

string

查询条件的类型。取值：

  • input：需要手动输入查询字段。

  • select：需要从下拉列表中选择查询条件的子类型。

input
Name

string

对应的查询条件的名称。

  • internetIp：公网 IP。

  • intranetIp：私网 IP。

  • instanceName：实例名称。

  • instanceId：实例 ID。

  • machineType：实例类型。

  • clusterIdList：集群 ID 列表。

  • vpcInstanceId：所属 VPC ID。

  • osName：操作系统。

  • osType：系统类型。

  • hcStatus：是否有基线问题。

  • vulStatus：是否有漏洞问题。

  • asapVulStatus：是否存在紧急漏洞。

  • alarmStatus：是否有安全告警。

  • riskStatus：是否存在风险。

  • clientStatus：是否在线。

  • clientSubStatus：客户端子状态。

  • runningStatus：开机状态。

  • tagName：标签名称。

  • vendorAuthAlias：授权账号备注。

  • vendorUid：授权账号 ID。

  • vendorUserName：授权账号名称。

  • namespace：命名空间。

  • appName：应用名称。

  • groupName：分组名称。

  • regionId：地域。

  • groupId：分组 ID。

  • newInstance：是否新增资产。

  • containerStatus：是否存在容器。

  • importance：资产重要性。

  • exposedStatus：是否是暴露服务器。

  • clusterId：集群 ID。

  • authVersion：授权版本。

  • flag：云厂商。

  • ipList：IP 列表。

  • uuidList：UUID。

  • aiStatus：是否存在 AI 组件。

  • tagKeyValue：ECS 标签。

  • ecsType：服务器类型。

  • alisecguardStatus：自保护状态。

  • alihipsStatus：AliHips 状态。

  • alinetStatus：AliNet 状态。

  • alidetectStatus：端引擎状态。

  • yundunMonitorStatus：信息采集组件状态。

  • clusterNodeStatus：是否集群节点。

internetIp
Values

string

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

说明

  • 当 Name 返回为 machineType 时，枚举值为：

说明

  • 38：弹性容器实例。

  • 51：RunD 容器实例。

  • 52：RunC 容器实例。

  • 当 Name 返回为 osType 时，枚举值为：

说明

  • linux：Linux。

  • windows：Windows。

  • 当 Name 返回为 hcStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 vulStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 asapVulStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 alarmStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 riskStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • UNKNOWN：未知。

  • 当 Name 返回为 clientStatus 时，枚举值为：

说明

  • online：在线。

  • offline：离线。

  • pause：暂停防护。

  • 当 Name 返回为 clientSubStatus 时，枚举值为：

说明

  • online：在线。

  • offline：离线。

  • pause：暂停防护。

  • stopped：关机。

  • uninstalled：未安装。

  • 当 Name 返回为 runningStatus 时，枚举值为：

说明

  • Running：开机。

  • notRunning：关机。

  • UNKNOWN：未知。

  • 当 Name 返回为 importance 时，枚举值为：

说明

  • important：重要。

  • general：一般。

  • test：测试。

  • 当 Name 返回为 containerStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 exposedStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 authVersion 时，枚举值为：

说明

  • 1：免费版。

  • 3：企业版。

  • 5：高级版。

  • 6：防病毒版。

  • 7：旗舰版。

  • 当 Name 返回为 flag 时，枚举值为：

说明

  • 0|8|15：阿里云。

  • 1：云外主机。

  • 2：IDC。

  • 3：腾讯云。

  • 4：华为云。

  • 5：Azure。

  • 7：AWS。

  • 9：SAE。

  • 10：PAI。

  • 13：ACS。

  • 14：火山云。

  • 16：谷歌云。

  • 当 Name 返回为 aiStatus 时，枚举值为：

说明

  • NO：否。

  • YES：是。

  • 当 Name 返回为 ecsType 时，枚举值为：

说明

  • 8：轻量应用服务器。

  • 11：灵俊。

  • 15：RDS Custom。

  • !8：主机服务器。

  • 当 Name 返回为 alisecguardStatus 时，枚举值为：

说明

  • 0：插件在线。

  • 1：未开启。

  • 2：插件离线。

  • -99：安装失败。

  • 当 Name 返回为 alihipsStatus 时，枚举值为：

说明

  • 0：插件在线。

  • 1：未开启。

  • 2：插件离线。

  • -99：安装失败。

  • 当 Name 返回为 alinetStatus 时，枚举值为：

说明

  • 0：插件在线。

  • 1：未开启。

  • 2：插件离线。

  • -99：安装失败。

  • 当 Name 返回为 alidetectStatus 时，枚举值为：

说明

  • 0：插件在线。

  • 1：未开启。

  • 2：插件离线。

  • -99：安装失败。

  • 当 Name 返回为 yundunMonitorStatus 时，枚举值为：

说明

  • 0：插件在线。

  • 1：未开启。

  • 2：插件离线。

  • -99：安装失败。

  • 当 Name 返回为 clusterNodeStatus 时，枚举值为：

说明

  • false：否。

  • true：是。

47.96.XX.XX
MultiValues

string

输入的模糊匹配值对应的资产的具体结构化属性值。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

错误码

错误信息

描述
400 NoPermission no permission 无此服务的访问权限。
400 RdCheckNoPermission Resource directory account verification has no permission. 资源目录账号校验无权限。
500 ServerError ServerError 服务故障，请稍后重试！
500 RdCheckInnerError Resource directory account service internal error. 资源目录账号服务内部错误。
403 NoPermission caller has no permission 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeSearchCondition - 查询资产的筛选条件下一篇：DescribeVpcList - 查询VPC列表