Skip to content

3-Configuration.md

Latest commit

 

History

History
183 lines (124 loc) · 4.38 KB

3-Configuration.md

File metadata and controls

183 lines (124 loc) · 4.38 KB
Raw

← Authentication | Configuration(中文) | Usage →

Configuration

CLI profiles and SSO sessions are stored in ~/.volcengine/config.json by default. The config file is written with 0600 permissions, and the config directory is created with 0700 permissions.

This document covers profile inspection, switching, updates, and deletion. Credential modes are covered in Authentication.

Config File Structure

The config file contains:

  • current: current default profile name.
  • profiles: profile map.
  • sso-session: SSO session map.
  • enableColor: whether colored JSON output is enabled. See Advanced Usage.

Example:

{
    "current": "prod",
    "profiles": {
        "prod": {
            "name": "prod",
            "mode": "ak",
            "access-key": "AK",
            "secret-key": "SK",
            "region": "cn-beijing"
        }
    },
    "enableColor": false,
    "sso-session": {}
}

Avoid manually editing sensitive fields. Prefer CLI commands.

Show Current Profile

ve configure get

Without --profile, the command shows the current profile:

no profile name specified, show current profile: [prod]

Show a Specific Profile

ve configure get --profile prod

If the profile does not exist, the command prints an empty profile object and does not create it.

List All Profiles

ve configure list

The output starts with current:

*** current profile: prod ***

Then each profile in the config file is printed.

Switch Current Profile

ve configure profile --profile prod

--profile is required. If the profile does not exist, current is not changed and an error is returned.

Switching current affects later service commands that do not specify --profile. For a single invocation, use:

ve ecs DescribeInstances --profile prod

Create or Update a Profile

ve configure set --profile prod --region cn-beijing --access-key AK --secret-key SK

Behavior:

  • --profile is required.
  • If the profile does not exist, it is created with default mode ak.
  • If the profile exists, only non-empty fields provided in this command are updated; omitted fields keep their previous values.
  • --disable-ssl and --use-dual-stack are written only when explicitly provided.
  • Successful create or update switches current to that profile.
  • region is not mandatory during configure set, but API calls must be able to resolve a region.

Update region:

ve configure set --profile prod --region cn-shanghai

Update endpoint:

ve configure set --profile prod --endpoint ecs.cn-beijing.volcengineapi.com

Use the standard endpoint resolver:

ve configure set --profile prod --endpoint-resolver standard

Configure proxy:

ve configure set --profile prod --https-proxy http://127.0.0.1:7890

Enable dual-stack:

ve configure set --profile prod --use-dual-stack

Disable SSL:

ve configure set --profile prod --disable-ssl

Delete a Profile

ve configure delete --profile prod

--profile is required. If the deleted profile is current, the CLI selects one remaining profile as the new current. If no profiles remain, current becomes empty.

Deleting a profile does not delete SSO sessions or the global Console Login cache directory. Console Login cache cleanup is covered in Authentication.

Selection Examples

Switch Between Environments

ve configure set --profile dev --region cn-beijing --access-key DEV_AK --secret-key DEV_SK
ve configure set --profile prod --region cn-beijing --access-key PROD_AK --secret-key PROD_SK

ve configure profile --profile dev
ve ecs DescribeInstances

ve configure profile --profile prod
ve ecs DescribeInstances

Override Profile for One Call

ve configure profile --profile dev
ve ecs DescribeInstances --profile prod

This call uses prod only for this invocation and does not modify current.

Override Region and Endpoint for One Call

ve ecs DescribeInstances --region cn-shanghai
ve sts GetCallerIdentity --region cn-beijing --endpoint sts.volcengineapi.com

← Authentication | Configuration(中文) | Usage →