如何使用阿里雲CLI的configure功能命令 - Alibaba Cloud CLI

本文將為您介紹阿里雲CLI配置憑證相關命令及其使用方式。

設定預設身份憑證配置

您可以使用aliyun configure switch命令將指定配置設定為預設身份憑證配置。該命令目前僅支援v3.0.216版本及更高版本的阿里雲CLI。

樣本：將指定配置設定為預設身份憑證配置

命令文法
```
aliyun configure switch --profile <profileName>
```
--profile <profileName>：指定身份憑證配置，該選項為必填項。

調用樣本

使用aliyun configure list命令查看命令執行前配置列表，預設身份憑證配置為default（配置名稱右上方有星號標記）。

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

執行如下命令，將配置exampleProfile設定為預設身份憑證配置。
```
aliyun configure switch --profile exampleProfile
```

終端返回如下資訊。

The default profile is 'exampleProfile' now.

使用aliyun configure list命令查看命令執行後配置列表。配置exampleProfile已設為預設身份憑證配置（配置名稱右上方有星號標記）。

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

互動式配置身份憑證

您可以使用aliyun configure命令，以互動式方式配置身份憑證資訊。該命令根據使用的選項不同，存在多種使用方式。

方式一：互動式配置預設憑證

命令文法
```
aliyun configure
```
調用樣本
1. 執行如下命令，使用互動式方式以配置預設身份憑證配置default。使用此命令修改預設配置時優先使用配置中原有憑證類型。
  說明
  您可以使用aliyun configure switch命令，設定預設身份憑證配置。具體操作，請參見設定預設身份憑證配置。
```
aliyun configure
```
2. 互動樣本。
```
Configuring profile 'default' in 'AK' authenticate mode...
Access Key Id []: ****
Access Key Secret []: ****
Default Region Id []: ****
Default Output Format [json]: json (Only support json)
Default Language [zh|en] en: en
Saving profile[profile] ...Done.
```

方式二：互動式配置身份憑證

命令文法
```
aliyun configure --mode <AuthenticateMode> --profile <profileName>
```
- --mode <AuthenticateMode>：指定要設定的身份憑證類型。
  - 若參數為空白，則預設使用AK類型進行配置。
  - 更多阿里雲CLI支援的憑證類型，請參見身份憑證類型。
- --profile <profileName>：指定身份憑證配置。若不使用該選項，阿里雲CLI將使用預設身份憑證配置調用命令。若指定配置不存在則會建立配置。

調用樣本

執行如下命令，使用互動式方式配置AK類型的身份憑證配置AkProfile。
```
aliyun configure --mode AK --profile AkProfile
```

互動樣本。

Configuring profile 'AkProfile' in 'AK' authenticate mode...
Access Key Id []: ****
Access Key Secret []: ****
Default Region Id []: ****
Default Output Format [json]: json (Only support json)
Default Language [zh|en] en: en
Saving profile[profile] ...Done.

非互動式配置身份憑證

您可以使用aliyun configure set命令，以非互動式方式配置身份憑證資訊。該命令根據使用的選項不同，存在多種使用方式。

說明

成功修改配置後，阿里雲CLI會將被修改配置設為預設身份憑證配置。

方式一：非互動式配置身份憑證

命令文法
```
aliyun configure set [--settingName <settingValue>]... --mode <AuthenticateMode> --profile <profileName>
```
- --settingName <settingValue>：指定要修改的設定項。詳見set命令可用選項。建立指定類型身份憑證配置，需要設定憑證對應的所有必填項，否則將建立失敗。
- --mode <AuthenticateMode>：指定要設定的身份憑證類型。若參數為空白，則預設使用AK類型進行配置。更多阿里雲CLI支援的憑證類型，請參見身份憑證類型。
- --profile <profileName>：指定身份憑證配置。參數為空白則使用預設身份憑證配置，若指定配置不存在則會建立配置。

調用樣本

執行如下命令，使用非互動式方式配置AK類型的身份憑證配置AkProfile。

aliyun configure set \
  --access-key-id **** \
  --access-key-secret **** \
  --region **** \
  --profile AkProfile \
  --mode AK

使用aliyun configure list命令查看結果。

Profile           | Credential            | Valid   | Region           | Language
---------         | ------------------    | ------- | ---------------- | --------
default           | AK:****               | Valid   | ****             | en
AK_Profile *      | AK:****               | Valid   | ****             | en

