- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- CodeArts Pipeline Usage
- Enabling and Authorizing CodeArts Pipeline
- Accessing CodeArts Pipeline
- Creating a Pipeline
- Configuring a Pipeline
- Grouping Pipelines
- Executing a Pipeline
- Checking a Pipeline
- Checking the Dashboard
- Configuring a Change-triggered Pipeline
- Managing Pipeline Extensions
- Creating Service Endpoints
- Checking Audit Logs
- Reference
- CodeArts Release User Guide
-
Best Practices
- CodeArts Pipeline Best Practices
- Fixing a Bug for Quick Release Through a Change-triggered Pipeline
- Configuring Pass Conditions for Automated Code Checks
- Transferring CodeArts Pipeline Parameters to CodeArts Build and CodeArts Deploy
- Creating a Repository Tag Using the Pipeline Contexts
- HE2E DevOps Practice: Configuring a Pipeline
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
API
- Template Management
-
Pipeline Management
- Starting a Pipeline
- Obtaining Pipeline Statuses in Batches
- Obtaining Pipeline Status/Obtaining Pipeline Execution Details
- Obtaining Pipeline List/Pipeline Execution Status in a Project
- Deleting a Pipeline
- Querying Pipeline Details
- Editing a Pipeline
- Stopping a Pipeline
- Obtaining Pipeline Execution Records
- Creating a Pipeline With a Template
- Creating a Pipeline
- Retrying a Pipeline
- Passing Manual Review
- Obtaining Custom Parameters Required for Pipeline Running
- Rejecting Manual Review
- Querying Pipeline Logs
- Obtaining the Pipeline Step Execution Output
- Querying Build Products on a Pipeline
- Deleting Pipelines in Batches
- Disabling a Pipeline
- Setting Pipeline Tags in Batches
- Enabling a Pipeline
- Executing Pipelines in Batches
- Querying Pipeline Job Logs
- Passing a Delayed Execution Job
- Rejecting a Delayed Execution Job
- Delaying the Execution for One Hour
- Passing the Manual Check Point
- Rejecting the Manual Check Point
- Resuming a Pipeline
- Querying the Batch Pipeline Execution Result
- Switching Group Sequence
- Querying CodeArts Pipeline Notifications
- Updating CodeArts Pipeline notifications
- Enabling or Disabling CodeArts Pipeline Notifications
- Querying Third-Party Pipeline Notifications
- Updating Third-Party Pipeline Notifications
- Querying Pipeline Role Permissions
- Querying Pipeline User Permissions
- Modifying Pipeline Role Permissions
- Modifying Pipeline User Permissions
- Querying Whether Pipeline Resource-Level Permission Is Enabled
- Updating Pipeline Resource-Level Permissions Status
- Setting Pipeline Resource-Level Permissions for Different Roles
- Canceling a Pipeline Queuing
- Querying Queuing Records in the Current Pipeline
- Querying the Running Records of a Pipeline of the Old Version
- Querying Parameters Used in a Pipeline
- Rolling Back the Pipeline Execution
- Obtaining the Step Redirection Link
- Querying the Running Changes in a Pipeline
- Querying Available Predefined Parameters
- Querying Pipeline Triggering Failure Records
- Querying the Pipeline Editing History
- Creating a Parameter Group
- Editing a Parameter Group
- Deleting a Parameter Group
- Associating a Pipeline with a Parameter Group
- Querying Details About a Parameter Group
- Querying Parameter Groups Associated with a Pipeline
- Querying the Parameter Group List
- Obtaining Webhook Information
- Group Management
- Rule Management
- Tenant-Level Policy Management
- Project-Level Policy Management
-
Extension Management
- Creating an Extension Version
- Creating an Extension Draft Version
- Creating a Publisher
- Updating an Extension Draft
- Publishing an Extension Draft
- Updating Basic Information of an Extension
- Publishing an Extension
- Binding an Extension to a Publisher
- Updating the Extension Icon
- Updating the Publisher Icon
- Deleting an Extension Draft
- Querying the Publisher List
- Querying the Available Publisher
- Querying the Available Extension List
- Querying the Basic Extension List
- Querying the Available Extensions by Page
- Querying the Extension List
- Querying Extension Indicator Configuration
- Query Extension Input Configuration
- Query Extension Output Configuration
- Querying All Versions of an Extension
- Querying Extension Version Details
- Querying the Extension Version
- Deleting a Publisher
- Querying Publisher Details
- Creating a Basic Extension
- Updating a Basic Extension
- Deleting a Basic Extension
- Uploading a Basic Extension
- Querying the Basic Extension Details
- Endpoint Management
- Pipeline Tag Management
-
Change Management
- Create a Change
- Querying the Change Details
- Modifying the Change Status
- Modifying the Code Repository of a Change
- Querying the Change List
- Querying Changes in a Pipeline
- Querying Changes Being Released
- Querying the Change Operation History
- Querying Change Creator Information in a Project
- Querying Work Items Associated with a Change
- Updating Work Items Associated with a Change
- Microservice Management
- Template Management (Old Version, Unavailable Soon)
-
Pipeline Management (Old Version, Unavailable Soon)
- Quickly Creating a Pipeline and Jobs with a Template
- Checking the Pipeline Creation Status
- Starting a Pipeline
- Stopping a Pipeline
- Obtaining Pipeline Statuses in Batches
- Deleting a Pipeline
- Obtaining the Pipeline List
- Obtaining the Pipeline Status
- Obtaining the Pipeline Execution Status in a Project
- Application Examples
- Appendixes
- Change History
-
FAQs
- Functions
-
Troubleshooting
- Pipeline Fails to Run Because Repository Not Found
- Pipeline Fails to Run Because the Test Suite Is Already in Progress
- Pipeline Fails to Run Because Job Not Found
- Pipeline Is Not Triggered at a Specified Time
- Execution Button Is Unavailable
- Inappropriate Reviewer Configured for the Manual Review Job
- Subpipeline Not Found
- Change-triggered Pipeline Fails to Run and an Error Message Is Returned: "authentication required"
- Pipeline Fails to Run Because Deployment Policy Not Found
- Videos
- General Reference
Copied.
Before You Start
Welcome to CodeArts Pipeline. CodeArts Pipeline provides visual, customizable pipelines to shorten the delivery period and improve efficiency.
This document describes how to use APIs to perform operations on pipelines, such as starting and stopping pipelines. For details about all supported operations, see API Overview.
Before calling CodeArts Pipeline APIs, ensure that you are familiar with CodeArts Pipeline concepts. For details, see Service Overview.
CodeArts Pipeline supports Representational State Transfer (REST) APIs that can be called using HTTPS. For details, see Calling APIs.
Endpoints
An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.
Table 1 lists the CodeArts Pipeline endpoints.
|
Region Name |
Region |
Endpoint |
Protocol |
|---|---|---|---|
|
LA-Mexico City2 |
la-north-2 |
devcloud.la-north-2.myhuaweicloud.com |
HTTPS |
|
LA-Sao Paulo1 |
sa-brazil-1 |
devcloud.sa-brazil-1.myhuaweicloud.com |
HTTPS |
|
AP-Singapore |
ap-southeast-3 |
devcloud.ap-southeast-3.myhuaweicloud.com |
HTTPS |
|
TR-Istanbul |
tr-west-1 |
pipeline-external.tr-west-1.myhuaweicloud.com |
HTTPS |
|
LA-Santiago |
la-south-2 |
pipeline-external.la-south-2.myhuaweicloud.com |
HTTPS |
Concepts
- Account
An account is created upon successful registration with Huawei Cloud. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create IAM users and grant them permissions for routine management.
- User
An identity and access management (IAM) user is created using an account to use cloud services. Each IAM user has their own identity credentials (password and access keys).
An IAM user can view the account ID and user ID on the My Credentials page of the console. The account, username, and password are required for API authentication.
- Region
Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region.
Regions are classified into universal regions and dedicated regions.
- A universal region provides universal cloud services for common tenants.
- A dedicated region provides particular services for specific tenants.
For details, see Region and AZ.
- Availability zone
An availability zone (AZ) contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability (HA) systems.
- Project
Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project.
For more refined access control, create subprojects under a project and purchase resources in the subprojects. Then you can assign required permissions for users to access only resources in specific subprojects.
- Enterprise project
An enterprise project groups and manages enterprise resources in a logically isolated manner. It contains resources in multiple regions, and allows resources to be added or removed.
For details about how to obtain enterprise project IDs and features, see Enterprise Management User Guide.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
