全部產品
Search

搜尋本產品

    Alibaba Cloud CLI：阿里雲CLI命令列選項

    文件中心

    Alibaba Cloud CLI：阿里雲CLI命令列選項

    更新時間：Dec 23, 2025

    本文將為您列舉阿里雲CLI調用OpenAPI時可用的命令列選項及其作用，協助您修改命令預設行為或開啟部分功能。

    選項格式

    命令列選項options可用於OpenAPI通用命令之後，格式如下：

    aliyun <Command> <SubCommand> --options [optionParams]

    • 選項與參數之間通常使用空格隔開。若選項包含子欄位subfield，則通常以subfield=value形式傳入。更多資訊，請參見參數格式。

    可用選項列表

    選項

    說明

    --profile,-p

    指定配置名稱後，阿里雲CLI將忽略預設身份憑證配置及環境變數設定，優先使用指定的配置調用命令。

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

    aliyun ecs DescribeInstances --profile akProfile

    --region

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

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

    aliyun ecs DescribeInstances --region cn-beijing

    --endpoint

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

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

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

    --endpoint-type

    使用 `--endpoint-type` 指定endpoint類型，支援vpc或空值（預設公網訪問）。

    樣本：使用VPC存取點調用ECS雲端服務器APIDescribeInstances。

    • 命令列臨時指定

      aliyun ecs DescribeInstances --endpoint-type vpc

    • 持久化配置

      aliyun configure set --endpoint-type vpc
aliyun ecs DescribeInstances

    --version

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

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

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

    --header

    為命令添加指定的要求標頭，可重複添加。

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

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

    --body

    在調用ROA風格API命令時，傳入字串格式參數作為請求主體。

    樣本：以Container Service for Kubernetes的RunClusterCheck介面為例，為命令添加請求主體，主體使用JSON字串形式。

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

    --body-file

    在調用ROA風格API命令時，傳入指定檔案作為請求主體。該選項優先順序高於--body選項。

    樣本：以Container Service for Kubernetes的RunClusterCheck介面為例，為命令添加請求主體。

    aliyun cs POST /clusters/{cluster_id}/checks --body-file /usr/local/bin/example.json

    JSON檔案樣本

    {
    "type": "NodePoolUpgrade",
    "target": "np1f6779297c4444a3a1cdd29be8e5****"
}

    --read-timeout

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

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

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

    --connect-timeout

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

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

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

    --retry-count

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

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

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

    --secure

    使用後可強制使用HTTPS協議調用OpenAPI。若目標介面不支援HTTPS協議，啟用該選項將導致請求失敗。

    說明

    預設情況下，阿里雲CLI使用HTTPS協議調用OpenAPI。

    --insecure

    使用後可強制使用HTTP協議調用OpenAPI。若目標介面不支援HTTP協議，啟用該選項將導致請求失敗。

    --quiet,-q

    關閉正常調用命令時的返回結果輸出。

    --help

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

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

    --output,-o

    提取OpenAPI返回結果中的欄位，且以表格形式展示返回結果輸出。

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

    --pager

    在調用各雲產品的分頁類介面時，不分頁擷取所有的結果。

    更多詳情，請參見彙總分頁資料。

    --force

    強制調用中繼資料列表以外的API和參數。

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

    --waiter

    使用此選項可開啟結果輪詢，直到某個欄位出現特定值時停止輪詢，並返迴響應資料。

    更多詳情，請參見結果輪詢。

    --dryrun

    使用此選項將完整列印向伺服器發起的請求資訊，用於調試和驗證，不會對任何雲上資源進行實際更改或操作。

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