CLI工具
CLI工具
文档指南
请输入
- 文档首页
CLI工具配置CLI配置接口调用凭证
复制全文
下载 pdf配置接口调用凭证
文档反馈
问问助手本文介绍如何使用profile，配置火山引擎CLI工具调用API的AK/SK、服务地域（Region）、服务地址（Endpoint）等接口调用凭证信息。火山引擎CLI目前支持的身份凭证类型有：控制台登录认证（console login）、 AK认证、StsToken认证、云身份中心（SSO）认证，详细说明如下：
方式一：控制台登录认证（console login）
注意
- 该功能仅在1.0.42及以上版本支持，低版本用户请先参考：安装指南，升级后使用。
控制台登录 (login)
指令说明：
该命令通过火山引擎控制台完成 OAuth 2.0 + PKCE 登录，并将临时 STS 凭证缓存到本地，后续业务命令可复用该 profile 临时凭证。profile和region， 支持 -p/-r 简写。
-
填写示例：
-
参数说明：
您还可以使用ve login -h命令，获取更多参数信息。
说明
- 登录成功后，profile 会被写为 console-login 模式，并记录 login-session
- 使用非default profile 登录后，业务命令不会自动切换到新创建的profile；需要执行命令切换：ve configure profile --profile [配置名称]
- 当前设备没有浏览器无法登录，需要远程授权时，使用 --remote参数。指令（示例）：ve login --profile myconsoleloginprofile --region cn-beijing --remote
切换到新Profile
将CLI工具的当前使用的Profile，设置为上一步配置的Profile。使用default profile则无需切换。
指令说明：
-
填写示例：
-
Console 登出 (logout)
登出指定 profile
该命令用于清理 ve login 建立的本地登录状态。它只删除本地缓存凭证并清除 profile 中的 login-session，不会删除 profile，也不会向服务端发起请求。当不指定--profile 参数时，登出default profile。
指令说明：
-
填写示例：
-
登出所有 profile
登出当前配置中的所有 Console Login profile。该命令用于清理 ve login 建立的本地登录状态。它只删除本地缓存凭证并清除 profile 中的 login-session，不会删除 profile，也不会向服务端发起请求。
指令说明：
-
填写示例：
-
注意
- ve logout 不带 --profile 时只处理 default profile，不会自动按 current 登出
- 只有 console-login profile 可使用该命令；AK/SSO profile 不适用
- 登出后若需继续使用，重新执行 ve login
方式二：AK认证
执行如下命令，新建配置（profile），预设调用接口的AK、SK信息。Windows操作系统请在Power Shell或命令提示符中执行命令，MacOS请在终端中执行命令。
指令说明：
-
填写示例：
-
参数说明：
您还可以使用ve configure set -h命令，获取更多参数信息。
注意
若profile文件中无配置，则会尝试从环境变量中读取配置信息。
方式三：StsToken认证
执行如下命令，新建配置（profile），预设调用接口的AK、SK、StsToken信息。Windows操作系统请在Power Shell或命令提示符中执行命令；MacOS请在终端中执行命令。
指令说明：
-
填写示例：
-
参数说明：
您还可以使用ve configure set -h命令，获取更多参数信息。
注意
若profile文件中无配置，则会尝试从环境变量中读取配置信息。
方式四：云身份中心认证
注意
- 该功能仅在1.0.38及以上版本支持，低版本用户请先参考：安装指南，升级后使用。
云身份中心（Cloud Identity）是链接外部身份和火山引擎云上身份的统一管理平台，使用此认证方式需要您开通并了解云身份中心的产品功能。火山引擎CLI工具完成云身份中心认证，需要经过：配置SSO会话、配置SSO Profile、切换到SSO Profile，配置过程中需要您登录云身份中心并完成授权。详细如下：
步骤1： 配置SSO会话（configure sso-session）
指令说明：
-
填写示例：
-
参数说明：
参数名 | 是否必选 | 含义 |
name | 是 | SSO会话名称。若已有会话，不填会进入选择列表，也可以在选择“创建”。 |
start-url | 是 | |
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
指令说明：
-
填写示例：
-
参数说明：
说明
- 云身份中心用户登录成功后，CLI页面将看到可选择的账号ID，请选择需要访问的账号ID（Account）和对应的角色（Role），如下图所示。
选择账号
选择角色
步骤3： 切换到新Profile
将CLI工具的当前使用的Profile，设置为上一步配置的SSO Profile。
指令说明：
-
填写示例：
-
SSO命令的其他功能
SSO登录（sso login）
以下指令用于 SSO 登录，获取访问令牌并缓存。
指令说明：
-
参数说明
注意
- 未指定 profile 和 sso-session 时：未配置任何会话会返回错误，仅有一个会话时直接使用该会话登录，有多个会话时进入交互式选择（可搜索筛选）。
- 当前仅支持设备码授权流程，--no-browser 用于关闭自动打开浏览器
SSO登出 (sso logout)
以下命令用于退出 SSO 登录，撤销缓存的令牌并清除本地凭证。支持参数及说明：
指令说明：
-
参数说明
注意
- 不指定 sso-session 时：未配置任何会话会返回错误，仅有一个会话时直接登出该会话，有多个会话时进入交互式选择，支持选择 “All SSO sessions” 批量登出
- 选择批量登出时会逐个注销，并在有失败时汇总错误信息返回
configure命令的其他功能
- 修改已有配置。指定已有的配置名（profile），传入新的配置信息，完成修改。
-
- 查看指定配置信息。
-
- 查看所有配置详情。
-
- 切换当前使用的配置。指定新配置名，CLI工具将尝试切换为该配置。若配置不存在，将不会切换，且提示您”configuration profile [配置名] not found“。
-
最近更新时间：2026.05.18 11:23:49
这个页面对您有帮助吗？
有用
有用
无用
无用