Updated on 2023-09-11 GMT+08:00

API Overview

Table 1 CodeArts Deploy API Overview

Type

API

Description

Host cluster management

Creating a Host Cluster (Recommended)

Creates a host cluster in a project.

Querying a Host Cluster List (Recommended)

Queries the host cluster list based on conditions.

Deleting a Host Cluster

Deletes a host cluster by ID.

Querying a Host Cluster (Recommended)

Queries details about a host cluster by ID.

Modifying a Host Cluster

Modifies host cluster information by ID.

Host management

Creating a Host (Recommended)

Creates a host in a specified host cluster.

Querying a Host List (Recommended)

Queries the host list in a specified host cluster by ID.

Querying Host Details (Recommended)

Queries host details by host ID.

Modifying a Host

Modifies host information by host ID.

Deleting a Host

Deletes a host by ID.

Application management

Obtaining an Application List (Recommended)

Queries the application list in a project.

Creating an Application (Recommended)

Creates an application using a template.

Deploying an Application

Deploys an application by deployment task ID.

Obtaining Application Details (Recommended)

Obtains application details by deployment task ID.

Deleting an Application (Recommended)

Deletes an application by deployment task ID.

Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time

Queries the historical deployment records of a specified application in a project based on the start time and end time.

Execution record measurement

Obtaining the Success Rate of Deployed Applications in a Specified Project

Obtains the success rate of deployed applications in a specified project.

Obtaining the Success Rate of Deployed Applications in a Specified Application

Obtains the execution success rate of deployed applications in a specified task.

Environment management

Creating an Environment Under an Application

Creates an environment in the target application.

Querying the Environment List of an Application

Queries the environment list of a target application.

Deleting an Environment from an Application

Deletes a target environment of an application.

Querying the Details of an Environment

Queries details about a target environment of an application.

Importing a Host in the Environment

Imports a host to a target environment.

Deleting a Host from an Environment

Deletes a host from a target environment.