憑證配置相關命令

命令文法

aliyun configure [--mode <AuthenticateMode>] [--profile <ProfileName>]

• AuthenticateMode：指定要設定的憑證類型。若參數為空白，則預設建立AK類型憑證配置。

• ProfileName：指定配置名稱。若不使用該選項，將優先修改當前配置。若指定配置不存在則建立配置。

調用樣本

1. 執行如下命令，使用互動式方式建立AK類型憑證配置AkProfile。

   aliyun configure --mode AK --profile AkProfile

2. 互動過程如下所示。

   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 [--settingName <SettingValue>...] [--mode <AuthenticateMode>] [--profile <ProfileName>]

• SettingName：指定配置參數。建立配置時需參考身份憑證類型，設定對應類型中所有必填項，否則將建立失敗。

  可用選項列表

  選項	說明	樣本值
  --access-key-id	阿里雲帳號或 RAM 使用者的AccessKey ID。	yourAccessKeyID
  --access-key-secret	阿里雲帳號或 RAM 使用者的AccessKey Secret。	yourAccessKeySecret
  --ram-role-name	RAM角色名稱。	ECSAdmin
  --ram-role-arn	RAM角色ARN。	acs:ram::012345678910****:role/Alice
  --role-session-name	角色會話名稱。	alice
  --language	協助資訊語言。	zh
  --region	預設地區ID。	cn-hangzhou
  --read-timeout	I/O逾時時間（單位：秒）。	10
  --connect-timeout	連線逾時時間（單位：秒）。	10
  --retry-count	重試次數。	5
  --expired-seconds	憑證到期時間。	900
  --process-command	外部程式運行命令。	acs-sso login --profile sso
  --oidc-provider-arn	OIDC供應商ARN。	acs:ram::012345678910****:oidc-provider/TestOidcIdp
  --oidc-token-file	OIDC Token檔案路徑。	/path/to/oidctoken

• AuthenticateMode：指定憑證類型。若參數為空白，則預設建立AK類型憑證配置。

• ProfileName：指定配置名稱。若參數為空白且未配置環境變數ALIBABA_CLOUD_PROFILE，則優先修改當前配置。若指定配置不存在則建立新配置。

樣本一：非互動式建立配置

1. 執行如下命令，使用非互動式方式建立AK類型憑證配置AkProfile。

   aliyun configure set \
     --access-key-id <yourAccessKeyID> \
     --access-key-secret <yourAccessKeySecret> \
     --region cn-hangzhou \
     --profile AkProfile \
     --mode AK \
     --language en

2. 執行aliyun configure list命令，終端輸出如下資訊。則配置AkProfile已成功建立。

   Profile           | Credential            | Valid   | Region           | Language
   ---------         | ------------------    | ------- | ---------------- | --------
   default           | AK:******             | Valid   | cn-beijing       | zh
   AkProfile *       | AK:******             | Valid   | cn-hangzhou      | en

樣本二：修改指定配置

1. 執行aliyun configure get region命令，終端返回當前配置中的地區ID。

   

2. 執行如下命令，將當前配置的地區ID修改至cn-shanghai。

   aliyun configure set --region cn-shanghai

3. 再次執行aliyun configure get region命令，驗證修改結果。

   

調用樣本

1. 執行如下命令，擷取憑證配置列表。

   aliyun configure list

2. 終端返回如下配置列表。

   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

   配置列表包含以下概要資訊：配置名稱、當前配置標記（阿里雲CLI使用星形標示號*標記當前配置，該記號位於配置名稱右側）、部分憑證資訊、憑據有效性、預設地區ID以及協助資訊語言。

命令文法

aliyun configure get [SettingName...] [--profile <ProfileName>]

