本文介绍如何使用profile,配置火山引擎CLI工具调用API的AK/SK、服务Region、网关地址等接口调用凭证信息。
执行如下命令,新建配置(profile),预设调用接口的凭证信息。
Windows操作系统请在Power Shell或命令提示符中执行命令;MacOS请在终端中执行命令。
ve configure set --profile [配置名] --region [地域] --endpoint open.volcengineapi.com --access-key [your ak] --secret-key [your sk]
参数说明:
您还可以使用
ve configure set -h
命令,获取更多参数信息。
参数名 | 是否必选 | 含义 | 示例 |
---|---|---|---|
profile | 是 | 配置名称。若该参数指定的配置已存在,则该命令会修改已有配置;否则会按照命令中包含的参数新建配置。 | ecsapi-config |
region | 是 | 地域ID,可填写地域和可用区中的RegionID 。 | cn-beijing |
access-key | 是 | 访问密钥ID(Access Key ID),获取操作可查看Access Key(密钥)管理。 | AKLTMDQwMmJmZjhiNmU2NGY0NzgyYTUzZmIxZDM******** |
secret-key | 是 | 与访问密钥 ID 相应的密钥(Secret Access Key),获取操作可查看Access Key(密钥)管理。 | TkROaFpETTJNbVU0WW1GaE5HWTFOV0lUWTFZVFF3TlRj******** |
endpoint | 是 | 网关地址,请在云产品文档的API参考-请求说明或示例中查看,例如:访问控制 IAM为iam.volcengineapi.com ,云服务器 ECS为open.volcengineapi.com 。 | iam.volcengineapi.com |
session-token | 否 | 角色扮演的安全令牌。参数值可通过AssumeRole接口获取。 | STSeyJBY2NvdW50SW**klkZW50aXR5VHlwZSI6Rpd******** |
disable-ssl | 否 | 是否禁用SSL。取值:
| false |
注意
若profile文件中无配置,则会尝试从环境变量中读取配置信息。
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# 如果使用角色扮演,需要提供
修改已有配置。
可指定已有修改的配置名(profile),传入新的配置信息,完成修改。
ve configure set --profile [配置名] --region [地区] --access-key [用户的AK] --secret-key [用户的SK] --endpoint [地区对应的endpoint] --disable-ssl [是否禁用SSL]
查看指定配置信息。
ve configure get --profile [配置名]
查看所有配置详情。
ve configure list
切换当前使用的配置。
指定新配置名,CLI工具将尝试切换为该配置。若配置不存在,将不会切换,且提示您”configuration profile [配置名] not found“。
ve configure profile --profile [配置名]