Alibaba Cloud CLI は、コマンドメタデータと API メタデータのエクスポートをサポートしています。このトピックでは、メタデータをエクスポートする手順について説明します。
注意事項
クラウドサービスの API メタデータは、その API に関連するすべての説明情報のコレクションです。詳細については、「API メタデータ」をご参照ください。
メタデータのエクスポート機能は、デバッグまたは開発目的でのみ使用します。エクスポートが完了したら、この機能を無効にすることをお勧めします。
デフォルトでは、メタデータファイルはシェルスクリプトの作業ディレクトリに保存されます。保存パスを変更するには、作業ディレクトリをターゲットパスに切り替えます。
cli-metadataディレクトリが作成されない場合は、Alibaba Cloud CLI コマンドが正常に実行されたことを確認し、現在のユーザーがシェルスクリプトの作業ディレクトリに対する書き込み権限を持っているかどうかを確認してください。メタデータは Alibaba Cloud CLI の更新に伴って変更されます。メタデータをエクスポートする前に、Alibaba Cloud CLI を最新バージョンにアップグレードすることをお勧めします。
手順
ステップ 1: エクスポート機能を有効にする
シェル実行環境で一時的な環境変数 GENERATE_METADATA を YES に設定して、メタデータのエクスポート機能を有効にします。
変数を設定する方法は、オペレーティングシステムによって異なります。
Linux/macOS
export GENERATE_METADATA=YESWindows PowerShell
$env:GENERATE_METADATA = "YES"Windows CMD
set GENERATE_METADATA=YES
ステップ 2: メタデータをエクスポートする
環境変数を設定した後、任意の Alibaba Cloud CLI コマンドを実行します。コマンドが実行されると、Alibaba Cloud CLI はメタデータのエクスポートを開始します。例:
aliyun生成されたすべてのメタデータファイルは、現在の作業ディレクトリ内の cli-metadata ディレクトリに保存されます。例:
コマンドを
C:\Users\Userディレクトリで実行すると、メタデータはC:\Users\User\cli-metadataに保存されます。コマンドを
/home/user/ディレクトリで実行すると、メタデータは/home/user/cli-metadataに保存されます。
生成されたメタデータファイルには、さまざまな種類のメタデータ情報を格納する次の主要なサブディレクトリとファイルが含まれています。
cli-metadata/
├── metadatas/ # Alibaba Cloud CLI がサポートするクラウドサービスのすべての API メタデータのディレクトリ。
│ ├── products.json # サービス名、エンドポイント、デフォルトで統合された API バージョン、API スタイル、サービス API リストなど、クラウドサービスのリストと基本情報。
│ └ ── <product-name>/ # VPC や ECS など、各サービスのサブディレクトリ。
│ └ ── <api-name>.json # 各 API 操作の詳細な定義ファイル。
│
├── en-US/ # Alibaba Cloud CLI がサポートするクラウドサービスのすべての API メタデータのディレクトリ (英語版)。英語の説明がないサービスはこのディレクトリにはありません。
│ ├── products.json # クラウドサービスのリストと基本情報。
│ └ ── <product-name>/ # VPC や ECS など、各サービスのサブディレクトリ。
│ ├── <api-name>.json # 各 API 操作の詳細な定義ファイル。
│ └ ── version.json # クラウドサービスがサポートする API バージョンと、各バージョンに含まれる API 操作のリスト。
│
├── zh-CN/ # Alibaba Cloud CLI がサポートするクラウドサービスのすべての API メタデータのディレクトリ (中国語版)。中国語の説明がないサービスはこのディレクトリにはありません。
│ ├── products.json
│ └── <product-name>/
│ ├── <api-name>.json
│ └── version.json
│
├── commands.json # すべてのコマンド、サブコマンド、オプション、およびそれらのパラメーターの説明を含む、Alibaba Cloud CLI コマンド構造の定義ファイル。
└ ── version # 現在使用されている Alibaba Cloud CLI のバージョン番号 (プレーンテキストファイル)。ステップ 3: メタデータのエクスポート機能を無効にする
メタデータのエクスポートが完了したら、この機能を無効にして、後続のコマンドを実行したときにメタデータファイルが生成されないようにします。
方法 1: シェルセッションを再起動する
現在のターミナルウィンドウを閉じて新しいシェルセッションを開くと、環境変数が自動的にクリアされます。
方法 2: 一時的な環境変数を手動でクリアする
Linux/macOS
unset GENERATE_METADATAWindows PowerShell
$env:GENERATE_METADATA = ""Windows CMD
set GENERATE_METADATA=