Alibaba Cloud CLIは、OpenAPIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、Alibaba Cloud CDNリソースの自動管理とメンテナンスを実装できます。 このトピックでは、Alibaba Cloud CLIを使用してAlibaba Cloud CDN APIを呼び出す方法について説明します。
始める前に
Alibaba Cloud CLIに慣れてください。 詳細については、「Alibaba Cloud CLI の概要」をご参照ください。
Alibaba Cloud CLI のインストール
Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIをインストールする必要があります。 Alibaba Cloud CLIは、Windows、Linux、およびmacOSオペレーティングシステムにインストールできます。 デバイスのオペレーティングシステムに基づいて、Alibaba Cloud CLIのインストールパッケージを選択する必要があります。 詳細については、以下のトピックをご参照ください。
Alibaba Cloudが提供するCloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。 Cloud Shellの詳細については、Cloud Shellとは
Alibaba Cloud CLI の設定
Alibaba Cloudアカウントには、すべてのAlibaba CloudサービスのAPIを管理およびアクセスする権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーを作成して使用し、API操作を呼び出したり、通常のO&M操作を実行したりすることを推奨します。
Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を設定する必要があります。 Alibaba Cloud CLIは、さまざまなID資格情報をサポートしています。 詳細については、「資格情報の種類」をご参照ください。 この例では、AccessKey資格情報が使用されます。
RAMユーザーを作成し、RAMユーザーに必要な権限を付与します。 詳細については、「RAMユーザーの作成」および「RAMユーザーへの権限付与」をご参照ください。
重要この例では、
AliyunCDNReadOnlyAccessポリシーをRAMユーザーにアタッチする必要があります。AliyunCDNFullAccessシステムポリシーを使用すると、ドメイン名の照会や管理など、Alibaba Cloud CDN高速化ドメイン名へのフルアクセスをユーザーに付与できます。 カスタムポリシーを作成することもできます。 詳細については、「Alibaba Cloud CDNカスタムポリシー」をご参照ください。RAMユーザーのAccessKeyペアを作成し、ID資格情報の設定用に
AccessKey IDとAccessKey secretを記録します。 詳細については、「AccessKeyペアの作成」をご参照ください。ID資格情報の設定に使用可能なリージョンのIDを取得して記録します。 Alibaba Cloud CLIは、指定されたリージョンIDを使用してAPI呼び出しを開始します。 使用可能なリージョンの詳細については、「リクエスト構造」をご参照ください。
説明Alibaba Cloud CLIを使用する場合、
-- regionオプションを使用して、特定のリージョンでコマンドを実行できます。 このオプションを使用すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視します。 詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。RAMユーザーのAccessKeyペアを使用して、
AkProfileという名前の設定ファイルでID資格情報を設定します。 詳細については、「エンドポイント」をご参照ください。
CLIコマンドの生成
ECI インスタンスの割引額を照会するには、 Alibaba Cloud CDN APIのデバッグページ。
表示されるページの左側の検索ボックスで、呼び出す操作を検索します。 [パラメーター] タブで、API操作のAPIドキュメントに基づいてパラメーター値を入力します。 次に、[パラメーター] タブの右側にある [CLIの例] タブをクリックして、設定されたパラメーターを含む例を生成します。
アイコンをクリックし
ます。 Cloud Shellに移動します。 Cloud Shellでコマンドをデバッグできます。 アイコンをクリックし
てCLIコマンドをクリップボードにコピーし、ローカルシェルに貼り付けます。 サンプルコマンドをデバッグのためにシェルに貼り付けるときは、パラメータの形式に注意してください。 Alibaba Cloud CLIのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。
デフォルトでは、OpenAPI Explorerは、生成されたCLIコマンドに
-- regionオプションを追加します。 コマンドをシェルにコピーすると、Alibaba Cloud CLIはデフォルトのID資格情報設定と環境変数設定のリージョン情報を無視し、指定されたリージョンで優先的にコマンドを実行します。 ビジネス要件に基づいてオプションを削除または保持できます。
API操作の呼び出し
構文
Alibaba Cloud CLIでは、次の構文を使用してコマンドを実行できます。 詳細は、「構文」をご参照ください。
aliyun <command> <subcommand> [options and parameters]コマンドオプション
Alibaba Cloud CLIを使用する場合、コマンドオプションを指定して、コマンドの動作を変更したり、コマンドの拡張機能を実装したりできます。 ほとんどの場合、次のコマンドオプションが使用されます。
-- profile <profileName>:-- profileオプションとprofileNameパラメーターを使用して、構成プロファイルを指定できます。 有効な構成プロファイルを指定すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定の情報を無視し、指定した構成を優先的に使用してコマンドを実行します。-- help:-- helpオプションを使用して、コマンドに関するヘルプ情報を取得できます。 詳細については、「ヘルプコマンドの使用」をご参照ください。
詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。
呼び出し例
次の例は、Alibaba Cloud CLIを使用してAlibaba Cloud CDNのDescribeUserDomains操作を呼び出し、アカウント内のすべてのドメイン名とそのステータスを照会する方法を示しています。 DescribeUserDomains操作の詳細については、「DescribeUserDomains」をご参照ください。
以下のコマンドを実行します。
コマンド出力を表示します。
Alibaba Cloud CDNのAPIを呼び出した後にエラーが返された場合は、エラーコードに基づいて入力パラメーターと値が有効かどうかを確認します。
を使用することもできます。 Alibaba Cloud OpenAPI Diagnosticsは、返されたリクエストIDまたはSDKエラー情報に基づいてセルフサービス診断を実行します。