憑證說明

• AK類型憑證為默認憑證類型，使用AccessKey信息作為身份憑證。配置AK類型憑證時可以忽略--mode選項。

• 配置必填項如下：

  • AccessKey Id：指定您的AccessKey ID。獲取方式請參見創建RAM用戶的AccessKey。

  • AccessKey Secret：指定您的AccessKey Secret。獲取方式請參見創建RAM用戶的AccessKey。

  • Region Id：指定默認區域的Region Id。阿里云支持的Region Id，請參見地域和可用區。

配置示例

如下示例，配置名為AkProfile的AK類型憑證。

• 交互式配置

  配置命令如下：

  aliyun configure --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[akProfile] ...Done.

• 非交互式配置

  使用configure命令下的set子命令進行非交互式配置，配置命令如下：

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

憑證說明

• RamRoleArn類型憑證通過RAM子賬號進行角色扮演獲取臨時憑證SecurityToken。更多關于此憑證類型的信息，請參見AssumeRole - 獲取扮演角色的臨時身份憑證。

• 配置RamRoleArn類型憑證時，需要在命令中使用--mode RamRoleArn指定憑證類型。

• 配置必填項如下：

  • AccessKey Id：指定您的AccessKey ID。獲取方式請參見創建AccessKey。

  • AccessKey Secret：指定您的AccessKey Secret。獲取方式請參見創建AccessKey。

  • Region Id：指定默認區域的RegionId。阿里云支持的RegionId，請參見地域和可用區。

  • RamRoleArn：需要扮演的RAM角色ARN。您可以通過RAM控制臺或API查看角色 ARN，具體操作如下：

    • RAM控制臺：請參見如何查看 RAM 角色的 ARN。

    • API：請參見ListRoles - 獲取角色列表或GetRole - 獲取角色信息。

  • RoleSessionName：角色會話名稱。該參數為用戶自定義參數，通常設置為調用該API的用戶身份，例如：用戶名。

配置示例

如下示例，配置名為RamRoleArnProfile的RamRoleArn類型憑證。

• 交互式配置

  配置命令如下：

  aliyun configure --profile RamRoleArnProfile --mode RamRoleArn

  配置交互過程示例如下：

  示例

  Configuring profile 'RamRoleArnProfile' in 'RamRoleArn' authenticate mode...
  Access Key Id []: ****
  Access Key Secret []: ****
  Ram Role Arn []: ****
  Role Session Name []: ****
  Default Region Id []: ****
  Default Output Format [json]: json (Only support json))
  Default Language [zh|en] en: en
  Saving profile[ramRoleArnProfile] ...Done.

• 非交互式配置

  使用configure命令下的set子命令進行非交互式配置，配置命令如下：

  aliyun configure set \
    --profile RamRoleArnProfile \
    --mode RamRoleArn \
    --access-key-id **** \
    --access-key-secret **** \
    --ram-role-arn **** \
    --role-session-name ****\
    --region **** 

憑證說明

• EcsRamRole類型憑證無需配置AccessKey，即可在ECS實例內部通過訪問元數據服務（Meta Data Service）獲取臨時身份憑證（STS Token）以調用API，從而降低AccessKey泄露的風險。

• EcsRamRole類型憑證僅支持在實例RAM角色綁定的ECS實例內部使用，在實例外部無法配置或使用該類型憑證。

• 配置EcsRamRole類型憑證時，需要在命令中使用--mode EcsRamRole指定憑證類型。

• 配置必填項如下：

  • Region Id：指定默認地域的RegionId。阿里云支持的RegionId，請參見地域和可用區。

  • EcsRamRole：指定ECS實例RAM角色的角色名稱。實例RAM角色的創建方式，請參見創建RAM角色并授予給ECS實例。

配置示例

如下示例，配置名為EcsRamRoleProfile的EcsRamRole類型憑證。

• 交互式配置

  配置命令如下：

  aliyun configure --profile EcsRamRoleProfile --mode EcsRamRole

  配置交互過程示例如下：

  示例

  Configuring profile 'EcsRamRoleProfile' in 'EcsRamRole' authenticate mode...
  Ecs Ram Role []: ****
  Default Region Id []: ****
  Default Output Format [json]: json (Only support json))
  Default Language [zh|en] en: en
  Saving profile[ecsRamRamRoleArnProfile] ...Done.

