このトピックでは、Alibaba Cloud CLI のプロファイル関連のコマンドについて説明し、コマンドの使用方法の例を示します。
インタラクティブモードでプロファイルを作成する
aliyun configure
コマンドを実行して、インタラクティブモードでプロファイルを作成します。
構文
aliyun configure [--mode <AuthenticateMode>] [--profile <ProfileName>]
AuthenticateMode
: 設定する資格情報のタイプ。値を指定しない場合は、デフォルトの資格情報タイプ AK が使用されます。ProfileName
: プロファイル名。このオプションを指定しない場合は、現在のプロファイルが変更されます。指定されたプロファイルが存在しない場合は、指定された名前のプロファイルが作成されます。
例
次のコマンドを実行して、
AkProfile
プロファイルの AK 認証情報タイプをインタラクティブモードで設定します。aliyun configure --mode AK --profile AkProfile
インタラクティブプロセス:
Configuring profile 'AkProfile' in 'AK' authenticate mode... Access Key Id []: <yourAccessKeyID> Access Key Secret []: <yourAccessKeySecret> Default Region Id []: cn-hangzhou Default Output Format [json]: json (Only support json) Default Language [zh|en] en: en Saving profile[profile] ...Done.
非インタラクティブモードでプロファイルを作成または変更する
aliyun configure set
コマンドを実行して、非インタラクティブモードでプロファイルを作成または変更します。
プロファイルが変更されると、Alibaba Cloud CLI は変更されたプロファイルに切り替わります。
構文
aliyun configure set [--settingName <SettingValue>...] [--mode <AuthenticateMode>] [--profile <ProfileName>]
SettingName
: 設定するプロファイルオプション。プロファイルに必要なオプションを設定します。設定しない場合、プロファイルは作成に失敗します。詳細については、「資格情報を設定する」をご参照ください。AuthenticateMode
: 設定する資格情報のタイプ。値を指定しない場合は、デフォルトの資格情報タイプ AK が使用されます。ProfileName
: プロファイル名。値またはALIBABA_CLOUD_PROFILE
環境変数を指定しない場合、現在のプロファイルが変更されます。指定されたプロファイルが存在しない場合は、指定された名前のプロファイルが作成されます。
例 1: 非インタラクティブモードでファイルを作成する
次のコマンドを実行して、非インタラクティブモードで
AkProfile
AK 資格情報タイプの : プロファイルを設定します。aliyun configure set \ --access-key-id <yourAccessKeyID> \ --access-key-secret <yourAccessKeySecret> \ --region cn-hangzhou \ --profile AkProfile \ --mode AK \ --language en
aliyun configure list
コマンドを実行します。次の出力が表示された場合、AkProfile
プロファイルが作成されています。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default | AK:****** | Valid | cn-beijing | zh AkProfile * | AK:****** | Valid | cn-hangzhou | en
例 2: プロファイルを変更する
aliyun configure get region
コマンドを実行します。現在のプロファイルのリージョン ID が返されます。次のコマンドを実行して、プロファイルのリージョン ID を
cn-shanghai
に置き換えます。aliyun configure set --region cn-shanghai
aliyun configure get region
を再度実行して、リージョン ID が更新されているかどうかを確認します。
プロファイルのリストを照会する
aliyun configure list
コマンドを実行して、プロファイルのリストを照会します。リスト上のすべてのプロファイルの概要を表示できます。
例
次のコマンドを実行して、プロファイルのリストを照会します。
aliyun configure list
次のプロファイルのリストが返されます。
Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- AkProfile * | AK:****** | Valid | cn-beijing | en StsTokenProfile | StsToken:****** | Valid | cn-hangzhou | en RamRoleArnProfile | RamRoleArn:****** | Valid | cn-shanghai | en EcsRamRoleProfile | EcsRamRole:ECSAdmin | Valid | cn-qingdao | zh
プロファイルリストには、プロファイル名、プロファイル識別子、一部の資格情報、資格情報の有効期間、デフォルトリージョン ID、ヘルプ情報の言語など、各プロファイルの概要が含まれています。Alibaba Cloud CLI は、プロファイル名の右側にアスタリスク (
*
) を使用してプロファイルを識別します。
プロファイルの詳細を照会する
aliyun configure get
コマンドを実行して、指定されたプロファイルの詳細を照会します。
構文
aliyun configure get [SettingName...] [--profile <ProfileName>]
SettingName
: 照会するオプション。1 つ以上のオプションを指定できます。オプションを指定しない場合は、すべてのオプションが照会されます。指定されたオプションが存在しない場合は、情報は返されません。ProfileName
: プロファイル名。値またはALIBABA_CLOUD_PROFILE
環境変数を指定しない場合、現在のプロファイルの詳細が照会されます。指定されたプロファイルが存在しない場合は、profile <ProfileName> not found!
メッセージが返されます。
例 1: プロファイルのすべての設定オプションを表示する
次のコマンドを実行して、AK タイプの
AkProfile
プロファイルのすべての設定オプションを照会します。AKaliyun configure get --profile AkProfile
応答例:
{ "name": "AkProfile", "mode": "AK", "access_key_id": "<yourAccessKeyID>", "access_key_secret": "<yourAccessKeySecret>", "region_id": "cn-hangzhou", "output_format": "json", "language": "en" }
例 2: プロファイルの指定された設定オプションを照会する
次のコマンドを実行して、資格情報タイプが External の
ExternalProfile
のプロファイル名、資格情報タイプ、およびデフォルト言語を照会します。外部aliyun configure get profile mode language --profile ExternalProfile
詳細は
key=value
形式で返されます。profile=ExternalProfile mode=External language=en
特定のプロファイルに切り替える
aliyun configure switch
コマンドを実行して、現在のプロファイルから特定のプロファイルに切り替えます。このコマンドをサポートする最も古いバージョンは v3.0.216
です。
構文
aliyun configure switch --profile <ProfileName>
ProfileName
: プロファイル名。このパラメーターは必須です。パラメーターの値を指定しない場合、またはプロファイルが存在しない場合、このコマンドは失敗します。
例
aliyun configure list
コマンドを実行して、プロファイルのリストを照会します。リストは、現在のプロファイルがdefault
であることを示しています。Alibaba Cloud CLI は、プロファイル名の右側にアスタリスク (*
) を使用してプロファイルを識別します。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default * | AK:****** | Valid | cn-hangzhou | en ExampleProfile | AK:****** | Valid | cn-beijing | zh
次のコマンドを実行して、
ExampleProfile
プロファイルに切り替えます。The default profile is `ExampleProfile` now
メッセージが表示された場合、コマンドは成功です。aliyun configure switch --profile exampleProfile
aliyun configure list
コマンドを再度実行して、指定されたプロファイルに切り替えられているかどうかを確認します。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default | AK:****** | Valid | cn-hangzhou | en ExampleProfile * | AK:****** | Valid | cn-beijing | zh
プロファイルを削除する
aliyun configure delete
コマンドを実行して、特定のプロファイルを削除します。
構文
aliyun configure delete --profile <ProfileName>
ProfileName
: 削除するプロファイル。このパラメーターは必須です。パラメーターの値を指定しない場合、またはプロファイルが存在しない場合、コマンドは失敗します。現在のプロファイルを削除すると、リストの先頭にあるプロファイルに自動的に切り替わります。詳細については、次の例を参照してください。
少なくとも 1 つのプロファイルを保持することをお勧めします。すべてのプロファイルを削除すると、Alibaba Cloud CLI は期待どおりに動作しません。この場合、
config.json
ファイルを手動で削除して問題を解決する必要があります。このファイルは、個人ユーザーディレクトリの.aliyun
フォルダーにあります。
例
aliyun configure list
コマンドを実行して、プロファイルのリストを照会します。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default | AK:****** | Valid | cn-hangzhou | en AkProfile | AK:****** | Valid | cn-hangzhou | en ExampleProfile * | AK:****** | Valid | cn-hangzhou | en
次のコマンドを実行して、
ExampleProfile
ファイルを削除します。aliyun configure delete --profile ExampleProfile
aliyun configure list
コマンドを再度実行して、ExampleProfile
プロファイルが削除されているかどうかを確認します。削除されている場合、default
プロファイルに切り替えられています。Profile | Credential | Valid | Region | Language --------- | ------------------ | ------- | ---------------- | -------- default * | AK:****** | Valid | cn-hangzhou | en AkProfile | AK:****** | Valid | cn-hangzhou | en