API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (hsm/2023-11-13) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 78410016550).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Images
|
API |
Title |
Description |
| GetImage | GetImage | Retrieves information about a specified image. |
| ListImages | ListImages | Queries the images that meet the specified conditions. |
| ConfigImageRemark | ConfigImageRemark | Modifies the remarks for an image. |
| CopyImage | CopyImage | Copies an image to another region. |
| ExportImage | ExportImage | Exports the image of a specified Hardware Security Module (HSM). |
Clusters
|
API |
Title |
Description |
| DeleteCluster | DeleteCluster | Deletes the specified cluster. |
| JoinCluster | JoinCluster | Adds a hardware security module (HSM) instance to a cluster. |
| ConfigClusterSubnet | ConfigClusterSubnet | Modifies a list of vSwitches that are associated with a hardware security module (HSM) cluster. |
| SyncCluster | SyncCluster | Synchronizes the data of hardware security modules (HSMs) in a cluster. |
| InitializeCluster | InitializeCluster | Initializes a cluster. |
| SwitchClusterMaster | SwitchClusterMaster | Switches the master role in a cluster to a subordinate HSM. This operation is not supported for manually synchronized clusters in the Chinese mainland. |
| ConfigClusterName | ConfigClusterName | Changes the name of a cluster. |
| LeaveCluster | LeaveCluster | Removes a hardware security module (HSM) from the current cluster. |
| CreateCluster | CreateCluster | Creates a cluster by designating an HSM instance as the master HSM. |
| ListClusters | ListClusters | Queries the clusters that meet the query conditions. |
| ConfigClusterCertificate | ConfigClusterCertificate | Configures a certificate for a cluster of hardware security modules (HSMs) outside the Chinese mainland. |
| GetCluster | GetCluster | Retrieves the details of a specified cluster. |
| ConfigClusterWhitelist | ConfigClusterWhitelist | Modifies the IP address whitelist of a cluster. |
| QuickDeployCluster | QuickDeployCluster | Deploys a cluster quickly. |
| RotateClusterManagedCert | RotateClusterManagedCert | Rotates a managed certificate for a cluster. |
| DownloadClusterManagedCert | DownloadClusterManagedCert | Downloads a managed certificate for a cluster. |
Instances
|
API |
Title |
Description |
| ConfigInstanceIpAddress | ConfigInstanceIpAddress | Modifies the virtual private cloud (VPC) endpoint of a hardware security module (HSM). |
| RestoreInstance | RestoreInstance | Restores instance data from an image. |
| ResetInstance | ResetInstance | Resets a hardware security module (HSM). |
| QuickInitInstance | QuickInitInstance | Initializes an instance. |
| ConfigInstanceWhitelist | ConfigInstanceWhitelist | Modifies the whitelist for an instance. |
| ResumeInstance | ResumeInstance | Resumes a deactivated instance. |
| GetInstance | GetInstance | Retrieves information about a specified instance. |
| PauseInstance | PauseInstance | Disables a hardware security module (HSM). |
| ListInstances | ListInstances | Queries for a list of instances that match the specified query conditions. |
| ConfigInstanceRemark | ConfigInstanceRemark | Modifies the remark of an instance. |
Other
|
API |
Title |
Description |
| GetJob | GetJob | Queries the details of an asynchronous task. |
| MoveResourceGroup | MoveResourceGroup | Moves a resource to a new resource group. |
| DescribeRegions | DescribeRegions | Queries the regions that are supported by Cloud Hardware Security Module. |
Others
|
API |
Title |
Description |
| ConfigAuditLog | ConfigAuditLog | Enables or disables the audit log feature and delivers audit logs to buckets. |
| ConfigBackupRemark | ConfigBackupRemark | Configures the name and description of a backup. |
| ConfigBackupTask | ConfigBackupTask | Modifies the execution pattern of a backup task. |
| EnableBackup | EnableBackup | Enables backup for a specified instance. |
| GetAuditLogStatus | GetAuditLogStatus | Queries the status of the audit log feature in the current region. |
| GetBackup | GetBackup | Retrieves information about a specific backup. |
| InitializeAuditLog | InitializeAuditLog | Authorizes Cloud Hardware Security Module to deliver logs. |
| ListBackups | ListBackups | Retrieves a list of backup sets that meet specified conditions. |
| ResetBackup | ResetBackup | Disassociates a backup from a hardware security module (HSM). |