如何使用阿里雲CLI的分頁結果彙總功能 - Alibaba Cloud 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****"
                    ]
                }
            }
        ]
    }
}