首页 云安全中心 API参考指南 API目录 资产管理 DescribeGroupedInstances - 查询资产的统计信息

DescribeGroupedInstances - 查询资产的统计信息

按照指定的聚合维度去查询资产的统计信息。

调试

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

调试

授权信息

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

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

请求参数

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

设置请求和接收消息的语言类型,默认值为zh。取值:

  • zh:中文
  • en:英文
zh
MachineTypesstring

要查询的资产的类型。固定取值:ecs,表示云服务器。

ecs
GroupFieldstring

查询资产的过滤条件。取值:

  • groupId:表示按照资产的分组查询。
  • regionId:表示按照资产所在的地域查询。
  • vpcInstanceId:表示按照资产所属的专有网络VPC查询。
groupId
FieldValuestring

要查询的资产分组的名称,支持模糊搜索。

test-01
NoPageboolean

设置是否启用分页查询。默认值为true。取值:

  • true:启用分页查询。
  • false:不启用分页查询。
true
PageSizeinteger

设置分页查询时,每页显示的资产信息的数量。 默认值为20,表示每页显示20条资产信息。

20
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为1,表示从第1页开始显示。

1
Vendorinteger

服务器厂商。取值:

  • 0:阿里云资产
  • 1:云外资产
  • 2:IDC资产
  • 3457:其它云资产
  • 8:轻量级资产
0
Vendorsstring

服务器厂商。多个厂商使用半角逗号(,)分隔。取值:

  • 0:阿里云资产
  • 1:云外资产
  • 2:IDC资产
  • 3457:其它云资产
  • 8:轻量级资产
0,8

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

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

52A3AEE6-114A-499D-8990-4BA9B27FE0AA
PageInfoobject

查询结果的分页信息。

CurrentPageinteger

分页查询时,当前页的页码。

5
PageSizeinteger

分页查询时,每页显示的资产信息的数量。 默认值为20,表示每页显示20条资产信息。

20
TotalCountinteger

查询到的资产信息的总数量。

100
Countinteger

分页查询时,当前页面显示的资产的数量。

20
Instancesarray

查询到的资产信息的列表。

object

查询到的资产信息。

AsapVulInstanceCountlong

存在高危漏洞的资产的数量。

11
UnProtectedInstanceCountstring

未受到云安全中心防护的资产的数量。

32
FieldAliasNamestring

服务器分组的名称。

testA
InstanceCountstring

查询时指定的资产类型下所有资产的数量。

说明如果未设置请求参数MachineTypes,则该参数返回值为您所有类型的资产的总数量。
205
RiskInstanceCountstring

存在安全风险的资产数量。

172
GroupFlaginteger

服务器分组类型。取值:

  • 0:默认分组
  • 1:其他分组
1

示例

正常返回示例

JSON格式

{
  "RequestId": "52A3AEE6-114A-499D-8990-4BA9B27FE0AA",
  "PageInfo": {
    "CurrentPage": 5,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "Instances": [
    {
      "AsapVulInstanceCount": 11,
      "UnProtectedInstanceCount": "32",
      "FieldAliasName": "testA",
      "InstanceCount": "205",
      "RiskInstanceCount": "172",
      "GroupFlag": 1
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 云安全中心(态势感知) 相关技术圈