CLI Command Reference

Obtaining the Environment List

hcloud CAE ListEnvironments

Obtain the environment list.

Go debug

Creating an Environment

hcloud CAE CreateEnvironment

This API is used to create an environment.

Go debug

Deleting an Environment

hcloud CAE DeleteEnvironment

Delete an environment.

Go debug

Obtaining the Application List

hcloud CAE ListApplications

Obtain the application list.

Go debug

Creating an Application

hcloud CAE CreateApplication

This API is used to create an application.

Go debug

Obtaining the Details of an Application

hcloud CAE ShowApplication

Obtain the details of an application.

Go debug

Deleting an Application

hcloud CAE DeleteApplication

Delete an application.

Go debug

Creating a Component

hcloud CAE CreateComponent

This API is used to create a component.

Go debug

Obtaining the Component List

hcloud CAE ListComponents

Obtain the component list.

Go debug

Obtaining the Details of a Component

hcloud CAE ShowComponent

Obtain the details of a component.

Go debug

Updating a Component

hcloud CAE UpdateComponent

Update a component.

Go debug

Deleting a Component

hcloud CAE DeleteComponent

Delete a component.

Go debug

Performing Operations on a Component

hcloud CAE ExecuteAction

This API is used to perform operations (such as deploy, upgrade, restart, stop, start, scale, configure, and roll back) on a component.

Go debug

Obtaining the Component Snapshot List

hcloud CAE ListComponentSnapshots

Obtain the component snapshot list.

Go debug

Obtaining the Component Instance List

hcloud CAE ListComponentInstances

Obtain the component instance list.

Go debug

Obtaining the Component Configuration List

hcloud CAE ListComponentConfigurations

Obtain the component configuration list.

Go debug

Adding a Component Configuration

hcloud CAE CreateComponentConfiguration

This API is used to add a component configuration.

Go debug

Deleting a Component Configuration

hcloud CAE DeleteComponentConfiguration

Delete the component configuration.

Go debug

Obtaining the Cloud Storage List

hcloud CAE ListVolumes

Obtain the cloud storage list.

Go debug

Authorizing Cloud Storage

hcloud CAE CreateVolume

This API is used to authorize cloud storage.

Go debug

Unbinding Cloud Storage

hcloud CAE DeleteVolume

Unbind cloud storage.

Go debug

Obtaining the Agency List

hcloud CAE ListAgencies

Obtain the agency list.

Go debug

Creating an Agency

hcloud CAE CreateAgency

This API is used to create an agency.

Go debug

Obtaining Job Details

hcloud CAE ShowJob

Obtain job details.

Go debug

Retrying a Job

hcloud CAE RetryJob

This API is used to retry a job.

Go debug

Obtaining the Domain Name List

hcloud CAE ListDomains

Obtain the domain name list.

Go debug

Creating a Domain Name

hcloud CAE CreateDomain

This API is used to create a domain name.

Go debug

Deleting a Domain Name

hcloud CAE DeleteDomain

Delete a domain name.

Go debug

Obtaining the Certificate List

hcloud CAE ListCertificates

Obtain the certificate list.

Go debug

Creating a Certificate

hcloud CAE CreateCertificate

This API is used to create a certificate.

Go debug

Modifying a Certificate

hcloud CAE UpdateCertificate

Modify a certificate.

Go debug

Deleting a Certificate

hcloud CAE DeleteCertificate

Delete a certificate.

Go debug

Obtaining the Scheduled Start/Stop Policy List

hcloud CAE ListTimerRules

Obtain the scheduled start/stop policy list.

Go debug

Creating a Scheduled Start/Stop Policy

hcloud CAE CreateTimerRule

This API is used to create a scheduled start/stop policy.

Go debug

Deleting a Scheduled Start/Stop Policy

hcloud CAE DeleteTimerRule

Delete a scheduled start/stop policy.

Go debug

Modifying a Scheduled Start/Stop Policy

hcloud CAE UpdateTimerRule

Modify a scheduled start/stop rule.

Go debug

Obtaining the Last Execution Status of a Scheduled Start/Stop Policy

hcloud CAE ShowExecutionResult

Obtain the last execution status of a scheduled start/stop policy.

Go debug

Obtaining the EIP List of Cluster Nodes

hcloud CAE ListEips

Obtain the EIP list of cluster nodes.

Go debug

Modifying the Inbound and Outbound Bandwidth and Enabling Status

hcloud CAE UpdateEip

Modify the inbound and outbound bandwidth and enabling status.

Go debug

Obtaining the Monitoring System Configuration

hcloud CAE ShowMonitorSystem

Obtain the monitoring system configuration.

Go debug

Creating the Monitoring System Configuration

hcloud CAE CreateMonitorSystem

This API is used to create the monitoring system configuration.

Go debug

Updating the Monitoring System Configuration

hcloud CAE UpdateMonitorSystem

Update the monitoring system configuration.

Go debug

Obtaining the Configuration for the CAE Environment to Access the VPC

hcloud CAE ListVpcEgress

Obtain the configuration for the CAE environment to access the VPC.

Go debug

Creating the Configuration for the CAE Environment to Access the VPC

hcloud CAE CreateVpcEgress

This API is used to create the configuration for the CAE environment to access the VPC.

Go debug

Deleting the Configuration for the CAE Environment to Access VPC

hcloud CAE DeleteVpcEgress

Delete the configuration for the CAE environment to access the VPC.

Go debug

Creating an Event Notification Rule

hcloud CAE CreateNoticeRule

This API is used to create an event notification rule.

Go debug

Querying the Event Notification Rule List

hcloud CAE ListNoticeRules

Query the event notification rule list.

Go debug

Modifying an Event Notification Rule

hcloud CAE UpdateNoticeRule

Modify an event notification rule.

Go debug

Viewing an Event Notification Rule

hcloud CAE ShowNoticeRule

Viewing an Event Notification Rule

Go debug

Deleting an Event Notification Rule

hcloud CAE DeleteNoticeRule

Delete an event notification rule.

Go debug

Associating a Secret Registered by the Tenant

hcloud CAE CreateSecret

This API is used to associate a secret registered by the tenant.

Go debug

Obtaining User Secrets

hcloud CAE ListSecrets

Obtain user secrets.

Go debug

Modifying the Version of a Secret Registered with DEW

hcloud CAE UpdateSecret

Modify the version of a secret registered with DEW.

Go debug

Deleting a Secret Registered with DEW

hcloud CAE DeleteSecret

Delete a secret registered with DEW.

Go debug

Obtaining the Components That Are Using a Specific Secret

hcloud CAE ListEffectiveComponents

Obtain the components that are using a specific secret.

Go debug