全部產品
Search
文件中心

Alibaba Cloud CLI:API命令可用選項

更新時間:Aug 07, 2024

本文將為您列舉阿里雲CLI調用API時可用的命令列選項及其作用。在阿里雲CLI中,您可根據需要使用命令列選項,用來修改命令的預設行為或為命令提供額外功能。

選項格式

命令列選項options可用於API命令之後,通用格式如下:

aliyun <product> <ApiName> --option [optionParams]
  • 命令列選項與參數之間使用空格隔開。若選項包含子欄位subfield,則通常以subfield=value形式作為參數。有關參數類型及對應格式的詳細資料,請參見參數格式說明

  • 若選項後無需設定參數,文檔中將進行額外說明。

可用選項列表

選項

詳細資料

--profile,-p

使用--profile選項並指定有效配置名稱profileName後,阿里雲CLI將忽略預設身份憑證配置及環境變數設定,優先使用指定的配置調用命令。

樣本:使用指定憑證配置akProfile調用Elastic Compute Service產品APIDescribeInstances

aliyun ecs DescribeInstances --profile akProfile

--region

使用--region選項並指定有效地區後,阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊,優先使用指定的地區region調用命令。

樣本:以指定地區cn-beijing調用Elastic Compute Service產品APIDescribeInstances

aliyun ecs DescribeInstances --region cn-beijing

--endpoint

使用--endpoint選項可指定調用命令時使用的存取點地址。各雲產品支援的存取點地址可在產品對應文檔中心開發參考>API參考>服務存取點中查看。

樣本:以指定存取點metrics.cn-qingdao.aliyuncs.com調用CloudMonitorCMS產品APIDescribeMonitorGroups

aliyun cms DescribeMonitorGroups --endpoint metrics.cn-qingdao.aliyuncs.com

--version

使用--version選項可指定調用命令時訪問的API版本YYYY-MM-DD。使用時需結合--force選項,詳情請參閱強制調用介面

樣本:調用CloudMonitorCMS產品2017-03-01版本APIDescribeMetricList

aliyun cms QueryMetricList 
  --Project acs_ecs_dashboard 
  --Metric cpu_idle 
  --version 2017-03-01 
  --force

--header

使用--header選項為命令添加指定的要求標頭,可重複添加。

樣本:為命令添加要求標頭X-foo=bar

aliyun <product> <ApiName> --header X-foo=bar

--body

使用--body選項可在調用RESTful風格API命令時,為命令添加指定的請求主體。可使用JSON格式字串或以變數形式引用JSON格式檔案。

樣本:以Container Service for KubernetesAPIRunClusterCheck為例,為命令添加請求主體,主體使用JSON字串形式。

aliyun cs POST /clusters/{cluster_id}/checks 
  --body "{\"type\":\"NodePoolUpgrade\",\"target\":\"np1f6779297c4444a3a1cdd29be8e5****\"}"

--read-timeout

使用--read-timeout選項可指定命令的I/O逾時時間,單位為秒。使用此選項並設定有效參數後,阿里雲CLI調用命令時將忽略預設憑證配置中的I/O逾時時間。

樣本:指定命令I/O逾時時間為20秒。

aliyun <product> <ApiName> --read-timeout 20

--connect-timeout

使用--connect-timeout選項可指定命令的連線逾時時間,單位為秒。使用此選項並設定有效參數後,阿里雲CLI調用命令時將忽略預設憑證配置中的連線逾時時間。

樣本:指定命令連線逾時時間為20秒。

aliyun <product> <ApiName> --connect-timeout 20

--retry-count

使用--retry-count選項可指定命令的重試次數。使用此選項並設定有效參數後,阿里雲CLI調用命令時將忽略預設憑證配置中的重試次數。

樣本:指定命令重試次數為5次。

aliyun <product> <ApiName> --retry-count 5

--secure

使用--secure選項可強制使用HTTPS方式調用當前命令。

該選項後無需設定參數。

--quiet,-q

使用--quiet選項可關閉正常調用命令時的返回結果輸出。

該選項後無需設定參數。

--help

在需要擷取協助的命令層級處鍵入--help命令,即可擷取該命令的協助資訊。

該選項後無需設定參數。

更多詳情,請參見擷取協助資訊

--output,-o

使用--output選項提取結果中感興趣的欄位,且以表格形式展示返回結果輸出。

更多詳情,請參見過濾且表格化輸出結果

--pager

使用--pager選項,可在調用各雲產品的分頁類介面時,不分頁擷取所有的結果。

更多詳情,請參見分頁類介面結果彙總

--force

使用--force選項可強制調用中繼資料列表以外的API和參數。

該選項後無需設定參數。

更多詳情,請參見強制調用介面

--waiter

使用--waiter選項開啟結果輪詢,直到某個欄位出現特定值時停止輪詢,並返回資料。

更多詳情,請參見結果輪詢

--dryrun

使用--dryrun選項,可列印並檢查向伺服器發送的請求,不對雲資源進行任何實際操作。

該選項後無需設定參數。

更多詳情,請參見類比調用功能