CLI Command Reference
Related to tenants
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Built-in Executor Specifications | hcloud CodeArtsBuild ShowAvailableInnerSpec | This API is used to query the specifications of the built-in executor. | |
| Tracking Expiration Dates of a Package | hcloud CodeArtsBuild ShowPackageSpecCountDown | This API is used to obtain expiration details of a package. | |
| Querying Tenant Status | hcloud CodeArtsBuild ShowDomainStatus | This API is used to query tenant status. | |
| Querying the Current Tenant (Billing) Type | hcloud CodeArtsBuild ShowUserChargeType | This API is used to query the current tenant (billing) type. | |
| Obtaining the Project Information List of the Current User | hcloud CodeArtsBuild ShowRelatedProject | Obtaining the Project Information List of the Current User | |
| Obtaining the Project List | hcloud CodeArtsBuild ListRelatedProjectInfo | Obtaining the Project List | |
| Obtaining the Total Number of Tasks and Their Success Rate in the Tenant Account | hcloud CodeArtsBuild ShowSummaryBuildJobInfo | Obtaining the Total Number of Tasks and Their Success Rate in the Tenant Account | |
| Checking If the Monthly Duration for the Project Used by the Current User Exceeds the Tenant's Yearly/Monthly Package Quota | hcloud CodeArtsBuild ShowUserOverPackageQuota | Checking If the Monthly Duration for the Project Used by the Current User Exceeds the Tenant's Yearly/Monthly Package Quota | |
| Obtaining User Permissions | hcloud CodeArtsBuild ShowProjectPermission | Obtaining User Permissions |
Mirror template
Build task management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Favoriting a Task | hcloud CodeArtsBuild AddFavouriteTask | This API is used to favorite a task. | |
| Unfavoriting a Task | hcloud CodeArtsBuild RemoverFavouriteTask | This API is used to unfavorite a task. | |
| Determining If a Task Uses Project-level Permissions | hcloud CodeArtsBuild ApplyProjectPermission | This API is used to determine if a task uses project-level permissions. | |
| Modifying Task Permissions in Batches | hcloud CodeArtsBuild BatchUpdateJobRolePermission | This API is used to modifying task permissions in batches. | |
| Whether secure intranet access is enabled | hcloud CodeArtsBuild CheckJobInternal | This API is used to check whether secure access to intranet is enabled. | |
| Querying the List of Self-Hosted Repos | hcloud CodeArtsBuild ListEndPoints | This API is used to query the list of self-hosted repos. | |
| Updating Notification Settings | hcloud CodeArtsBuild UpdateNewNoticeNew | This API is used to update notification settings. | |
| Obtaining Notification Information | hcloud CodeArtsBuild ShowJobNoticeConfigInfo | Obtaining Notification Information | |
| Obtaining the Status, Completion Percentage, and Estimated Time Remaining for a Named Build | hcloud CodeArtsBuild ShowBuildDetails | This API is used to obtain the status, completion percentage, and estimated time remaining for a named build. | |
| Querying the Status of Other Tenants in Cross-Tenant Scenarios | hcloud CodeArtsBuild ShowDomainsStatuses | This API is used to query the status of other tenants in cross-tenant scenarios. | |
| Obtaining Build Task Information in a Pipeline | hcloud CodeArtsBuild ShowJobPipelineInfo | This API is used to obtain build task information in a pipeline. | |
| Stopping a Build Task (Version 1) | hcloud CodeArtsBuild StopTheJob | This API is used to stop a build task. | |
| Obtaining the Roles and Permissions Matrix of a Build Task. | hcloud CodeArtsBuild ShowProjectJobPermission | This API is used to obtain the roles and permissions matrix of a build task. | |
| Creating a Build Task | hcloud CodeArtsBuild CreateNewJob | Creating a Build Task | |
| Restoring Tasks from the Recycle Bin | hcloud CodeArtsBuild RestoreRecyclingJobs | Restoring Tasks from the Recycle Bin | |
| Setting the Retention Period for Tasks in the Recycle Bin | hcloud CodeArtsBuild SetKeepTime | This API allows tenant accounts to set the retention period for tasks in the recycle bin, but it is not accessible to member accounts. | |
| Updating a Build Task | hcloud CodeArtsBuild UpdateNewJob | Updating a Build Task | |
| Checking the Webhook URL Parameter | hcloud CodeArtsBuild CheckWebhookUrl | Checking the Webhook URL Parameter | |
| Running a Build | hcloud CodeArtsBuild ExecuteJob | Running a Build | |
| Disabling a Task | hcloud CodeArtsBuild DisableTheJob | Disabling a Task | |
| Cloning a Build Task | hcloud CodeArtsBuild CopyJob | Cloning a Build Task | |
| Deleting a Task | hcloud CodeArtsBuild DeleteTheJob | Deleting a Task | |
| Deleting Tasks from the Recycle Bin | hcloud CodeArtsBuild DeleteRecyclingJobs | Deleting Tasks from the Recycle Bin | |
| Emptying the Recycle Bin | hcloud CodeArtsBuild ClearRecyclingJobs | Emptying the Recycle Bin | |
| Checking Whether a Task Is Disabled | hcloud CodeArtsBuild ShowDisable | Checking Whether a Task Is Disabled | |
| Copying a Task Name | hcloud CodeArtsBuild ShowCopyName | Copying a Task Name | |
| Querying Task Status | hcloud CodeArtsBuild ShowJobStepStatus | Querying Task Status | |
| Obtaining the Default Roles and Permissions Matrix of the Current Project | hcloud CodeArtsBuild ShowDefaultProjectPermission | Obtaining the Default Roles and Permissions Matrix of the Current Project | |
| Obtaining the Update Records | hcloud CodeArtsBuild ListUpdateJobHistory | Obtaining the Update Records | |
| Checking If the Build Task Is Running | hcloud CodeArtsBuild ShowRunningStatus | Checking If the Build Task Is Running | |
| Obtaining Default Parameters | hcloud CodeArtsBuild ShowDefaultBuildParameters | Obtaining Default Parameters | |
| Checking If the Project Has a Task with the Specified Name | hcloud CodeArtsBuild CheckJobNameIsExists | Checking If the Project Has a Task with the Specified Name | |
| Querying All Build Tasks | hcloud CodeArtsBuild ListJob | Querying All Build Tasks | |
| Checking If the Task Count Has Reached the Upper Limit | hcloud CodeArtsBuild CheckJobCountIsTopLimit | Checking If the Task Count Has Reached the Upper Limit | |
| Obtaining Build Parameters on the Details Page | hcloud CodeArtsBuild ListBuildParameter | Obtaining Build Parameters on the Details Page | |
| Querying the Build Tasks in the Recycle Bin | hcloud CodeArtsBuild ListRecyclingJob | Querying the Build Tasks in the Recycle Bin | |
| Querying Predefined Parameters | hcloud CodeArtsBuild ShowJobSystemParameters | Querying Predefined Parameters | |
| Viewing Build Information of a Build Task | hcloud CodeArtsBuild ShowJobInfo | Viewing Build Information of a Build Task | |
| Obtaining Parameter Types on the Task Editing Page | hcloud CodeArtsBuild ShowBuildParamsList | Obtaining Parameter Types on the Task Editing Page | |
| Obtaining the Differences Between Build Task Configurations | hcloud CodeArtsBuild ShowJobConfigDiff | Obtaining the Differences Between Build Task Configurations | |
| Obtaining the Roles and Permissions Matrix of a Build Task | hcloud CodeArtsBuild ShowJobRolePermission | Obtaining the Roles and Permissions Matrix of a Build Task | |
| Querying Tasks of a Project | hcloud CodeArtsBuild ListProjectJobs | Querying Tasks of a Project | |
| Obtaining Build Task Details (Version 1) | hcloud CodeArtsBuild ShowJobConfig | Obtaining Build Task Details (Version 1) |
Build records
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining the Brief Build Information of a Specified Project | hcloud CodeArtsBuild ListBriefRecord | Obtaining the Brief Build Information of a Specified Project | |
| Obtaining Information About Each Task Stage | hcloud CodeArtsBuild ShowBuildRecordFullStages | Obtaining Information About Each Task Stage | |
| Obtaining the Build Record List of a Specified Project | hcloud CodeArtsBuild ListRecords | Obtaining the Build Record List of a Specified Project | |
| Obtaining Build Records of a Task | hcloud CodeArtsBuild ShowBuildInfoRecord | Obtaining Build Records of a Task | |
| Obtaining the Directed Acyclic Graph of a Build Record | hcloud CodeArtsBuild ShowBuildRecordFlowGraph | Obtaining the Directed Acyclic Graph of a Build Record | |
| Obtaining Build Record Information (Version 1) | hcloud CodeArtsBuild ShowJobBuildRecordDetail | Obtaining Build Record Information (Version 1) | |
| Obtaining the Number of Builds on the Build History Page | hcloud CodeArtsBuild ShowJobTotal | Obtaining the Number of Builds on the Build History Page | |
| Querying Details About a Specified Build Record | hcloud CodeArtsBuild ShowBuildRecord | Querying Details About a Specified Build Record | |
| Obtaining the Build Script of a Build Record | hcloud CodeArtsBuild ShowBuildRecordBuildScript | Obtaining the Build Script of a Build Record | |
| Obtaining Build Records of a Task (Version 1) | hcloud CodeArtsBuild ListBuildInfoRecordByJobId | Obtaining Build Records of a Task (Version 1) |
Construction report
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Build Success Rate | hcloud CodeArtsBuild ShowJobBuildSuccessRatio | Querying the Build Success Rate | |
| Obtaining the Coverage | hcloud CodeArtsBuild ShowReportSummary | Obtaining the Coverage | |
| Obtaining Unit Test Coverage Reports | hcloud CodeArtsBuild ListJunitCoverageSummary | Obtaining Unit Test Coverage Reports | |
| Viewing Repositories | hcloud CodeArtsBuild ListRepository | Viewing Repositories | |
| Obtaining Information About All Branches of a Task | hcloud CodeArtsBuild ListRepoBranch | Obtaining Information About All Branches of a Task | |
| Obtaining the Unit Test Coverage Report Package | hcloud CodeArtsBuild DownloadJunitCoverageZip | Obtaining the Unit Test Coverage Report Package | |
| Obtaining the Build Duration Information on the Dashboard | hcloud CodeArtsBuild ShowJobBuildTime | Obtaining the Build Duration Information on the Dashboard |
Template management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Favoriting an Official Template | hcloud CodeArtsBuild AddFavouriteOfficialTemplate | This API is used to favorite an official template. | |
| Unfavoriting an Official Template | hcloud CodeArtsBuild RemoverFavouriteOfficialTemplate | This API is used to unfavorite an official template. | |
| Favoriting a Custom Template | hcloud CodeArtsBuild AddFavouriteCustomTemplate | This API is used to favorite a custom template. | |
| Unfavoriting a Custom Template | hcloud CodeArtsBuild RemoverFavouriteCustomTemplate | This API is used to unfavorite a custom template. | |
| Querying a Specific Template Based on Its UUID | hcloud CodeArtsBuild ShowTemplate | This API is used to query a specific template based on its UUID. | |
| Saving Template Use Records | hcloud CodeArtsBuild SaveTemplateUsedInfo | This API is used to save template use records. | |
| Creating a Build Template (Version 1) | hcloud CodeArtsBuild CreateTemplate | Creating a Build Template (Version 1) | |
| Obtaining Recommended Templates | hcloud CodeArtsBuild ListRecommendOfficialTemplate | Obtaining Recommended Templates | |
| Deleting a Build Template (Version 1) | hcloud CodeArtsBuild DeleteTemplate | Deleting a Build Template (Version 1) | |
| Obtaining the Default Template for a YAML Build | hcloud CodeArtsBuild ShowYamlTemplate | Obtaining the Default Template for a YAML Build | |
| Querying Templates based on Specified Conditions | hcloud CodeArtsBuild ListCustomTemplate | Querying Templates based on Specified Conditions | |
| Querying Official Templates | hcloud CodeArtsBuild ListOfficialTemplate | Querying Official Templates |
File management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Configuring File Permissions | hcloud CodeArtsBuild UpdateKeystorePermission | This API is used to configure permissions for a file. | |
| Granting File Permissions | hcloud CodeArtsBuild AddKeystorePermission | This API is used to grant a user the permissions for a file. | |
| Uploading a File | hcloud CodeArtsBuild UploadKeystore | Uploading a File | |
| Updating File Information | hcloud CodeArtsBuild UpdateKeystore | This API is used to update file information. | |
| Deleting a File | hcloud CodeArtsBuild DeleteKeystore | Deleting a File | |
| Deleting File Permissions | hcloud CodeArtsBuild DeleteKeystorePermission | Deleting File Permissions | |
| Downloading a File from File Manager | hcloud CodeArtsBuild DownloadKeystoreByName | Downloading a File from File Manager | |
| Querying File Permissions | hcloud CodeArtsBuild ShowKeystorePermission | Querying File Permissions | |
| Querying Files Available to a User | hcloud CodeArtsBuild ListKeystore | Querying Files Available to a User | |
| Querying Files of the Tenant | hcloud CodeArtsBuild ListKeystoreSearch | Querying Files of the Tenant |
CodeArtsBuild(TheOld)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Build Tasks in Batches | hcloud CodeArtsBuild BatchDeleteBuildJobs | This API is used to delete build tasks in batches. | |
| View the build task build history list based on the start time and end time. | hcloud CodeArtsBuild ShowListPeriodHistory | View the build task build history list based on the start time and end time. | |
| View the build history list of build task. | hcloud CodeArtsBuild ShowListHistory | View the build history list of build task. | |
| KeyStore File Download | hcloud CodeArtsBuild DownloadKeystore | Downloading KeyStore Files of a Specified Tenant | |
| Checking the Task Running Status | hcloud CodeArtsBuild ShowJobStatus | Checking the Task Running Status | |
| View the build task list of users under a project. | hcloud CodeArtsBuild ShowJobListByProjectId | View the build task list of users under a project. | |
| Run the build task command. | hcloud CodeArtsBuild RunJob | Run the build task command to transfer user-defined parameters. | |
| Queries the latest successful build history of a specified code repository. | hcloud CodeArtsBuild ShowLastHistory | Queries the latest successful build history of a specified code repository. | |
| API for Obtaining Historical Build Details | hcloud CodeArtsBuild ShowHistoryDetails | API for Obtaining Historical Build Details | |
| Check the build task build success rate based on the start time and end time. | hcloud CodeArtsBuild ShowJobSuccessRatio | Check the build task build success rate based on the start time and end time. | |
| Download Full Build Log | hcloud CodeArtsBuild DownloadBuildLog | Download Full Build Log | |
| Download Build Step Log | hcloud CodeArtsBuild DownloadTaskLog | Download Build Step Log | |
| Obtaining Build Records | hcloud CodeArtsBuild ShowRecordDetail | Obtaining Build Records | |
| Obtaining Build Product Details | hcloud CodeArtsBuild ShowOutputInfo | Obtaining Build Product Details | |
| Build Stop Result | hcloud CodeArtsBuild StopBuildJob | Build Stop Result | |
| Delete Build Task | hcloud CodeArtsBuild DeleteBuildJob | Delete Build Task | |
| Disable Build Tasks | hcloud CodeArtsBuild DisableBuildJob | Disable Build Tasks | |
| Resume Build Task | hcloud CodeArtsBuild ResumeBuildJob | Resume Build Task | |
| Creating a Build Job | hcloud CodeArtsBuild CreateBuildJob | Creating a Build Job | |
| Updating the build task | hcloud CodeArtsBuild UpdateBuildJob | Updating the build task | |
| Querying a Build Template | hcloud CodeArtsBuild ListTemplates | Querying a Build Template | |
| Creating a Build Template | hcloud CodeArtsBuild CreateTemplates | Creating a Build Template | |
| Deleting a Build Template | hcloud CodeArtsBuild DeleteTemplates | Deleting a Build Template | |
| Query a Notification | hcloud CodeArtsBuild ListNotice | Query a Notification | |
| Sending Asynchronous Notifications When Updating Resource Types | hcloud CodeArtsBuild UpdateNotice | Sending Asynchronous Notifications When Updating Resource Types | |
| Cancel Notification | hcloud CodeArtsBuild DisableNotice | Cancel Notification | |
| Obtaining build task Details | hcloud CodeArtsBuild ListJobConfig | Obtaining build task Details | |
| Download Real Time Log | hcloud CodeArtsBuild DownloadRealTimeLog | Download Real Time Log | |
| Obtaining Build INFO Records | hcloud CodeArtsBuild ListBuildInfoRecord | Obtaining Build INFO Records |
CodeArtsBuild(Offline)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Downloading Build Logs (To Be Taken Offline) | hcloud CodeArtsBuild DownloadLogByRecordId | Downloading Build Logs (To Be Taken Offline) | |
| Obtaining a Directed Acyclic Graph of Build Records (To Be Offline) | hcloud CodeArtsBuild ShowFlowGraph | Obtaining a Directed Acyclic Graph of Build Records (To Be Offline) | |
| Obtaining Build Records (To Be Offline) | hcloud CodeArtsBuild ShowRecordInfo | Obtaining Build Records (To Be Offline) | |
| Stopping the build task (To Be Offline) | hcloud CodeArtsBuild StopJob | Stopping the build task (To Be Offline) |
LogManager
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining All Run Logs | hcloud CodeArtsBuild DownloadBuildRealTimeLog | This API is used to obtain all run logs. | |
| Downloading All Build Logs | hcloud CodeArtsBuild DownloadBuildFullLog | This API is used to download all build logs. | |
| Obtaining Build Logs After Task Execution | hcloud CodeArtsBuild ShowActionIInfo | This API is used to obtain build logs after task execution. |
GroupManager
| API Name | Command | Description | Operation |
|---|---|---|---|
| Modifying Group Information | hcloud CodeArtsBuild UpdateJobGroup | This API is used to modify group information. | |
| Querying a Group Tree | hcloud CodeArtsBuild ListGroupTree | This API is used to query a group tree. | |
| Swapping Group Order | hcloud CodeArtsBuild SwitchedPacket | This API is used to swap group order. | |
| Moving Build Tasks to a Specified Group | hcloud CodeArtsBuild MoveGroup | This API is used to move build tasks to a specified group. | |
| Deleting a Group | hcloud CodeArtsBuild DeleteGroup | This API is used to delete a group. | |
| Creating a Build Task Group | hcloud CodeArtsBuild CreateJobGroup | This API is used to create a build task group. |
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
