本文介绍如何使用profile，配置火山引擎CLI工具调用API的AK/SK、服务地域（Region）、服务地址（Endpoint）等接口调用凭证信息。火山引擎CLI目前支持的身份凭证类型有： ** AK认证**、**StsToken认证**、**云身份中心（SSO）认证**，详细说明如下： # 方式一：AK认证执行如下命令，新建配置（profile），预设调用接口的AK、SK信息。Windows操作系统请在Power Shell或命令提示符中执行命令，MacOS请在终端中执行命令。 **指令说明：** ```Bash ve configure set --profile [配置名] --region [地域] --endpoint open.volcengineapi.com --access-key [your ak] --secret-key [your sk] ``` **填写示例：** ```Bash ve configure set --profile myakprofile --region cn-beijing --endpoint open.volcengineapi.com --access-key AKLTMDQwMmJmZjhiNmU2NGY0NzgyYTUzZmIxZDM******** --secret-key TkROaFpETTJNbVU0WW1GaE5HWTFOV0lUWTFZVFF3TlRj******** ``` **参数说明：** > 您还可以使用`ve configure set -h`命令，获取更多参数信息。 |参数名 |是否必选 |含义 |示例 | |---|---|---|---| |profile |是 |配置名称。若该参数指定的配置已存在，则该命令会修改已有配置；否则会按照命令中包含的参数新建配置。 |ecsapi\-config | |region |是 |地域ID，可填写[地域和可用区](https://www.volcengine.com/docs/6396/67719#.5Zyw5Z-f5ZKM5Y-v55So5Yy65YiX6KGo)中的`RegionID`。 |cn\-beijing | |access\-key |是 |访问密钥ID(Access Key ID)，获取操作可查看[Access Key（密钥）管理](https://www.volcengine.com/docs/6291/65568)。 |AKLTMDQwMmJmZjhiNmU2NGY0NzgyYTUzZmIxZDM\*\*\*\*\*\*\*\* | |secret\-key |是 |与访问密钥 ID 相应的密钥（Secret Access Key），获取操作可查看[Access Key（密钥）管理](https://www.volcengine.com/docs/6291/65568)。 |TkROaFpETTJNbVU0WW1GaE5HWTFOV0lUWTFZVFF3TlRj\*\*\*\*\*\*\*\* | |endpoint |否 |服务地址，默认值为 open.volcengineapi.com。请在云产品文档的API参考\-请求说明或示例中查看，例如：访问控制 IAM为`iam.volcengineapi.com`，云服务器 ECS在cn\-beijing Region的地址为：`ecs.cn-beijing.volcengineapi.com` |iam.volcengineapi.com | |disable\-ssl |否 |是否禁用SSL。取值：|false |\ | | || |\ | | |* false（默认）：不禁用。| |\ | | |* true：禁用。 | | :::warning 若profile文件中无配置，则会尝试从环境变量中读取配置信息。 ::: ```Bash export VOLCENGINE_ACCESS_KEY=AK export VOLCENGINE_SECRET_KEY=SK export VOLCENGINE_REGION=cn-beijing export VOLCENGINE_DISABLE_SSL=false #是否禁用SSL, 不设置的话默认为false ``` # 方式二：**StsToken**认证执行如下命令，新建配置（profile），预设调用接口的AK、SK、StsToken信息。Windows操作系统请在Power Shell或命令提示符中执行命令；MacOS请在终端中执行命令。 **指令说明：** ```Bash ve configure set --profile [配置名] --region [地域] --endpoint open.volcengineapi.com --access-key [your ak] --secret-key [your sk] --session-token [your sts token] ``` **填写示例：** ```Bash ve configure set --profile mystsprofile --region cn-beijing --endpoint open.volcengineapi.com --access-key AKLTMDQwMmJmZjhiNmU2NGY0NzgyYTUzZmIxZDM**** --secret-key TkROaFpETTJNbVU0WW1GaE5HWTFOV0lUWTFZVFF3TlRj****** --session-token STSeyJBY2NvdW50SW**klkZW50aXR5VHlwZSI6Rpd******** ``` **参数说明：** > 您还可以使用`ve configure set -h`命令，获取更多参数信息。 |参数名 |是否必选 |含义 |示例 | |---|---|---|---| |profile |是 |配置名称。若该参数指定的配置已存在，则该命令会修改已有配置；否则会按照命令中包含的参数新建配置。 |ecsapi\-config | |region |是 |地域ID，可填写[地域和可用区](https://www.volcengine.com/docs/6396/67719#.5Zyw5Z-f5ZKM5Y-v55So5Yy65YiX6KGo)中的`RegionID`。 |cn\-beijing | |access\-key |是 |访问密钥ID(Access Key ID)，获取操作可查看[Access Key（密钥）管理](https://www.volcengine.com/docs/6291/65568)。 |AKLTMDQwMmJmZjhiNmU2NGY0NzgyYTUzZmIxZDM\*\*\*\*\*\*\*\* | |secret\-key |是 |与访问密钥 ID 相应的密钥（Secret Access Key），获取操作可查看[Access Key（密钥）管理](https://www.volcengine.com/docs/6291/65568)。 |TkROaFpETTJNbVU0WW1GaE5HWTFOV0lUWTFZVFF3TlRj\*\*\*\*\*\*\*\* | |endpoint |否 |服务地址，默认值为 open.volcengineapi.com。请在云产品文档的API参考\-请求说明或示例中查看，例如：访问控制 IAM为`iam.volcengineapi.com`，云服务器 ECS在cn\-beijing Region的地址为：`ecs.cn-beijing.volcengineapi.com` |iam.volcengineapi.com | |session\-token |是 |角色扮演的安全令牌。参数值可通过[AssumeRole](https://www.volcengine.com/docs/6257/86374)接口获取。 |STSeyJBY2NvdW50SW\*\*klkZW50aXR5VHlwZSI6Rpd\*\*\*\*\*\*\*\* | |disable\-ssl |否 |是否禁用SSL。取值：|false |\ | | || |\ | | |* false（默认）：不禁用。| |\ | | |* true：禁用。 | | :::warning 若profile文件中无配置，则会尝试从环境变量中读取配置信息。 ::: ```Bash export VOLCENGINE_ACCESS_KEY=AK export VOLCENGINE_SECRET_KEY=SK export VOLCENGINE_REGION=cn-beijing export VOLCENGINE_DISABLE_SSL=false #是否禁用SSL, 不设置的话默认为false export VOLCENGINE_SESSION_TOKEN=sessionToken ``` # 方式三：云身份中心认证 [云身份中心](https://www.volcengine.com/docs/7165/196881)（Cloud Identity）是链接外部身份和火山引擎云上身份的统一管理平台，使用此认证方式需要您开通并了解云身份中心的产品功能。火山引擎CLI工具完成云身份中心认证，需要经过：**配置SSO会话**、**配置SSO Profile**、**切换到SSO Profile，** 配置过程中需要您登录云身份中心并完成授权。详细如下： ## 步骤1：配置SSO会话（configure sso\-session） **指令说明：** ```Bash ve configure sso-session --name [会话名] --start-url [SSO Start URL] --region [地区] --registration-scopes [scope1,scope2] ``` **填写示例：** ```Bash ve configure sso-session --name myssosession --start-url https:xxxx.com/userportal --region cn-beijing --registration-scopes cloudidentity:account:access,offline_access ``` **参数说明：** |参数名 |是否必选 |含义 | |---|---|---| |name |是 |SSO会话名称。若已有会话，不填会进入选择列表，也可以在选择“创建”。 | |start\-url |是 |云身份中心的登录地址，请[登录云身份中心控制台](https://console.volcengine.com/auth/login?redirectURI=%2Fcloudidentity%2Fregion%3Acn-beijing%2FuserSync%2F)获取。(特别注意：请在该地址后面加上`/userportal`)![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_043876c8de01d3a7dbf5d428d2fab570.png) | |region |是 |云身份中心服务的地区（注意：不是调用OpenAPI的Region），固定为：cn\-beijing。不填默认为：cn\-beijing | |registration\-scopes |否 |SSO scope 列表（逗号分隔），固定为：cloudidentity:account:access,offline_access。不填默认为：cloudidentity:account:access,offline_access | **交互式流程说明：** * 若当前无任何 SSO 会话，会提示输入会话名，不能为空 * 若已有会话，会进入可搜索的列表选择，可选 “” 创建新会话 * 编辑已有会话时，Start URL、Region、Scopes 会回填默认值，回车可沿用 * Scopes 会进行去重与校验；未输入时使用默认值 cloudidentity:account:access,offline_access ## 步骤2：配置SSO Profile **指令说明：** ```Bash ve configure sso --profile [配置名] --sso-session [会话名] ``` **填写示例：** ```Bash ve configure sso --profile myssoprofile --sso-session myssosession ``` **参数说明：** |参数名 |是否必选 |含义 | |---|---|---| |profile |是 |访问凭证profile的名称，未输入时使用 {sso\-role\-name}\-{sso\-account\-id} 作为默认值。 | |sso\-session |是 |SSO 会话名称，未输入时进入交互式选择/创建模式。 | |no\-browser |否 |禁止自动打开浏览器，默认 false。 | :::tip * 云身份中心用户登录成功后，CLI页面将看到可选择的账号ID，请选择需要访问的账号ID（Account）和对应的角色（Role），如下图所示。选择账号 ## ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_dc19b5b9db377604143128c825eafcdb.png) 选择角色 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_04514140707d49336387016b8ab4543a.png) ::: ## 步骤3：切换到新Profile 将CLI工具的当前使用的Profile，设置为上一步配置的SSO Profile。 **指令说明：** ```Bash ve configure profile --profile [配置名] ``` **填写示例：** ```Bash ve configure profile --profile myssoprofile ``` # SSO命令的其他功能 ## SSO登录（sso login）以下指令用于 SSO 登录，获取访问令牌并缓存。 **指令说明：** ```Bash ve sso login --profile [配置名] 或 ve sso login --sso-session [会话名] ``` **参数说明** |参数名 |含义 | |---|---| |profile |指定要使用的 SSO profile；必须存在且类型为 sso，且已配置 sso\-session。 | |sso\-session |指定要使用的 SSO 会话；会话必须存在且有效。 | :::warning * 未指定 profile 和 sso\-session 时：未配置任何会话会返回错误，仅有一个会话时直接使用该会话登录，有多个会话时进入交互式选择（可搜索筛选）。 * 当前仅支持设备码授权流程，\-\-no\-browser 用于关闭自动打开浏览器 ::: ## SSO登出 (sso logout) 以下命令用于退出 SSO 登录，撤销缓存的令牌并清除本地凭证。支持参数及说明： **指令说明：** ```Bash ve sso logout --sso-session [会话名] ``` **参数说明** |参数名 |含义 | |---|---| |sso\-session |指定要退出的 SSO 会话名称 | :::warning * 不指定 sso\-session 时：未配置任何会话会返回错误，仅有一个会话时直接登出该会话，有多个会话时进入交互式选择，支持选择 “All SSO sessions” 批量登出 * 选择批量登出时会逐个注销，并在有失败时汇总错误信息返回 ::: # configure命令的其他功能 * 修改已有配置。指定已有的配置名（profile），传入新的配置信息，完成修改。 ```Bash ve configure set --profile [配置名] --region [地区] --access-key [用户的AK] --secret-key [用户的SK] --endpoint [地区对应的endpoint] --disable-ssl [是否禁用SSL] ``` * 查看指定配置信息。 ```Bash ve configure get --profile [配置名] ``` * 查看所有配置详情。 ```Bash ve configure list ``` * 切换当前使用的配置。指定新配置名，CLI工具将尝试切换为该配置。若配置不存在，将不会切换，且提示您”configuration profile [配置名] not found“。 ```Bash ve configure profile --profile [配置名] ```