Updated on 2024-10-09 GMT+08:00

API Overview

Table 1 CodeArts Deploy API Overview

Type

API

Description

Host cluster management

Create a host cluster

This API is used to create a host cluster in a project.

Create a host cluster (recommended)

This API is used to create a host cluster in a project.

Query a host cluster list

This API is used to query a host cluster list based on conditions.

Query a host cluster list (recommended)

This API is used to query a host cluster list based on conditions.

Delete a host cluster

This API is used to delete a host cluster by ID.

Query a host cluster

This API is used to query details about a host cluster by ID.

Query a host cluster (recommended)

This API is used to query details about a host cluster by ID.

Modify a host cluster

This API is used to modify host cluster information by ID.

Host management

Create a host

This API is used to create a host in a specified host cluster.

Create a host (recommended)

This API is used to create a host in a specified host cluster.

Query a host list

This API is used to query a host list in a specified host cluster by ID.

Query a host list (recommended)

This API is used to query a host list in a specified host cluster by ID.

Query host details

This API is used to query host details by host ID.

Query host details (recommended)

This API is used to query host details by host ID.

Modify a host

This API is used to modify host information by host ID.

Delete a host

This API is used to delete a host by ID.

Application management

Obtain an application list

This API is used to query the application list in a project.

Obtain an application list (recommended)

This API is used to query the application list in a project.

Create an application using a template

This API is used to create an application using a template.

Create an application (recommended)

This API is used to create an application.

Deploy an application

This API is used to deploy an application by deployment task ID.

Obtain application details

This API is used to obtain application details by deployment task ID.

Obtain application details (recommended)

This API is used to obtain application details of a specified ID.

Delete an application

This API is used to delete an application by deployment task ID.

Delete an application (recommended)

This API is used to delete an application of a specified ID.

Query the historical deployment records of a specified application in a project by the start time and end time

This API is used to query the historical deployment records of a specified application in a project based on the start time and end time.

Query the execution parameters of a deployment record

This API is used to query the execution parameters of a deployment record.

Deployment record measurement

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

This API is used to obtain the success rate of deployed applications in a specified project.

This API is used to obtain the success rate of deployed applications in a specified application.

This API is used to obtain the success rate of deployed applications in a specified application.

Environment management

Create an environment for an application

This API is used to create an environment for an application.

Query the environment list of an application

This API is used to query the environment list of an application.

Delete an environment from an application

This API is used to delete an environment of an application.

Query environment details

This API is used to query environment details.

Import a host in an environment

This API is used to import a host in an environment.

Delete a host from an environment

This API is used to delete a host of an environment.