分頁類接口結(jié)果聚合
使用阿里云CLI調(diào)用各云產(chǎn)品的分頁類接口時,默認(rèn)情況下僅返回第一頁的結(jié)果。當(dāng)需要獲取所有的結(jié)果時,您可以使用阿里云CLI的聚合結(jié)果功能。
--pager選項字段說明
您可以通過使用--pager
選項,對分頁類接口的數(shù)組類結(jié)果進(jìn)行聚合。該選項包含以下四個字段:
字段名 | 描述 |
PageNumber | 字段值對應(yīng)API返回結(jié)果中描述列表當(dāng)前頁碼的字段,默認(rèn)值: |
PageSize | 字段值對應(yīng)API返回結(jié)果中描述每頁返回的最大結(jié)果數(shù)量的字段,默認(rèn)值: |
TotalCount | 字段值對應(yīng)API返回結(jié)果中描述列表總行數(shù)的字段,默認(rèn)值: |
path | 由于API返回結(jié)果的多樣性,您可以手動指定需要聚合的數(shù)組類型所在的JMESPath路徑。 說明
|
示例場景
ECS產(chǎn)品的
DescribeInstances
接口是分頁類接口。執(zhí)行如下命令,默認(rèn)情況下,該接口僅返回實例信息列表第一頁的結(jié)果。aliyun ecs DescribeInstances
系統(tǒng)顯示類似如下輸出(部分截取)。
{ "PageNumber": 1, "TotalCount": 4, "PageSize": 10, "RequestId": "6EA82E70-9750-4A97-A738-E021D8A57F07", "Instances": { "Instance": [ { "ImageId": "win2012r2_64_dtc_9600_zh-cn_40G_alibase_20190318.vhd", "SerialNumber": "f06857e8-7f3c-443a-9f88-8e84eb5163c7", "Cpu": 1, "Memory": 2048, "DeviceAvailable": true, "SecurityGroupIds": { "SecurityGroupId": [ "sg-bp1fgviwol82z8ap348n" ] } } ] } }
示例命令
執(zhí)行如下命令,將會返回全部分頁中的實例信息列表。
aliyun ecs DescribeInstances --pager PageNumber=PageNumber PageSize=PageSize TotalCount=TotalCount path=Instances.Instance
由于該接口返回的值都與子字段的默認(rèn)值一致,使用
--pager
命令時可省略所有子字段。簡化格式如下:aliyun ecs DescribeInstances --pager
系統(tǒng)顯示如下聚合結(jié)果(部分截取)。
說明聚合之后的輸出,只包含有聚合的字段。若您使用過濾功能獲取您需要了解的字段,此時過濾字段的路徑為聚合之后的JMESPath路徑。更多信息,請參見過濾且表格化輸出結(jié)果。
{ "Instances": { "Instance": [ { "ImageId": "win2012r2_64_dtc_9600_zh-cn_40G_alibase_20190318.vhd", "SerialNumber": "f06857e8-7f3c-443a-9f88-8e84eb5163c7", "Cpu": 1, "Memory": 2048, "DeviceAvailable": true, "SecurityGroupIds": { "SecurityGroupId": [ "sg-bp1fgviwol82z8ap348n" ] } } ] } }