CodeArts Deploy
CodeArts Deploy
- What's New
- Service Overview
- Getting Started
-
User Guide
- Overview
- Managing Basic Resources
-
Managing Applications
- Creating an Application
- Editing an Application
- Deploying an Application
- Viewing an Application
- Managing Groups
- Following/Cloning/Deleting Applications
-
Deployment Actions
- Health Test via URLs
- Selecting a Deployment Source
- Stopping a Service
- Copying a File
- Deleting a File
- Decompressing a File
- Modifying a Configuration File
- Starting or Stopping Tomcat
- Starting or Stopping Spring Boot
- Starting or Stopping Nginx
- Starting or Stopping IIS
- Starting or Stopping Node.js
- Starting or Stopping the Go service
- Running Shell Commands
- Running Shell Scripts
- Running PowerShell Commands
- Running PowerShell Scripts
- Running Docker Commands
- Wait
- Deploying on Kubernetes
- Deploying an Application in Kubernetes (CCE Cluster) Using Manifest
- Deploying an Application in Kubernetes (CCE Cluster) Quickly
- Deploying an Application with a Custom Kubernetes Cluster
- Kubernetes Nginx-Ingress Grayscale Deployment (CCE Cluster)
- Deploying with Helm3
- Ansible
- Creating IIS Site
- Installing IIS
- Installing JDK
- Installing Tomcat
- Installing Nginx
- Installing Go
- Installing PHP
- Installing Node.js
- Installing Python
- Installing/Uninstalling Docker
- Istio Gray Release
- Deploying to FunctionGraph
- FunctionGraph Grayscale Release
-
Managing Orchestration Templates
- Background
-
System Templates
- Deploying to FunctionGraph
- Deploying a Tomcat Application
- Deploying a Spring Boot Application
- Deploying a Docker Application (Linux)
- Deploying a Django Application
- Deploying a Node.js Application
- Deploying a General Application
- Deploying an Application in Kubernetes (CCE Cluster) Using Manifest
- Deploying an Application in Kubernetes (CCE Cluster) Quickly
- Deploying an Application with a Custom Kubernetes Cluster
- Deploying a Go Application
- Custom Templates
- Managing Parameters
- Managing Permissions
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
-
Managing Host Clusters
- Creating a Host Cluster (Recommended)
- Querying a Host Cluster List (Recommended)
- Querying a Host Cluster (Recommended)
- Editing a Host Cluster
- Deleting a Host Cluster (Recommended)
- Querying Information About the Environment Associated with a Host Cluster
- Querying the Basic Environment Information List of an Application
- Managing Hosts
-
Managing Applications
- Obtaining an Application List
- Deploying an Application
- Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time
- Obtaining an Application List (Recommended)
- Creating an Application (Recommended)
- Updating an Application
- Obtaining Application Details (Recommended)
- Deleting an Application (Recommended)
- Querying the Execution Parameters of a Deployment Record
- Cloning an Application
- Deleting Applications from a Project in Batches
- Checking Whether an Application with the Same Name Exists in a Project
- Disabling and Enabling an Application
- Managing Application Groups
- Managing Application Permissions
- Measuring Deployment Record
-
Managing Environments
- Creating an Environment for an Application
- Querying an Environment List of an Application
- Editing an Environment in an Application
- Deleting an Environment from an Application
- Querying Environment Details
- Importing a Host to an Environment
- Deleting a Host from an Environment
- Querying a Host List in an Environment
- Managing Host Cluster Permissions
- Managing Environment Permissions
-
Managing Host Clusters
- Application Examples
- Appendixes
-
FAQs
-
Host Management
- What Are the Troubleshooting Methods for Host and Proxy Connectivity Verification Failures
- What Should I Do If Application Deployment Fails with "tomcat | Download War in url path" Displayed in Logs?
- Why Does a Task Fail on an Ubuntu Host After Being Successfully Run on a CentOS Host?
- What Should I Do If the No Host or Environment Whose Connectivity Has Been Verified?
- What Are Possible Causes of a Host verification failure?
- What Should I Do If the Connection Times Out Occasionally During a Deployment on a Windows Host?
-
Application Deployment
- What Should I Do If a Draft Application Cannot Be Deployed?
- What Are Error Messages Displayed During Application Deployment?
- How Do I Find the Cause of an Application Deployment Error in Logs?
- What Should I Do If Application Deployment Fails, with the Message "AnsibleUndefinedVariable: 'xxxx' is undefined" Displayed?
- What Should I Do If Application Deployment Fails Due to a DNS Resolution Error?
- What Should I Do If JDK Has Been Installed and Environment Variables Have Been Configured, But Application Deployment Fails with the Error Message "please configure JDK environment variables" Displayed?
- What Should I Do If Error 403 Is Displayed During Application Deployment That Requires CCE Resources?
- How Do I Roll Back a Deployed Version?
- What Should I Do If an Application Deployment Times Out?
- Does CodeArts Deploy Provide Batch and Incremental Deployment Policies?
- Do I Need to Upload a Software Package to CodeArts Artifact Before Deployment?
- Can I Deploy Web Pages Written in HTML or JS?
- How Do I Upload an Image for Container Deployment?
- What Should I Do If Application Deployment Succeeds But the Application Verification URL Cannot Be Accessed?
- What Should I Do If Squid Fails to Be Started?
-
Common FAQs
- Can I Use a Host to Deploy Multiple Projects?
- Do I Need to Install a Running Environment (Tomcat, Python) on the Target Host Before Deploying an Application?
- What Should I Do If the Log Indicating Insufficient Permissions Is Displayed?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should I Do If the File Path Does Not Exist?
- What Should I Do If the System Displays a Message Indicating That No Hosts Are Found in the Environment?
- What Should I Do If the Log Contains "The file or file path does not exist"?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If I Have Insufficient Permissions?
- What Should I Do If the Action "Create and Start Container" Fails on Ubuntu 22 OS When Using Template "Deploy a Docker Application for Linux"?
-
Software Installation Actions
-
Installing IIS
- Host Not Restarted
- How Should I Check the IIS Function on the Local Host?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Installing JDK
- What Should I Do If the Log "The JDK of the Same Version Has Been Installed on the Target Host" Is Displayed?
- What Should I Do If the Java Environment Is Not Installed on the Host?
- What Should I Do If the JDK Decompression Error Is Displayed?
- What Should I Do If OpenJDK 8 Cannot Be Installed on Ubuntu 14 or Earlier Versions?
- What Should I Do If the Deployment Result Is "Openjdk does not support arm"?
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Tomcat
- Deployment Failure
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Nginx
- No sudo Permissions
- No Permission to Access the Path
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Go
- Invalid Installation Path
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing PHP
- Error Returned When Installing PHP as a Common User
- Some Dependency Packages Do Not Exist in the CentOS Yum Repository
- Download Fails Due to Network Disconnection from the CentOS Yum Source
- Download Fails Because Some Software Dependency Packages Are Missing for apt-get in Ubuntu
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Node.js
- Cannot Decompress Node Packages
- Installation Path Fails to Be Created
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Python
- No sudo Permissions
- No Permission to Access the Path
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing/Uninstalling Docker
- Error Returned During the Deployment of the Action for Installing or Uninstalling Docker as a Common User
- Error Returned Even Though the Action for Installing or Uninstalling Docker Is Successfully Deployed
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing IIS
-
Container-based Deployment Actions
-
FAQs About Kubernetes Deployment Tasks
- Parameter Referenced by {{}} in the Manifest File Is Not Defined in the Application
- Target File Does Not Exist in CodeArts Artifact
- Path of the Manifest File in CodeArts Artifact Is Incorrect
- kubeconfig File Is Incorrectly Configured
- kubectl Command Fails to Be Deployed
- Failed to Deploy Applications on Kubernetes
- Log Contains "Too many files to unzip" When CodeArts Repo Is Selected as the Manifest File Source During Kubernetes Deployment
- Error Message "File is too large" Displayed During Manifest File Source Selection for Kubernetes Deployment
-
FAQs About Kubernetes Deployment Tasks
-
Stopping or Starting Deployment Actions
-
Stopping a Service
- Incorrect Port Number
- Action Stop Service Deployed Successfully, But the Service Is Still in Started State
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting or Stopping Tomcat
- Invalid Tomcat Path
- Stopping Failed
- Startup Failed
- Environment Variables Are Not Configured
- Service Is Not Started Despite Successful Action Deployment
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting/Stopping Go Service
- The Go Service Path Is Incorrect
- Startup Failed
- Deployment Is Successful, But the Service Is Not Started
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- No Host in the
- Does Not Exist
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting or Stopping Spring Boot
- Start/Stop Spring Boot
- Invalid Spring Boot Path
- Startup Failed
- Environment Variables Are Not Configured
- Service Is Not Started Despite Successful Action Deployment
- Spring Boot Can Still Be Detected After Being Stopped (on Windows)
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting or Stopping Nginx
- Nginx Gets Restarted Repeatedly
- Invalid Windows Host Path
- Deploying the Command for Stopping Nginx When Nginx Is Not Started
- Incorrect Format of the Nginx Configuration File
- Configuration File Backup Path Does Not Exist
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
-
Starting or Stopping IIS
- Startup or Stopping Failed
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Starting or Stopping Node.js
- Node.js Fails to Be Started or Stopped on a Linux Host
- Node.js Fails to Be Started or Stopped on a Windows Host
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Stopping a Service
-
File Operation Deployment Actions
-
Copying a File
- File to Be Copied Does Not Exist
- Invalid File Path
- File or File Path Does Not Exist
- Action Copy Files Deployed Successfully, But the Expected Result Is Not Achieved
- Insufficient Permissions
- Log Contains "copy File Failed" When Copying Files Between Linux Environment
- Log Contains "Windows does not support copying files between hosts" When Copying Files Between Windows Environment
- Log Contains "Hosts using secret key credit do not support copying files between" When Copying Files Between Environment
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Decompressing a File
- File to Be Decompressed Does Not Exist
- Backslashes (\) Are Used as Path Separators in the Native Command Compress-Archive
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Deleting a File
- Cannot Delete Files on a Linux Host
- File Path Does Not Exist on a Windows Host
- Incorrect File Path on a Windows Host
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Modifying a Configuration File
- File Path Does Not Exist
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Copying a File
-
Command Execution for Deployment Actions
-
Running Shell Commands
- A Message Indicating an Operation Failure Is Displayed
- Service Is Not Started But the Log Shows That Shell Commands Are Successfully Executed
- Unidentified Shell Commands Are Used
- Shell Command References a File or Folder That Does Not Exist
- How Does a Shell Command Reference Parameters?
- Deployment of the Action Run Shell Commands Times Out
- Interactive Shell Commands Are Used
- Shell Command Deployment Times Out After the su Command Is Executed to Switch the User
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
- Other FAQs
-
Running Shell Scripts
- Running Shell Scripts Failed
- Deployment Is Successful But Does Not Achieve the Expected Result
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Running PowerShell Commands
- Deployment of the Action Run PowerShell Commands Times Out
- Unidentified PowerShell Commands Are Used
- PowerShell Command References a File or Folder That Does Not Exist
- How Does a PowerShell Command Reference Parameters?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Running PowerShell Scripts
- Running PowerShell Scripts Failed
- Deployment Is Successful But Does Not Achieve the Expected Result
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Running Docker Commands
- What Should I Do If Docker Is Not Installed?
- What Should I Do If Parameters Are Incorrect?
- What Should I Do If I Do Not Have the Deployment Permissions?
- What Should I Do If the Image Does Not Exist?
- What Should I Do If the login Command Fails to Be Executed?
- What Should I Do If the build Command Fails to Be Executed?
- What Should I Do If the tag Command Fails to Be Executed?
- What Should I Do If the push Command Fails to Be Executed?
- What Should I Do If the run Command Fails to Be Executed?
- What Should I Do If the Commands (start, restart, stop, and rm) Fail to Be Executed?
- What Should I Do If the rmi Command Fails to Be Executed?
- What Should I Do If the pull Command Fails to Be Executed?
- What Should I Do If the Error Message You cannot remove a running container Is Displayed When the rm Command Is Executed?
- What Should I Do If the Network Connection Times Out?
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Running Shell Commands
-
Other Deployment Actions
-
Health Test via URLs
- Incorrect URL
- URL Does Not Exist
- Invalid URL
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Selecting Deployment Sources
- Software Package Not Found in CodeArts Artifact
- No Software Package Available for a Build Task
- URL Domain Name Resolution Failure
- File Download Times Out
- Inconsistent SHA256 Values in a File
- Inconsistent MD5 Values in a File
- Error "More than 100 build files"
- "HTTP Error 403" Is Displayed When the CodeArts Artifact Software Package Is Downloaded
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Pending Execution
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Ansible
- Invalid Entry File Path
- Entry File Not Found
- Copy Module Error
- Service Module in Playbook Scripts Fails to Start or Stop Services
- Ansible Application Deployment Fails
- What Should I Do When the "Do not use the delegate_to, connection, hosts command in the Ansible PlayBook script for executing the local computer" message Is displayed When Running Ansible?
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Creating an IIS Site
- Port Error
- Physical Path of an Application Does Not Exist
- IIS Not Installed on the Host
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- How Should I Check the IIS Function on the Local Host?
-
Health Test via URLs
-
Host Management
On this page
Help Center/
CodeArts Deploy/
API Reference/
APIs/
Measuring Deployment Record/
Obtaining the Application Deployment Success Rate in a Specified Project
Obtaining the Application Deployment Success Rate in a Specified Project
Updated on 2025-05-27 GMT+08:00
Function
This API is used to obtain the application deployment success rate in a specified project.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/metrics/success-rate
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see [Obtaining a Project ID] (CloudDeploy_api_0014.xml). Constraints: N/A Value range: The value consists of 32 characters. Only letters and digits are allowed. Default value: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
start_date |
Yes |
String |
Parameter description: Left boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-01-01. Constraints: This parameter is used together with end_date. The value of end_date must be later than or equal to the value of start_date. The maximum time range is one year. Value range: N/A Default value: N/A |
|
end_date |
Yes |
String |
Parameter description: Right boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-10-26. Constraints: This parameter is used together with start_date. The value of end_date must be later than or equal to the value of start_date. The maximum time range is one year. Value range: N/A Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
success_rate |
String |
Parameter description: Success rate. Value range: N/A |
|
project_id |
String |
Parameter description: Project ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
|
project_name |
String |
Parameter description: Project name. Value range: The value consists of 3 to 128 characters. |
|
start_date |
String |
Parameter description: Left boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-10-26. Value range: N/A |
|
end_date |
String |
Parameter description: Right boundary (included) of the application deployment start time range. The value format is yyyy-MM-dd. For example, 2022-10-26. Value range: N/A |
|
task_count |
Integer |
Parameter description: Number of queried applications. Value range: N/A |
|
record_count |
Integer |
Parameter description: Number of queried application deployment records. Value range: N/A |
|
success_record_count |
Integer |
Parameter description: Number of successful application deployment records. Value range: N/A |
Example Requests
This API is used to obtain the deployment success rate of the target application in a specified period.
https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/metrics/success-rate?start_date=2022-01-01&end_date=2022-10-26Example Responses
Status code: 200
OK: The request is successful.
{
"success_rate" : "34.09",
"project_id" : "89931e210b214b5892ea833712f0f5e0",
"project_name" : "Happy",
"start_date" : "2022-01-01",
"end_date" : "2022-10-26",
"task_count" : 8,
"record_count" : 44,
"success_record_count" : 15
}Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK: The request is successful. |
Error Codes
See Error Codes.
Parent topic: Measuring Deployment Record
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
The system is busy. Please try again later.
