全部产品
Search
文档中心

阿里云CLI:configure功能子命令

更新时间:Jun 18, 2024

本文列举了阿里云CLI的configure功能的子命令。

快速配置或修改身份凭证配置信息

您可以使用aliyun configure命令快速配置或修改身份凭证信息。

语法

aliyun configure
aliyun configure --mode <AuthenticateMode> --profile <profileName>
  • --mode:指定要设置的身份凭证类型,为空则默认使用AK类型进行配置。

  • --profile:指定身份凭证配置,参数为空则使用默认身份凭证配置,若指定配置不存在则会新建配置。

方式一:aliyun configure

快速修改或配置默认身份凭证配置信息。如下所示,以配置default为例,实际以用户设置为准。如需修改默认身份凭证配置,请参见使用set命令修改默认身份凭证配置

示例

  1. 执行命令

    aliyun configure
  2. 返回结果

    完整示例

    Configuring profile 'default' in 'AK' authenticate mode...
    Access Key Id []: *********************
    Access Key Secret []: *********************
    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 --mode <mode> --profile <profileName>

以指定凭证类型快速配置身份凭证信息。如下所示,以AK类型配置AkProfile为例。

示例

  1. 执行命令

    aliyun configure --mode AK --profile AkProfile
  2. 示例

    如下所示,以default配置为例,实际以用户设定配置为准。

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

列出所有身份凭证配置的概要信息

您可以使用list命令查看所有身份凭证配置的概要信息。

示例

  1. 执行命令

    aliyun configure list
  2. 示例

    系统返回类似如下信息。其中包含配置名称,加密后的鉴权信息,语言,默认Region,以及当前默认身份凭证配置(配置名称右上角有星号标记)。

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

查看单个身份凭证配置的详细信息

您可以使用get命令查看单个身份凭证配置的详细信息。

语法

aliyun configure get
aliyun configure get --profile <profileName>
aliyun configure get [settingName]... --profile <profileName>
  • settingName:指定要查看的设置项,参数为空则获取指定配置的全部设置。若指定的设置项不存在,则命令执行后无返回结果。可修改设置项详见get命令支持查看设置项

  • --profile:指定身份凭证配置,参数为空则使用默认身份凭证配置。若指定配置不存在,则提示profile profileName not found!

方式一:aliyun configure get

查看默认身份凭证配置信息。