• SettingName：指定要查看的設定項，可同時指定多項設定，未指定時顯示全部設定項。若指定的設定項不存在，命令執行後終端不返回資訊。

  可用參數列表

  命令參數	說明	關聯配置欄位
  profile	配置名稱。	name
  mode	憑證類型。	mode
  access-key-id	阿里雲帳號或 RAM 使用者的AccessKey ID。	access_key_id
  access-key-secret	阿里雲帳號或 RAM 使用者的AccessKey Secret。	access_key_secret
  sts-token	RAM使用者或角色的臨時身份憑證STS Token。	sts_token
  sts-region	RAM使用者或角色擷取臨時身份憑證時發起調用的地區ID。	sts_region
  ram-role-name	RAM角色名稱。	ram_role_name
  ram-role-arn	RAM角色ARN。	ram_role_arn
  role-session-name	角色會話名稱。	ram_session_name
  language	協助資訊語言。	language
  region	預設地區ID。	region_id

• ProfileName：指定配置名稱。若該參數為空白且未配置環境變數ALIBABA_CLOUD_PROFILE，則優先查看當前配置資訊。若指定配置不存在，則提示profile <ProfileName> not found!。

樣本一：查看指定配置全部設定資訊

1. 執行如下命令，查看AK類型憑證配置AkProfile的全部設定項。

   aliyun configure get --profile AkProfile

2. 返回結果。

   {
           "name": "AkProfile",
           "mode": "AK",
           "access_key_id": "<yourAccessKeyID>",
           "access_key_secret": "<yourAccessKeySecret>",
           "region_id": "cn-hangzhou",
           "output_format": "json",
           "language": "en"
   }

樣本二：查看指定配置部分設定資訊

1. 執行如下命令，查看External類型憑證配置ExternalProfile的配置名稱、憑證類型及預設語言。

   aliyun configure get profile mode language --profile ExternalProfile

2. 終端以key=value格式返回設定詳情。

   profile=ExternalProfile
   mode=External
   language=en

命令文法

aliyun configure switch --profile <ProfileName>

ProfileName：指定配置名稱，該選項為必填項。若參數為空白或配置不存在，命令執行失敗。

調用樣本

1. 執行aliyun configure list命令擷取配置列表，可知當前配置為default（阿里雲CLI使用星形標示號*標記當前配置，該記號位於配置名稱右側）。

   Profile           | Credential            | Valid   | Region           | Language
   ---------         | ------------------    | ------- | ---------------- | --------
   default *         | AK:******             | Valid   | cn-hangzhou      | en
   ExampleProfile    | AK:******             | Valid   | cn-beijing       | zh

2. 執行如下命令，將當前配置切換為ExampleProfile。設定成功後終端返回資訊The default profile is `ExampleProfile` now.。

   aliyun configure switch --profile exampleProfile

3. 再次執行aliyun configure list命令，確認當前配置已更新。

   Profile           | Credential            | Valid   | Region           | Language
   ---------         | ------------------    | ------- | ---------------- | --------
   default           | AK:******             | Valid   | cn-hangzhou      | en
   ExampleProfile *  | AK:******             | Valid   | cn-beijing       | zh

命令文法

aliyun configure delete --profile <ProfileName>

• ProfileName：指定待刪除的配置名稱，該選項為必填項。若傳入參數為空白或配置不存在，命令執行失敗。

• 若要刪除的配置為當前配置，則刪除完成後自動將配置列表最頂端配置切換為當前配置，詳情請參見調用樣本。

• 建議保留至少一項配置。如果您誤操作導致清空憑證配置，則阿里雲CLI將無法正常工作。您需要手動刪除config.json檔案以解決此問題，該檔案位於您個人使用者目錄下的.aliyun檔案夾中。

調用樣本

1. 執行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

2. 執行如下命令，刪除配置ExampleProfile。

   aliyun configure delete --profile ExampleProfile

3. 再次執行aliyun configure list命令，配置ExampleProfile成功刪除，當前配置已切換為default。

   Profile           | Credential            | Valid   | Region           | Language
   ---------         | ------------------    | ------- | ---------------- | --------
   default *         | AK:******             | Valid   | cn-hangzhou      | en
   AkProfile         | AK:******             | Valid   | cn-hangzhou      | en