CLI Command Reference
Pipeline Template Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Template List | hcloud CodeArtsPipeline ListTemplates | This interface is used to query the template list. Pagination query is supported. Fuzzy query by template name is supported. | |
| Querying Template Details | hcloud CodeArtsPipeline ShowTemplateDetail | Querying Template Details |
Pipeline Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Quickly Creating Pipelines and Tasks in Pipelines Based on Templates | hcloud CodeArtsPipeline CreatePipelineByTemplate | Quickly Creating Pipelines and Tasks in Pipelines Based on Templates | |
| Checking the Pipeline Creation Status | hcloud CodeArtsPipeline ShowInstanceStatus | Checking the Pipeline Creation Status | |
| Execute Pipeline | hcloud CodeArtsPipeline StartNewPipeline | Execute Pipeline | |
| Stopping a Pipeline | hcloud CodeArtsPipeline StopPipelineNew | Stopping a Pipeline | |
| Obtaining Pipeline Status in Batches | hcloud CodeArtsPipeline BatchShowPipelinesStatus | Obtaining Pipeline Status and Phase Information in Batches | |
| Deleting a Pipeline | hcloud CodeArtsPipeline RemovePipeline | Deletes a pipeline based on the pipeline ID. | |
| Obtaining the Pipeline List | hcloud CodeArtsPipeline ListPipelineSimpleInfo | API for Obtaining the Pipeline List | |
| Obtaining the Pipeline Status | hcloud CodeArtsPipeline ShowPipleineStatus | Obtains the pipeline status, phase, and task information. | |
| Obtaining the Pipeline Execution Status of a Project | hcloud CodeArtsPipeline ListPipleineBuildResult | Obtaining the Pipeline Execution Status of a Project | |
| Querying pipeline details | hcloud CodeArtsPipeline ShowPipelineDetail | Querying pipeline details | |
| Update pipeline info | hcloud CodeArtsPipeline UpdatePipelineInfo | Update pipeline info | |
| Deleting the Running Details of a GitCode Pipeline | hcloud CodeArtsPipeline DeleteActionsRunPipeline | This API is used to delete the running details of a GitCode pipeline. |
Pipeline Management - New
| API Name | Command | Description | Operation |
|---|---|---|---|
| Execute Pipeline | hcloud CodeArtsPipeline RunPipeline | Execute Pipeline | |
| Create Pipeline | hcloud CodeArtsPipeline CreatePipelineNew | Create Pipeline | |
| Retry Run Pipeline | hcloud CodeArtsPipeline RetryPipelineRun | Retry Run Pipeline | |
| Accept Manual Review | hcloud CodeArtsPipeline AcceptManualReview | Accept Manual Review | |
| Reject Manual Review | hcloud CodeArtsPipeline RejectManualReview | Reject Manual Review | |
| Obtaining Pipeline Status in Batches | hcloud CodeArtsPipeline BatchShowPipelinesLatestStatus | This interface is used to obtain pipeline status in batches. Only pipeline data with execution records is returned. | |
| Obtaining the Pipeline Status/Obtaining Pipeline Execution Details | hcloud CodeArtsPipeline ShowPipelineRunDetail | This interface is used to obtain the pipeline status or pipeline execution details. Only the pipeline data with execution records is returned. | |
| Obtaining the Pipeline List/Obtaining the Pipeline Execution Status of a Project | hcloud CodeArtsPipeline ListPipelines | Obtaining the Pipeline List/Obtaining the Pipeline Execution Status of a Project | |
| Deleting a Pipeline | hcloud CodeArtsPipeline DeletePipeline | Deleting a Pipeline | |
| Stopping a Pipeline | hcloud CodeArtsPipeline StopPipelineRun | Stopping a Pipeline | |
| Obtaining Pipeline Execution Records | hcloud CodeArtsPipeline ListPipelineRuns | Obtaining Pipeline Execution Records | |
| Create Pipeline Template | hcloud CodeArtsPipeline CreatePipelineTemplate | Create Pipeline Template | |
| Creating a Pipeline Using a Template | hcloud CodeArtsPipeline CreatePipelineByTemplateId | Creating a Pipeline Using a Template | |
| Query pipeline logs | hcloud CodeArtsPipeline ShowPipelineLog | Query pipeline logs | |
| Show pipeline step execution outputs. | hcloud CodeArtsPipeline ShowStepOutputs | Show pipeline step execution outputs. | |
| Show pipeline artifacts | hcloud CodeArtsPipeline ShowPipelineArtifacts | Show pipeline artifacts |
Pipeline Template Management - New
| API Name | Command | Description | Operation |
|---|---|---|---|
| Listing Templates | hcloud CodeArtsPipeline ListPipelineTemplates | Querying the Pipeline Template List | |
| Querying Template Details | hcloud CodeArtsPipeline ShowPipelineTemplateDetail | Querying Template Details | |
| Update Pipeline Template | hcloud CodeArtsPipeline UpdatePipelineTemplate | Updating a Pipeline Template | |
| Delete Pipeline Template | hcloud CodeArtsPipeline DeletePipelineTemplate | Delete Pipeline Template |
Pipeline Group Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Pipeline Group | hcloud CodeArtsPipeline CreatePipelineGroup | Create Pipeline Group | |
| Update Pipeline Group | hcloud CodeArtsPipeline UpdatePipelineGroup | Update Pipeline Group | |
| Delete Pipeline Group | hcloud CodeArtsPipeline DeletePipelineGroup | Delete Pipeline Group | |
| Show Pipeline Group Tree | hcloud CodeArtsPipeline ShowPipelineGroupTree | Show Pipeline Group Tree | |
| Batch Move Pipeline To Group | hcloud CodeArtsPipeline BatchMovePipelineToGroup | Batch Move Pipeline To Group |
Rule Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Show Rule Detail | hcloud CodeArtsPipeline ShowRule | Show Rule Detail | |
| List Rule | hcloud CodeArtsPipeline ListRule | List Rule | |
| Update Rule | hcloud CodeArtsPipeline UpdateRule | Update Rule | |
| Delete Rule | hcloud CodeArtsPipeline DeleteRule | Delete Rule | |
| CreateRule | hcloud CodeArtsPipeline CreateRule | CreateRule |
Project Strategy Management
Tenant Strategy Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Strategy | hcloud CodeArtsPipeline CreateStrategy | Create Strategy | |
| Update Strategy | hcloud CodeArtsPipeline UpdateStrategy | Update Strategy | |
| Show Strategy Detail | hcloud CodeArtsPipeline ShowStrategy | Show Strategy Detail | |
| List Strategy | hcloud CodeArtsPipeline ListStrategy | List Strategy | |
| Delete Strategy | hcloud CodeArtsPipeline DeleteStrategy | Delete Strategy | |
| Switch Strategy | hcloud CodeArtsPipeline SwitchStrategy | Switch Strategy |
Extension Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Plugin Version | hcloud CodeArtsPipeline CreatePluginVersion | Create Plugin Version | |
| Create Plugin Draft | hcloud CodeArtsPipeline CreatePluginDraft | Create Plugin Draft | |
| Create Publisher | hcloud CodeArtsPipeline CreatePublisher | Create Publisher | |
| Update Plugin Draft | hcloud CodeArtsPipeline UpdatePluginDraft | Update Plugin Draft | |
| Publish Plugin Draft | hcloud CodeArtsPipeline PublishPluginDraft | Publish Plugin Draft | |
| Update Plugin Base Info | hcloud CodeArtsPipeline UpdatePluginBaseInfo | Update Plugin Base Info | |
| Publish Plugin | hcloud CodeArtsPipeline PublishPlugin | Publish Plugin | |
| Plugin binding publisher | hcloud CodeArtsPipeline PublishPluginBind | Plugin binding publisher | |
| Update plugin icon | hcloud CodeArtsPipeline UploadPluginIcon | Update plugin icon | |
| Update publisher icon | hcloud CodeArtsPipeline UploadPublisherIcon | Update publisher icon | |
| Delete plugin draft | hcloud CodeArtsPipeline DeletePluginDraft | Delete plugin draft | |
| Query publisher list | hcloud CodeArtsPipeline ListPublisher | Query publisher list | |
| List Available Publisher | hcloud CodeArtsPipeline ListAvailablePublisher | List Available Publisher | |
| List Stage Plugins | hcloud CodeArtsPipeline ListStagePlugins | List Stage Plugins | |
| List Base Plugins | hcloud CodeArtsPipeline ListBasePlugins | List Base Plugins | |
| List Base Plugins New Post | hcloud CodeArtsPipeline ListBasePluginsNewPost | List Base Plugins New Post | |
| List Plugins | hcloud CodeArtsPipeline ListPlugins | List Plugins | |
| Show Plugin Metrics | hcloud CodeArtsPipeline ShowPluginMetrics | Show Plugin Metrics | |
| Show Plugin Inputs | hcloud CodeArtsPipeline ShowPluginInputs | Show Plugin Inputs | |
| Show Plugin Outputs | hcloud CodeArtsPipeline ShowPluginOutputs | Show Plugin Outputs | |
| Query all version information of plugins | hcloud CodeArtsPipeline ListPLuginVersion | Query all version information of plugins | |
| Show plugin version details | hcloud CodeArtsPipeline ShowPluginVersion | Show plugin version details | |
| List Plugin Version Number | hcloud CodeArtsPipeline ListPluginVersionNumber | List Plugin Version Number | |
| Delete Publisher | hcloud CodeArtsPipeline DeletePublisher | Delete Publisher | |
| Show Publisher Detail | hcloud CodeArtsPipeline ShowPublisher | Show Publisher Detail | |
| Create Basic Plugin | hcloud CodeArtsPipeline CreateBasicPlugin | Create Basic Plugin | |
| Update Basic Plugin | hcloud CodeArtsPipeline UpdateBasicPlugin | Update Basic Plugin | |
| Delete Basic Plugin | hcloud CodeArtsPipeline DeleteBasicPlugin | Delete Basic Plugin | |
| Upload Basic Plugin | hcloud CodeArtsPipeline UploadBasicPlugin | Upload Basic Plugin | |
| Show Basic Plugin | hcloud CodeArtsPipeline ShowBasicPlugin | Show Basic Plugin |
GitCode Pipeline
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Running Details of a GitCode Pipeline | hcloud CodeArtsPipeline ShowActionsRunsDetail | This API is used to query the running details of a GitCode pipeline. | |
| Running a GitCode Pipeline | hcloud CodeArtsPipeline RunActionsPipeline | This API is used to run a GitCode pipeline. | |
| Retrying Running a GitCode Pipeline | hcloud CodeArtsPipeline RetryRunActionsPipeline | This API is used to retry running a GitCode pipeline. | |
| Querying GitCode Pipeline Execution Records | hcloud CodeArtsPipeline ListActionsPipelineRuns | This API is used to query GitCode pipeline execution records. | |
| Querying the GitCode Pipeline Action List | hcloud CodeArtsPipeline ListActionsPipelineRunsByRunIds | This API is used to query the GitCode pipeline action list. |
Extension Point Management
Endpoint
| API Name | Command | Description | Operation |
|---|---|---|---|
| Proxy Call to External Service Interface | hcloud CodeArtsPipeline InvokeEndpointProxy | Proxy call to external service interface. |
What is your overall rating for this page?
Thank 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