ByCloud Docs
GuidesCLIAPISDK

Update instance

bycloud compute instances update --instance_id <instance_id> [flags]

Update an instance's name, description, or metadata

Options

--instance_id

stringrequired

Instance ID

--output

(-o)

stringoptional

Output format: text, json, or yaml

Values: "text", "json", "yaml"

Default: "text"

Body Options

--description

stringoptional

--metadata

objectoptional

--name

stringoptional

--tags

arrayoptional

Command

bycloud compute instances update \
  --instance_id "abc-123"

Output

ID                     550e8400-e29b-41d4-a716-446655440000
CRN                    crn:spo1:compute:instance:550e8400-e29b-41d4-a716-446655440000
NAME                   web-server-01
DESCRIPTION            Primary web server
STATUS                 ACTIVE
POWER_STATE            RUNNING
TASK_STATE             -
VM_STATE               ACTIVE
FLAVOR
  ID                     550e8400-e29b-41d4-a716-446655440000
  NAME                   m1.medium
  VCPUS                  2
  RAM                    4096
  DISK                   40
IMAGE
  ID                     550e8400-e29b-41d4-a716-446655440000
  NAME                   Ubuntu 22.04 LTS
ADDRESSES
  PRIVATE-NETWORK
    [0]
      ADDR                   192.168.1.10
      VERSION                4
      TYPE                   fixed
      MAC_ADDR               fa:16:3e:4f:5a:2b
SECURITY_GROUPS
  [0]
    NAME                   default
  [1]
    NAME                   default
VOLUMES_ATTACHED
  [0]
    ID                     550e8400-e29b-41d4-a716-446655440000
    DEVICE                 /dev/vdb
    DELETE_ON_TERMINATION  false
  [1]
    ID                     550e8400-e29b-41d4-a716-446655440000
    DEVICE                 /dev/vdb
    DELETE_ON_TERMINATION  false
KEY_NAME               my-keypair
METADATA
  ENVIRONMENT            production
  TEAM                   backend
TAGS                   web, frontend
PROJECT_ID             550e8400-e29b-41d4-a716-446655440000
USER_ID                550e8400-e29b-41d4-a716-446655440000
FAULT
  CODE                   500
  MESSAGE                No valid host was found
  DETAILS                string
  CREATED                2024-01-15T10:30:00Z
CREATED_AT             2024-01-15T10:30:00Z
UPDATED_AT             2024-01-15T10:30:00Z
LAUNCHED_AT            2024-01-15T10:30:00Z
TERMINATED_AT          2024-01-15T10:30:00Z