方式二：修改指定身份憑證配置

命令文法
```
aliyun configure set [--settingName <settingValue>]... --profile <profileName>
```
- --settingName <settingValue>：指定要修改的設定項。詳情請參見set命令可用選項。
- --profile <profileName>：指定身份憑證配置。若不使用該選項，阿里雲CLI將使用預設身份憑證配置調用命令。若指定配置不存在則會建立配置。
調用樣本
1. 執行如下命令，修改配置exampleProfile中的地區IDregion_id為cn-hangzhou。
```
aliyun configure set --region cn-hangzhou --profile exampleProfile
```
2. 執行aliyun configure get region --profile example命令，查看修改結果。
```
cn-hangzhou
```

擷取身份憑證列表

您可以使用aliyun configure list命令擷取身份憑證列表，在列表中查看全部身份憑證配置的概要資訊。

樣本：擷取身份憑證列表

執行如下命令，查看所有配置的概要資訊。
```
aliyun configure list
```

終端返回配置名稱，加密後的鑒權資訊，語言，預設地區，以及當前預設身份憑證配置（配置名稱右上方有星號標記）。

Profile           | Credential            | Valid   | Region           | Language
---------         | ------------------    | ------- | ---------------- | --------
akProfile *       | AK:****               | Valid   | ****             | en
stsTokenProfile   | StsToken:****         | Valid   | ****             | en
ramRoleArnProfile | RamRoleArn:****       | Valid   | ****             | en
ecsRamRoleProfile | EcsRamRole:****       | Valid   | ****             | zh

查看指定身份憑證配置

您可以使用aliyun configure get命令查看指定身份憑證配置的詳細資料。該命令根據使用的選項不同，存在多種使用方式。

方式一：查看預設配置全部資訊

命令文法
```
aliyun configure get
```

調用樣本

執行如下命令，查看預設配置default的詳細資料。
說明
您可以使用aliyun configure switch命令，設定預設身份憑證配置。具體操作，請參見設定預設身份憑證配置。
```
aliyun configure get
```

返回結果。

{
        "name": "default",
        "mode": "AK",
        "access_key_id": "****",
        "access_key_secret": "****",
        "sts_region": "",
        "ram_role_name": "",
        "ram_role_arn": "",
        "ram_session_name": "",
        "source_profile": "",
        "private_key": "",
        "key_pair_name": "",
        "expired_seconds": 0,
        "verified": "",
        "region_id": "****",
        "output_format": "json",
        "language": "en",
        "site": "",
        "retry_timeout": 0,
        "connect_timeout": 0,
        "retry_count": 0,
        "process_command": "",
        "credentials_uri": "",
        "oidc_provider_arn": "",
        "oidc_token_file": ""
}

方式二：查看指定配置全部資訊

命令文法
```
aliyun configure get --profile <profileName>
```
--profile <profileName>：指定身份憑證配置。若不使用該選項，阿里雲CLI將使用預設身份憑證配置調用命令。若指定配置不存在，則提示profile profileName not found!。

調用樣本

執行如下命令，查看External類型憑證配置exampleProfile的詳細資料。
```
aliyun configure get --profile exampleProfile
```

返回結果。

{
        "name": "exampleProfile",
        "mode": "External",
        "access_key_id": "",
        "access_key_secret": "",
        "sts_region": "",
        "ram_role_name": "",
        "ram_role_arn": "",
        "ram_session_name": "",
        "source_profile": "",
        "private_key": "",
        "key_pair_name": "",
        "expired_seconds": 0,
        "verified": "",
        "region_id": "****",
        "output_format": "json",
        "language": "en",
        "site": "",
        "retry_timeout": 0,
        "connect_timeout": 0,
        "retry_count": 0,
        "process_command": "****",
        "credentials_uri": "",
        "oidc_provider_arn": "",
        "oidc_token_file": ""
}

方式三：查看預設配置部分資訊

命令文法
```
aliyun configure get [settingName]...
```
- settingName：指定要查看的設定項，參數為空白則擷取指定配置的全部設定。若指定的設定項不存在，則命令執行後無返回結果。更多可用參數，請參見get命令可用參數。
調用樣本
1. 執行如下命令，查看預設身份憑證配置default中的配置名稱、憑證類型及預設語言。
  說明
  您可以使用aliyun configure switch命令，設定預設身份憑證配置。具體操作，請參見設定預設身份憑證配置。
