如何使用阿里云CLI的分页结果聚合功能_阿里云CLI(CLI)-阿里云帮助中心

调用分页类接口时，默认情况下仅返回单页查询结果。使用--pager选项可聚合分页数据，实现全量数据的一次性获取。

字段说明

在阿里云CLI中，您可以使用--pager选项开启分页聚合功能，对分页类接口的数组类结果进行聚合。该选项包含以下字段：

说明

若接口返回字段与默认值不一致，可能导致解析异常。建议您根据实际返回数据结构，手动映射字段参数，以确保数据提取的准确性和稳定性。

字段	描述	默认值
PageNumber	列表当前页码。	`PageNumber`
PageSize	每页最大结果数量。	`PageSize`
TotalCount	列表总行数。	`TotalCount`
NextToken	查询凭证。	`NextToken`
path	目标数据的JMESPath路径。	自动识别数组类型数据路径。如调用ECS `DescribeInstances`接口时，`path`默认值为`Instances.Instance`。

示例场景

说明

部分接口支持通过maxResult参数设置单次查询的最大结果数量。若设置值过小，可能导致请求频率及数据处理耗时显著增加。建议您在使用--pager选项时合理设置maxResult参数以优化查询效率。

ECS产品的DescribeInstances接口是分页类接口。默认情况下，执行如下命令仅返回实例信息列表的第一页数据。
```
aliyun ecs DescribeInstances
```

系统显示如下结果（部分截取）。

{
    "PageNumber": 1,
    "TotalCount": 4,
    "PageSize": 10,
    "RequestId": "6EA82E70-9750-4A97-A738-E021D8A57F07",
    "Instances": {
        "Instance": [
            {    
                "InstanceId": "i-m5edv0cqkr9hawls****",
                "ImageId": "win2012r2_64_dtc_9600_zh-cn_40G_alibase_20190318.vhd",
                "SerialNumber": "f06857e8-7f3c-443a-9f88-8e84eb51****",
                "Cpu": 1,
                "Memory": 2048,
                "DeviceAvailable": true,
                "SecurityGroupIds": {
                    "SecurityGroupId": [
                        "sg-bp1fgviwol82z8ap****"
                    ]
                }
            }
        ]
    }
}

开启分页聚合功能后，可一次性获取所有分页中的实例信息。
```
aliyun ecs DescribeInstances --pager PageNumber=PageNumber PageSize=PageSize TotalCount=TotalCount path=Instances.Instance
```
若某个字段参数值与默认值一致，无需显式指定该字段。例如，上述命令可简化为：
```
aliyun ecs DescribeInstances --pager
```

命令执行后，系统显示如下聚合结果（部分截取）。

说明

聚合后仅输出聚合字段。若需通过过滤功能查看特定字段，请注意过滤路径应为聚合后的JMESPath路径。更多信息，请参见过滤且表格化输出结果。

{
    "Instances": {
        "Instance": [
            {    
                "InstanceId": "i-m5edv0cqkr9hawls****",
                "ImageId": "win2012r2_64_dtc_9600_zh-cn_40G_alibase_20190318.vhd",
                "SerialNumber": "f06857e8-7f3c-443a-9f88-8e84eb51****",
                "Cpu": 1,
                "Memory": 2048,
                "DeviceAvailable": true,
                "SecurityGroupIds": {
                    "SecurityGroupId": [
                        "sg-bp1fgviwol82z8ap****"
                    ]
                }
            }
        ]
    }
}