示例

  1. 执行命令

    aliyun configure get
  2. 返回结果

    完整示例

    {
            "name": "default",
            "mode": "AK",
            "access_key_id": "********************",
            "access_key_secret": "***********************",
            "sts_token": "",
            "sts_region": "",
            "ram_role_name": "",
            "ram_role_arn": "",
            "ram_session_name": "",
            "source_profile": "",
            "private_key": "",
            "key_pair_name": "",
            "expired_seconds": 0,
            "verified": "",
            "region_id": "cn-hangzhou",
            "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>

查看指定身份凭证配置信息。如下所示,以配置exampleProfile为例。

示例

  1. 执行命令

    aliyun configure get --profile exampleProfile
  2. 返回结果

    完整示例

    {
            "name": "exampleProfile",
            "mode": "AK",
            "access_key_id": "********************",
            "access_key_secret": "***********************",
            "sts_token": "",
            "sts_region": "",
            "ram_role_name": "",
            "ram_role_arn": "",
            "ram_session_name": "",
            "source_profile": "",
            "private_key": "",
            "key_pair_name": "",
            "expired_seconds": 0,
            "verified": "",
            "region_id": "cn-hangzhou",
            "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]... --profile <profileName>

查看指定身份凭证配置的单个设置项。如下所示,查看配置exampleProfile中的凭证类型mode,终端将以settingName=value格式返回设置详情。

示例

  1. 执行命令

    aliyun configure get mode --profile exampleProfile
  2. 返回结果

    mode=AK

修改单个身份凭证配置信息

您可以使用set命令修改单个身份凭证配置信息。

语法

aliyun configure set --profile <profileName>
aliyun configure set [--settingName <settingValue>]...
aliyun configure set [--settingName <settingValue>]... --profile <profileName>
aliyun configure set [--settingName <settingValue>]... --profile <profileName> --region <regionId>
  • --profile:指定身份凭证配置,参数为空则使用默认身份凭证配置,若指定配置不存在则会新建配置。

  • --settingName:指定要修改的设置项。详见set命令支持修改设置项

  • --settingName--profile参数顺序不影响命令执行结果。

  • set命令执行成功无返回值,可使用getlist命令查看修改结果。

方式一:aliyun configure set --profile <profileName>

将已有配置设为默认身份凭证配置。如下所示,以配置exampleProfile为例。

示例

  1. 执行命令

    aliyun configure set --profile exampleProfile
  2. 使用list命令查看修改结果

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

方式二:aliyun configure set [--settingName <settingValue>]...

修改默认身份凭证配置中的设置。如下所示,以语言language为例。

示例

  1. 执行命令

    aliyun configure set --language cn
  2. 使用get命令查看修改结果

    language=cn

方式三:aliyun configure set [--settingName <settingValue>]... --profile <profileName>

修改指定已有身份凭证配置中的设置。如下所示,以修改配置exampleProfile中的区域IDregion_id为例。

示例

  1. 执行命令

    aliyun configure set --region cn-hangzhou --profile exampleProfile
  2. 使用get命令查看修改结果

    cn-hangzhou

方式四:aliyun configure set [--settingName <settingValue>]... --profile <profileName> --region <regionId>

创建指定类型身份凭证配置,需要设置凭证对应的所有必填项,否则将创建失败。关于凭证类型对应必填项的更多信息,请参见身份凭证类型

如下所示,以AK类型身份凭证配置AkProfile为例。

示例

  1. 执行命令

    aliyun configure set 
      --profile akProfile
      --mode AK
      --region cn-beijing
      --access-key-id AccessKeyId
      --access-key-secret AccessKeySecret
  2. 使用list命令查看结果

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default           | AK:***yId             | Valid   | cn-hangzhou      | en
    akProfile *       | AK:***yId             | Valid   | cn-beijing       | en

删除指定身份凭证配置信息

您可以使用delete命令删除指定身份凭证配置信息。

语法

aliyun configure delete --profile <profileName>
  • --profile:指定身份凭证配置。若参数为空,命令执行失败。

  • 若要删除的身份凭证配置为默认身份凭证配置,则删除完成后自动修改最顶端配置为默认身份凭证配置。详情请参见示例。

  • 建议保留至少一项身份凭证配置文件,若您误操作导致清空身份凭证配置,则阿里云CLI在执行命令时会报错:

    ERROR: load current configuration failed unknown profile default, run configure to check

    您需要手动删除config.json文件来解决此问题,该文件位于您个人用户目录下的.aliyun文件夹中。

示例

删除指定身份凭证配置。如下所示,以配置exampleProfile为例。

  1. 执行前配置列表

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default           | AK:***yId             | Valid   | cn-hangzhou      | en
    AkProfile         | AK:***yId             | Valid   | cn-hangzhou      | en
    exampleProfile *  | AK:***yId             | Valid   | cn-hangzhou      | en
  2. 执行命令

    aliyun configure delete --profile exampleProfile
  3. 删除成功

    Profile           | Credential            | Valid   | Region           | Language
    ---------         | ------------------    | ------- | ---------------- | --------
    default *         | AK:***yId             | Valid   | cn-hangzhou      | en
    AkProfile         | AK:***yId             | 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>

    --sts-token

    设置StsToken

    --sts-token <StsToken>

    --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

    --skip-secure-verify

    跳过HTTPS的证书校验 [不推荐使用]

    --skip-secure-verify

    --expired-seconds

    指定凭证过期时间

    --expired-seconds <seconds>

  • get命令支持查看设置项

    SettingName

    对应配置文件profile中的设置

    profile

    name(配置名称)

    mode

    mode(配置类型)

    access-key-id

    access_key_id

    access-key-secret

    access_key_secret

    sts-token

    sts_token

    sts-region

    sts_region

    ram-role-name

    ram_role_name

    ram-role-arn

    ram_role_arn

    role-session-name

    ram_session_name

    private-key

    private_key(RSA私钥)

    key-pair-name

    key_pair_name(密钥对名称)

    region

    region_id(地域ID)

    language

    language(语言)