CLI Command Reference (Enterprise Edition)
Instance Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create an instance | hcloud SWR CreateInstance | Create an enterprise repository instance | |
| Query instance list | hcloud SWR ListInstance | Query the list of instances | |
| Get instance details | hcloud SWR ShowInstance | Get instance details | |
| Delete an instance | hcloud SWR DeleteInstance | Delete an instance | |
| Retrieve Instance Configuration | hcloud SWR ShowInstanceConfiguration | Retrieve Instance Configuration | |
| Update Instance Configuration | hcloud SWR UpdateInstanceConfiguration | Update Instance Configuration | |
| Get Upload and Download Audit Logs | hcloud SWR ListAuditLogs | Get Upload and Download Audit Logs | |
| Get Instance Statistics | hcloud SWR ListInstanceStatistics | Get Instance Statistics |
Namespace Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Namespace | hcloud SWR CreateInstanceNamespace | Create Namespace | |
| List Namespaces | hcloud SWR ListInstanceNamespaces | List Namespaces | |
| Retrieve Namespace Details | hcloud SWR ShowInstanceNamespace | Retrieve Namespace Details | |
| Update Namespace | hcloud SWR UpdateInstanceNamespace | Update Namespace | |
| Delete Namespace | hcloud SWR DeleteInstanceNamespace | Delete Namespace |
Artifact Repository Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Get List of Artifact Repositories | hcloud SWR ListInstanceRepositories | Get List of Artifact Repositories | |
| Get List of Artifact Repositories in a Namespace | hcloud SWR ListNamespaceRepositories | Get List of Artifact Repositories in a Namespace | |
| Get Artifact Repository Details | hcloud SWR ShowInstanceRepository | Get Artifact Repository Details | |
| Update Artifact Repository | hcloud SWR UpdateInstanceRepository | Update Artifact Repository | |
| Delete Artifact Repository | hcloud SWR DeleteInstanceRepository | Delete Repository | |
| Retrieve the list of all enterprise repository instances under the current project. | hcloud SWR ListAllInstanceRepositories | Retrieve the list of all enterprise repository instances under the current project. |
Access Credential Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Retrieve Temporary Access Credentials | hcloud SWR CreateInstanceTempCredential | Retrieve Temporary Access Credentials | |
| Create Long-Term Access Credentials | hcloud SWR CreateInstanceLtCredential | Create Long-Term Access Credentials | |
| Enable/Disable Long-Term Access Credentials | hcloud SWR UpdateInstanceLtCredential | Enable or disable long-term access credentials | |
| Delete Long-Term Access Credentials | hcloud SWR DeleteInstanceLtCredential | Delete long-term access credentials | |
| List Long-Term Access Credentials | hcloud SWR ListInstanceLtCredentials | List long-term access credentials |
Access Control Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Add Internal Access | hcloud SWR CreateInstanceInternalEndpoint | Add Internal Access | |
| List Internal Access | hcloud SWR ListInstanceInternalEndpoints | List Internal Access | |
| Get Internal Access Details | hcloud SWR ShowInstanceInternalEndpoint | Get Internal Access Details | |
| Delete Internal Access | hcloud SWR DeleteInstanceInternalEndpoint | Delete Internal Access | |
| Enable or Disable Public Network Access | hcloud SWR CreateInstanceEndpointPolicy | Enable or Disable Public Network Access | |
| Update Public Network Access Whitelist | hcloud SWR UpdateInstanceEndpointPolicy | Update the public network access whitelist, using a full update method | |
| Get Public Network Access Information | hcloud SWR ShowInstanceEndpointPolicy | Get Public Network Access Information |
Trigger Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Trigger Policy | hcloud SWR CreateInstanceWebhook | Create Trigger Policy | |
| List Trigger Policies | hcloud SWR ListInstanceWebhooks | List Trigger Policies | |
| Get Trigger Policy Details | hcloud SWR ShowInstanceWebhook | Get Trigger Policy Details | |
| Update Trigger Policy | hcloud SWR UpdateInstanceWebhook | Update Trigger Policy | |
| Delete Trigger Policy | hcloud SWR DeleteInstanceWebhook | Delete Trigger Policy | |
| List Trigger Execution Jobs | hcloud SWR ListInstanceWebhookJobs | List Trigger Execution Jobs |
Task Management (SWR Enterprise Edition)
Image Synchronization Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Target Repository for Image Synchronization | hcloud SWR CreateInstanceRegistry | Create Target Repository for Image Synchronization | |
| Get List of Target Repositories for Image Synchronization | hcloud SWR ListInstanceRegistries | Get List of Target Repositories for Image Synchronization | |
| Get Details of Target Repository for Image Synchronization | hcloud SWR ShowInstanceRegistry | Get Details of Target Repository for Image Synchronization | |
| Update Target Repository for Image Synchronization | hcloud SWR UpdateInstanceRegistry | Update Target Repository for Image Synchronization | |
| Delete Target Repository for Image Synchronization | hcloud SWR DeleteInstanceRegistry | Delete Synchronized Repository | |
| Create Image Synchronization Policy | hcloud SWR CreateInstanceReplicationPolicy | Create Image Synchronization Policy | |
| Get List of Image Synchronization Policies | hcloud SWR ListInstanceReplicationPolicies | Get List of Image Synchronization Policies | |
| Get Image Synchronization Policy Details | hcloud SWR ShowInstanceReplicationPolicy | Get Image Synchronization Policy Details | |
| Update Image Synchronization Policy | hcloud SWR UpdateInstanceReplicationPolicy | Update Image Synchronization Policy | |
| Delete Image Synchronization Policy | hcloud SWR DeleteInstanceReplicationPolicy | Delete Image Synchronization Policy | |
| Manually Execute Image Synchronization Policy | hcloud SWR ExecuteInstanceReplicationPolicy | Manually execute synchronization policy | |
| Get List of Image Synchronization Policy Execution Records | hcloud SWR ListInstanceReplicationPolicyExecutions | Get list of image synchronization policy execution records | |
| Stop Image Synchronization Task | hcloud SWR StopInstanceReplicationPolicyExecution | Stop image synchronization task | |
| Get List of Images for Image Synchronization Policy Execution Tasks | hcloud SWR ListInstanceReplicationPolicyExecTasks | Get list of images for image synchronization policy execution tasks | |
| Get List of Image Versions for Image Synchronization Policy Execution Tasks | hcloud SWR ListInstanceReplicationPolicyExecSubTasks | Get list of image versions for image synchronization policy execution tasks |
Image Signature Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Get List of Signature Policies | hcloud SWR ListInstanceSignPolicies | Get list of signature policies | |
| Create Signature Policy | hcloud SWR CreateInstanceSignPolicy | Create signature policy | |
| Get Signature Policy Details | hcloud SWR ShowInstanceSignPolicy | Get signature policy details | |
| Update Signature Policy | hcloud SWR UpdateInstanceSignPolicy | Update signature policy | |
| Delete Signature Policy | hcloud SWR DeleteInstanceSignPolicy | Delete signature policy | |
| Manually Execute Signature Policy | hcloud SWR ExecuteInstanceSignPolicy | Manually execute signature policy | |
| Get Signature Execution Records List | hcloud SWR ListInstanceSignPolicyExecutions | Get signature execution records list | |
| Get List of Images for Signature Execution Task | hcloud SWR ListInstanceSignPolicyExecTasks | Get list of images for signature execution task | |
| Get List of Image Versions for Signature Execution Task | hcloud SWR ListInstanceSignatureExecutionSubtasks | Get list of image versions for signature execution task |
Retention Policy Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Retention Policy | hcloud SWR CreateInstanceRetentionPolicy | Create retention policy | |
| Get List of Retention Policies | hcloud SWR ListInstanceRetentionPolicies | Get list of retention policies | |
| Get Retention Policy Details | hcloud SWR ShowInstanceRetentionPolicy | Get retention policy details | |
| Update Retention Policy | hcloud SWR UpdateInstanceRetentionPolicy | Update retention policy | |
| Delete Retention Policy | hcloud SWR DeleteInstanceRetentionPolicy | Delete retention policy | |
| Execute Retention Policy | hcloud SWR ExecuteInstanceRetentionPolicy | Execute retention policy | |
| Get List of Retention Policy Execution Records | hcloud SWR ListInstanceRetentionPolicyExecutions | Get list of retention policy execution records | |
| Get List of Images for Retention Policy Execution Task | hcloud SWR ListInstanceRetentionPolicyExecTasks | Get list of images for retention policy execution task | |
| Get List of Image Versions for Retention Policy Execution Task | hcloud SWR ListInstanceRetentionPolicyExecSubTasks | Get list of image versions for retention policy execution task |
Tag Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Search Resource List by Tags | hcloud SWR ListInstanceResourceInstances | Search resource list by tags | |
| Search Resource Count by Tags | hcloud SWR ShowInstanceResourceInstancesCount | Search resource count by tags | |
| Batch Add Resource Tags | hcloud SWR CreateInstanceResourceTags | Batch add resource tags | |
| Batch Delete Resource Tags | hcloud SWR DeleteInstanceResourceTags | Batch delete resource tags | |
| Query All Instance Tags Under Project | hcloud SWR ListInstanceProjectTags | Query all instance tags under project | |
| Query Resource Tags | hcloud SWR ListInstanceResourceTags | Query resource tags | |
| Search Sub-resource List by Tags | hcloud SWR ListSubResourceInstances | Search sub-resource list by tags | |
| Search Sub-resource Count by Tags | hcloud SWR ShowSubResourceInstancesCount | Search sub-resource count by tags | |
| Batch Add Sub-resource Tags | hcloud SWR CreateSubResourceTags | Batch add sub-resource tags | |
| Batch Delete Sub-resource Tags | hcloud SWR DeleteSubResourceTags | Batch delete sub-resource tags | |
| Query All Namespace Tags Under Instance | hcloud SWR ListNamespaceTags | Query all namespace tags under instance | |
| Query Sub-resource Tags | hcloud SWR ListSubResourceTags | Query sub-resource tags |
Artifact Version Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Get Artifact List | hcloud SWR ListInstanceArtifacts | Get artifact list | |
| Get Artifact Details | hcloud SWR ShowInstanceArtifact | Get artifact details | |
| Delete Artifact | hcloud SWR DeleteInstanceArtifact | Delete artifact | |
| Get Artifact Accessories List | hcloud SWR ListInstanceAccessories | Get artifact accessories list | |
| Get Artifact Additional Information | hcloud SWR ShowInstanceArtifactAddition | Get artifact additional information | |
| Get All Artifact Versions of an Instance | hcloud SWR ListInstanceAllArtifacts | Get a list of all artifact versions in a repository instance (This interface is supported only in enterprise repository instances with version 25.6.0 or later) | |
| Get Repository Tags | hcloud SWR ListInstanceTags | Get repository tags | |
| Delete an Artifact Tag | hcloud SWR DeleteInstanceTag | This operation deletes a specified tag from an artifact repository. |
Image Version Immutability (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Create Immutable Tag Policy | hcloud SWR CreateImmutableRule | Create an immutable tag policy | |
| Get Immutable Tag Policy List | hcloud SWR ListImmutableRules | Get a list of immutable tag policies | |
| Update Immutable Tag Policy | hcloud SWR UpdateImmutableRule | Update an immutable tag policy | |
| Delete Immutable Tag Policy | hcloud SWR DeleteImmutableRule | Delete an immutable tag policy |
Domain Management (SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Add Domain | hcloud SWR AddDomainName | Add a domain | |
| List All Domains | hcloud SWR ListDomainNames | List all domains for the current instance | |
| Update Domain | hcloud SWR UpdateDomainName | Update a domain | |
| Delete Domain | hcloud SWR DeleteDomainName | Delete a domain. The default domain of SWR Enterprise Repository cannot be deleted. |
Feature Gates (SWR Enterprise Edition)
Artifact Scan(SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Manually Starting an Artifact Scan | hcloud SWR StartManualScanning | Manually Starting an Artifact Scan | |
| Querying Vulnerability Information About an Artifact Scan | hcloud SWR ListInstanceArtifactVulnerabilities | Querying Vulnerability Information About an Artifact Scan |
Artifact Cleanup(SWR Enterprise Edition)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of Artifact Cleanup Tasks | hcloud SWR ListGcTasks | Querying the List of Artifact Cleanup Tasks | |
| Querying Details of an Artifact Cleanup Task | hcloud SWR ShowGcTask | Querying Details of an Artifact Cleanup Task | |
| Stopping an Artifact Cleanup Task | hcloud SWR StopGcTask | Stopping an Artifact Cleanup Task | |
| Obtaining Artifact Cleanup Schedule Information | hcloud SWR ShowGcSchedule | Obtaining Artifact Cleanup Schedule Information | |
| Executing an Artifact Cleanup Schedule | hcloud SWR ExecuteGcSchedule | Executing an Artifact Cleanup Schedule | |
| Configuring an Artifact Cleanup Schedule | hcloud SWR UpdateGcSchedule | Configuring an Artifact Cleanup Schedule |
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