• 非交互式配置

  使用configure命令下的set子命令進行非交互式配置，配置命令如下：

  aliyun configure set \
    --profile EcsRamRoleProfile \
    --mode EcsRamRole \
    --ram-role-name **** \
    --region ****

憑證說明

• External類型憑證通過外部程序獲取憑證數據，阿里云CLI在使用時會執行該程序命令，獲取返回結果作為憑證。

• 配置External類型憑證時，需要在命令中使用--mode External指定憑證類型。

• 阿里云CLI支持云SSO通過該憑證類型進行登錄。具體操作，請參見使用CLI登錄云SSO并訪問阿里云資源。

• 配置必填項如下：

  • Process Command：外部程序命令。支持外部程序返回AK和StsToken兩種靜態的憑證。憑證結構示例如下：

    AK

    {
      "mode": "AK",
      "access_key_id": "accessKeyId",
      "access_key_secret": "accessKeySecret"
    }

    StsToken

    {
      "mode": "StsToken",
      "access_key_id": "accessKeyId",
      "access_key_secret": "accessKeySecret",
      "sts_token": "stsToken"
    }

  • Region Id：指定默認區域的RegionId。阿里云支持的RegionId，請參見地域和可用區。

配置示例

如下示例，配置名為ExternalProfile的External類型憑證。

• 交互式配置

  配置命令如下：

  aliyun configure --profile ExternalProfile --mode External

  配置交互過程示例如下：

  示例

  Configuring profile 'ExternalProfile' in 'External' authenticate mode...
  Process Command []: ****
  Default Region Id []: ****
  Default Output Format [json]: json (Only support json)
  Default Language [zh|en] en: en
  Saving profile[externalTest] ...Done.

• 非交互式配置

  使用configure命令下的set子命令進行非交互式配置，配置命令如下：

  aliyun configure set \
    --profile ExternalProfile \
    --mode External \
    --process-command **** \
    --region ****

憑證說明

• ChainableRamRoleArn類型憑證通過指定一個前置身份憑證配置，從前置配置中獲取中間憑證，再基于中間憑證完成角色扮演，獲取最終的身份憑證。

• 配置ChainableRamRoleArn類型憑證時，需要在命令中使用--mode ChainableRamRoleArn指定憑證類型。

• 配置必填項如下：

  • Source Profile：前置身份憑證配置名稱。前置憑證類型不作限制，在配置ChainableRamRoleArn類型憑證之前，您需要先配置前置憑證。詳情可參見配置示例。

  • Region Id：指定默認區域的RegionId。阿里云支持的RegionId，請參見地域和可用區。

  • RamRoleArn：需要扮演的RAM角色ARN。您可以通過RAM控制臺或API查看角色 ARN，具體操作如下：

    • RAM控制臺：請參見如何查看 RAM 角色的 ARN。

    • API：請參見ListRoles - 獲取角色列表或GetRole - 獲取角色信息。

  • RoleSessionName：角色會話名稱。該參數為用戶自定義參數，通常設置為調用該API的用戶身份，例如：用戶名。

配置示例

示例如下，以配置名為ChainableProfile的ChainableRamRoleArn類型憑證為例，使用RamRoleArn類型憑證RamRoleArnProfile作為前置身份憑證。

• 交互式配置

  1. 配置前置身份憑證RamRoleArnProfile，配置流程可參考RamRoleArn類型憑證配置示例。

  2. 執行如下命令，配置ChainableRamRoleArn類型憑證ChainableProfile。

     aliyun configure --profile ChainableProfile --mode ChainableRamRoleArn

     配置交互過程示例如下，在Source Profile選項處輸入配置名稱RamRoleArnProfile，以指定前置憑證：

     示例

     Configuring profile 'ChainableProfile' in 'ChainableRamRoleArn' authenticate mode...
     Source Profile []: RamRoleArnProfile
     Sts Region []: ****
     Ram Role Arn []: ****
     Role Session Name []: ****
     Expired Seconds [900]: ****
     Default Region Id []: ****
     Default Output Format [json]: json (Only support json)
     Default Language [zh|en] en: en
     Saving profile[p1] ...Done.

