Updated on 2025-02-14 GMT+08:00

API Overview

CAE provides self-developed APIs that comply with API design specifications.

Environment APIs

Table 1 Environment APIs

API

Description

Obtaining the Environment List

Obtain the environment list of the current project.

Creating an Environment

Create an environment.

Deleting an Environment

Delete an environment.

Volume APIs

Table 2 Volume APIs

API

Description

Obtaining the Cloud Storage List

Obtain the volume list in the current environment.

Authorizing Cloud Storage

Create a volume.

Unbinding Cloud Storage

Delete a volume.

Application APIs

Table 3 Application APIs

API

Description

Obtaining the Application List

Obtain the application list in the current environment.

Creating an Application

Create an application.

Obtaining the Details of an Application

Obtain an application.

Deleting an Application

Delete an application.

Component APIs

Table 4 Component APIs

API

Description

Creating a Component

Create a component.

Obtaining the Component List

Obtain the component list of an application in the current environment.

Obtaining the Details of a Component

Obtain a component.

Updating a Component

Update a component.

Deleting a Component

Delete a component.

Performing Operations on a Component

Perform operations on a component, such as deploying, upgrading, configuring, rolling back, restarting, and stopping a component.

Obtaining the Component Snapshot List

Obtain the snapshot list of a component.

Obtaining the Component Instance List

Obtain the component instance list.

Component Configuration APIs

Table 5 Component configuration APIs

API

Description

Obtaining the Component Configuration List

Obtain the component configuration list.

Adding Component Configuration

Create a component configuration.

Deleting Component Configuration

Delete a component configuration.

Agency APIs

Table 6 Agency APIs

API

Description

Obtaining the Agency List

Obtain the agency list of the current user.

Creating an Agency

Create an agency.

Job APIs

Table 7 Job APIs

API

Description

Obtaining the Details of a Job

Obtain a job.

Retrying a Job

Retry a job.

Domain Name APIs

Table 8 Domain name APIs

API

Description

Obtaining the Domain Name List

Obtain the domain name list.

Adding a Domain Name

Create a domain name.

Deleting a Domain Name

Delete a domain name.

Certificate APIs

Table 9 Certificate APIs

API

Description

Obtaining the Certificate List

Obtain the certificate list.

Creating a Certificate

Create a certificate.

Modifying a Certificate

Modify a certificate.

Deleting a Certificate

Delete a certificate.

Start/Stop Policy APIs

Table 10 Start/Stop policy APIs

API

Description

Obtaining the Scheduled Start/Stop Policy List

Obtain the list of scheduled start/stop policies.

Creating a Scheduled Start/Stop Policy

Create a scheduled start/stop policy.

Deleting a Scheduled Start/Stop Policy

Delete a scheduled start/stop policy.

Modifying a Scheduled Start/Stop Policy

Modify a scheduled start/stop policy.

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

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

EIP APIs

Table 11 EIP APIs

API

Description

Obtaining the EIP List of Cluster Nodes

Obtain the EIP list of nodes in a cluster.

Modifying Bandwidth

Modify a bandwidth.

Monitoring System APIs

Table 12 Monitoring system APIs

API

Description

Obtaining Monitoring System Configurations

Obtain monitoring system configurations.

Creating Monitoring System Configurations

Create monitoring system configurations.

Updating Monitoring System Configurations

Update monitoring system configurations.

Secret APIs

Table 13 Secret APIs

API

Description

Associating a Secret Registered by the Tenant

Associate a secret registered by the tenant.

Obtaining User Secrets

Obtain user secrets.

Modifying the Version of a Secret Registered with DEW

Modify the version of a secret registered with DEW.

Deleting a Secret Registered with DEW

Delete a secret registered with DEW.

Obtaining the Components That Are Using a Specific Secret

Obtain the components that are using a specific secret.