调用DescribeGroupedInstances接口按照指定的聚合维度去查询资产的统计信息。

调试

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

请求参数

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

需要执行的操作。

取值:DescribeGroupedInstances

GroupField String groupId

指定要查询的过滤条件。取值:

  • groupId
  • regionId
  • vpcInstanceId
MachineTypes String ecs

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

Lang String zh

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

  • zh:中文
  • en:英文
NoPage Boolean true

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

  • true:启用分页查询。
  • false:不启用分页查询。
FieldValue String test

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

PageSize Integer 20

分页查询时,每页显示的数据最大条数。 每页默认显示的数据条数为20条。

当PageSize参数值为空时,将默认返回20条数据。

说明 建议PageSize取值不要为空。
CurrentPage Integer 1

分页查询时,查询到的当前结果页面的页码。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Instances Array of Instance

查询到的资产的列表。

AsapVulInstanceCount Long 11

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

FieldAliasName String testA

服务器组的名称。

GroupFlag Integer 1

服务器分组类型。取值:

  • 0:默认分组
  • 1:其他分组
InstanceCount String 205

查询时指定的资产类型下所有资产的数量。如果查询时没有指定资产类型,此处的数量是您资产中所有服务器的数量之和。

RiskInstanceCount String 172

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

UnProtectedInstanceCount String 32

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

PageInfo Struct

查询结果的分页信息。

Count Integer 20

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

CurrentPage Integer 5

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

PageSize Integer 20

分页查询时,每页最多显示的资产的条数。

TotalCount Integer 100

分页查询时,查询到的资产的总数量。

RequestId String 52A3AEE6-114A-499D-8990-4BA9B27FE0AA

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

示例

请求示例

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

正常返回示例

XML格式

<Instances>
    <FieldAliasName>testA</FieldAliasName>
    <InstanceCount>205</InstanceCount>
    <AsapVulInstanceCount>11</AsapVulInstanceCount>
    <UnProtectedInstanceCount>32</UnProtectedInstanceCount>
    <RiskInstanceCount>172</RiskInstanceCount>
    <GroupFlag>1</GroupFlag>
</Instances>
<PageInfo>
    <TotalCount>100</TotalCount>
    <PageSize>20</PageSize>
    <CurrentPage>5</CurrentPage>
    <Count>20</Count>
</PageInfo>
<RequestId>52A3AEE6-114A-499D-8990-4BA9B27FE0AA</RequestId>
</DescribeGroupedInstances>

JSON格式

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

错误码

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