```
aliyun configure get profile mode language --profile default
```
2. 終端以settingName=value格式返回設定詳情。
```
profile=default
mode=AK
language=en
```

方式四：查看指定配置部分資訊

命令文法
```
aliyun configure get [settingName]... --profile <profileName>
```
- settingName：指定要查看的設定項，參數為空白則擷取指定配置的全部設定。若指定的設定項不存在，則命令執行後無返回結果。更多可用參數，請參見get命令可用參數。
- --profile <profileName>：指定身份憑證配置。若指定配置不存在，則提示profile profileName not found!。
調用樣本
1. 執行如下命令，查看External類型憑證配置exampleProfile的名稱、憑證類型及預設語言。
```
aliyun configure get profile mode language --profile exampleProfile
```
2. 終端以settingName=value格式返回設定詳情。
```
profile=exampleProfile
mode=External
language=en
```

刪除身份憑證配置資訊

您可以使用aliyun configure delete命令刪除指定身份憑證配置資訊。

樣本：刪除指定身份憑證配置

命令文法
```
aliyun configure delete --profile <profileName>
```
- --profile：指定要刪除的身份憑證配置，該選項為必填項。若參數為空白或配置不存在，命令執行失敗。
- 若要刪除的配置為預設身份憑證配置，則刪除完成後自動修改配置列表最頂端配置為預設身份憑證配置。詳情請參見樣本。
- 建議保留至少一項身份憑證設定檔。如果您誤操作導致清空身份憑證配置，則阿里雲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

協助資訊

set命令可用選項

選項列表

標識符	說明	使用樣本
--access-key-id	設定`AccessKey Id`	--access-key-id <AccessKeyId>
--access-key-secret	設定`AccessKey Secret`	--access-key-secret <AccessKeySecret>
--ram-role-name	設定`RamRoleName`	--ram-role-name <RamRoleName>
--ram-role-arn	設定`RamRoleArn`	--ram-role-arn <RamRoleArn>
--role-session-name	設定`RoleSessionName`	--role-session-name <RoleSessionName>
--language	設定語言	--language [en\|zh]
--region	設定地區	--region cn-hangzhou
--read-timeout	設定I/O逾時時間（seconds）	--read-timeout 10
--connect-timeout	設定連線逾時時間（seconds）	--connect-timeout 10
--retry-count	設定重試次數	--retry-count 5
--expired-seconds	指定憑證到期時間	--expired-seconds <seconds>
--process-command	指定外部程式運行命令	--process-command <ProcessCommand>
--oidc-provider-arn	指定OIDC提供者ARN	--oidc-provider-arn <OIDCProviderARN>
--oidc-token-file	指定OIDC Token檔案路徑	--oidc-token-file <OIDCTokenFile>

get命令可用參數

參數列表

SettingName	對應設定檔profile中的設定
profile	name（配置名稱）
mode	mode（配置類型）
access-key-id	access_key_id
access-key-secret	access_key_secret
sts-region	sts_region
ram-role-name	ram_role_name
ram-role-arn	ram_role_arn
role-session-name	ram_session_name
region	region_id（地區ID）
language	language（語言）

設定預設身份憑證配置

樣本：將指定配置設定為預設身份憑證配置

命令文法

調用樣本

互動式配置身份憑證

方式一：互動式配置預設憑證

命令文法

調用樣本

方式二：互動式配置身份憑證

命令文法

調用樣本

非互動式配置身份憑證

方式一：非互動式配置身份憑證

命令文法

調用樣本

方式二：修改指定身份憑證配置

命令文法

調用樣本

擷取身份憑證列表

樣本：擷取身份憑證列表

查看指定身份憑證配置

方式一：查看預設配置全部資訊

命令文法

調用樣本

方式二：查看指定配置全部資訊

命令文法

調用樣本

方式三：查看預設配置部分資訊

命令文法

調用樣本

方式四：查看指定配置部分資訊

命令文法

調用樣本

刪除身份憑證配置資訊

樣本：刪除指定身份憑證配置

命令文法

調用樣本

協助資訊

set命令可用選項

get命令可用參數