阿里雲CLI支援匯出命令中繼資料與OpenAPI中繼資料,本文為您介紹匯出中繼資料的操作步驟。
注意事項
雲產品的OpenAPI中繼資料是指與API相關的所有描述性資訊的集合,詳情請參見OpenAPI中繼資料。
中繼資料匯出功能僅用於調試或開發用途,建議在匯出完成後關閉該功能。
中繼資料檔案預設儲存在Shell的工作目錄下,如需更改儲存路徑,請切換工作目錄至目標路徑。
如果未看到
cli-metadata目錄產生,請確認是否成功執行了阿里雲CLI命令,並檢查目前使用者對Shell工作目錄是否有寫入許可權。中繼資料會隨阿里雲CLI版本更新產生變更,建議您升級阿里雲CLI至最新版本後執行匯出操作。
操作步驟
步驟一:啟用匯出功能
在Shell環境中設定臨時環境變數GENERATE_METADATA,環境變數值為YES。通過設定此環境變數以啟用中繼資料匯出功能。
不同作業系統設定方式:
Linux/macOS
export GENERATE_METADATA=YESWindows PowerShell
$env:GENERATE_METADATA = "YES"Windows CMD
set GENERATE_METADATA=YES
步驟二:匯出中繼資料
設定環境變數後執行任意阿里雲CLI命令,命令執行後阿里雲CLI將開始匯出中繼資料。例如:
aliyun所有產生的中繼資料檔案都將儲存在當前工作目錄下的cli-metadata目錄中,例如
在
C:\Users\User目錄下運行命令,則中繼資料儲存位置為C:\Users\User\cli-metadata在
/home/user/目錄下運行命令,則中繼資料儲存位置為/home/user/cli-metadata
產生中繼資料檔案包含主要子目錄和檔案,分別用於儲存不同類型的中繼資料資訊:
cli-metadata/
├── metadatas/ # 阿里雲CLI支援OpenAPI中繼資料匯總目錄
│ ├── products.json # 產品列表及基本資料,包含產品名、存取點、預設整合API版本、API風格及產品API列表等資訊
│ └── <product-name>/ # 每個產品對應一個子目錄(如vpc、ecs等)
│ └── <api-name>.json # 每個API介面的詳細定義檔案
│
├── en-US/ # 阿里雲CLI支援產品與介面中繼資料(英文版,部分產品無英文描述不在此目錄中)
│ ├── products.json # 產品列表及基本資料
│ └── <product-name>/ # 每個產品對應一個子目錄(如vpc、ecs等)
│ ├── <api-name>.json # 每個API介面的詳細定義檔案
│ └── version.json # 該產品支援的OpenAPI版本及版本包含介面列表
│
├── zh-CN/ # 阿里雲CLI支援產品與介面中繼資料(中文版,結構同en-US,部分產品無中文描述不在此目錄中)
│ ├── products.json
│ └── <product-name>/
│ ├── <api-name>.json
│ └── version.json
│
├── commands.json # 阿里雲CLI命令結構定義檔案,包含所有命令、子命令、選項及其參數說明
└── version # 當前使用的阿里雲CLI版本號碼(純文字檔案)步驟三:關閉中繼資料匯出功能
中繼資料匯出完成後,請關閉該功能以避免執行後續命令時仍然產生中繼資料檔案。
方法一:重啟Shell會話
關閉當前終端視窗並重新開啟一個新的Shell會話,即可自動清除環境變數。
方法二:手動清除臨時環境變數
Linux/macOS
unset GENERATE_METADATAWindows PowerShell
$env:GENERATE_METADATA = ""Windows CMD
set GENERATE_METADATA=