• 暫不支持使用非交互式方式配置ChainableRamRoleArn類型憑證。

憑證說明

• CredentialsURI類型憑證通過訪問一個本地或遠程的URI地址獲取身份憑證。

• 配置CredentialsURI類型憑證時，需要在命令中使用--mode CredentialsURI指定憑證類型。

• 配置必填項如下：

  • CredentialsURI：本地或遠程URI地址。若該地址無法正常訪問或返回結構不正確，阿里云CLI將處理為失敗案例。標準返回結構如下所示：

    標準返回結構

    {
      "Code": "Success",
      "AccessKeyId": "<ak id>",
      "AccessKeySecret": "<ak secret>",
      "SecurityToken": "<security token>",
      "Expiration": "2006-01-02T15:04:05Z"
    }

  • Region Id：指定默認區域的RegionId。阿里云支持的RegionId，請參見地域和可用區。

配置示例

如下示例，配置名為URIProfile的CredentialsURI類型憑證。

• 交互式配置

  配置命令如下：

  aliyun configure --profile URIProfile --mode CredentialsURI

  配置交互過程示例如下：

  示例

  Configuring profile 'URIProfile' in 'CredentialsURI' authenticate mode...
  Credentials URI []: ****
  Default Region Id []: ****
  Default Output Format [json]: json (Only support json)
  Default Language [zh|en] en: en
  Saving profile[cup] ...Done.

• 暫不支持使用非交互式方式配置CredentialsURI類型憑證。

憑證說明

• OIDC類型憑證使用基于OIDC的SSO角色扮演獲取憑證。更多關于此憑證類型的信息，請參見AssumeRoleWithOIDC - OIDC角色SSO時獲取扮演角色的臨時身份憑證。

• 配置OIDC類型憑證時，需要在命令中使用--mode OIDC指定憑證類型。

• 配置必填項如下：

  • OIDCProviderARN：指定OIDC身份提供商的ARN。您可以通過 RAM 控制臺或 API 查看 OIDC 身份提供商的 ARN，具體操作如下：

    • RAM 控制臺：請參見管理OIDC身份提供商。

    • API：請參見GetOIDCProvider - 查詢OIDC身份提供商信息或ListOIDCProviders - 查詢OIDC身份提供商列表。

  • OIDCTokenFile：指定OIDC Token文件路徑。OIDC Token是由外部IdP簽發的OIDC令牌。

  • Region Id：指定默認區域的RegionId。阿里云支持的RegionId，請參見地域和可用區。

  • RamRoleArn：需要扮演的RAM角色ARN。您可以通過RAM控制臺或API查看角色ARN，具體操作如下：

    • RAM控制臺：請參見如何查看 RAM 角色的 ARN。

    • API：請參見ListRoles - 獲取角色列表或GetRole - 獲取角色信息。

  • RoleSessionName：角色會話名稱。該參數為用戶自定義參數，通常設置為調用該API的用戶身份，例如：用戶名。

配置示例

如下示例，配置名為OIDCProfile的OIDC類型憑證。

• 交互式配置

  配置命令如下：

  aliyun configure --profile OIDCProfile --mode OIDC

  配置交互過程示例如下：

  示例

  Configuring profile 'OIDCProfile' in 'OIDC' authenticate mode...
  OIDC Provider ARN []: ****
  OIDC Token File []: ****
  RAM Role ARN []: ****
  Role Session Name []: ****
  Default Region Id []: ****
  Default Output Format [json]: json (Only support json)
  Default Language [zh|en] en: en
  Saving profile[oidc_p] ...Done.

• 非交互式配置

  使用configure命令下的set子命令進行非交互式配置，配置命令如下：

  aliyun configure set \
    --profile OIDCProfile \
    --mode OIDC \
    --oidc-provider-arn **** \
    --oidc-token-file **** \
    --ram-role-arn **** \
    --role-session-name ****\
    --region ****