API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ebs/2021-07-30) 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: 147535001692).
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. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
ReplicaPair
|
API |
Title |
Description |
| ListReplicaEdgeSupported | ListReplicaEdgeSupported | Queries the destination regions and zones that support asynchronous replication for a specified zone. |
| CreateDiskReplicaPair | CreateDiskReplicaPair | Creates a disk replication pair. |
| ModifyDiskReplicaPair | ModifyDiskReplicaPair | Modifies an async replication pair. |
| DescribeDiskReplicaPairs | DescribeDiskReplicaPairs | Queries information about one or more replication pairs in a specified region. |
ReplicaGroup
|
API |
Title |
Description |
| CreateDiskReplicaGroup | CreateDiskReplicaGroup | Creates a replication pair-consistent group. |
| DescribeDiskReplicaGroups | DescribeDiskReplicaGroups | Queries information about one or more replication pair-consistent groups in a specified region. |
| ModifyDiskReplicaGroup | ModifyDiskReplicaGroup | Modifies the name, description, or Recovery Point Objective (RPO) of a replication pair-consistent group. |
CloudLens
|
API |
Title |
Description |
| DescribeEvents | DescribeEvents | Queries threat events for disks. |
| DescribeMetricData | DescribeMetricData | Queries the monitoring metrics of a resource. |
Other
|
API |
Title |
Description |
| ListReports | ListReports | Centralized Role: Query Historical Reports |
Others
|
API |
Title |
Description |
| AddDiskReplicaPair | AddDiskReplicaPair | Adds a replication pair to a replication pair-consistent group. You can use a replication pair-consistent group to batch manage replication pairs. When you call this operation, you can specify parameters, such as ReplicaGroupId, ReplicaPairId, and ClientToken, in the request. |
| ApplyLensService | ApplyLensService | Cancels Elastic Block Storage data insight (CloudLens for EBS). |
| BindEnterpriseSnapshotPolicy | BindEnterpriseSnapshotPolicy | Bind disks into a enterprise-level snapshot policy. |
| CancelLensService | CancelLensService | Cancels Elastic Block Storage data insight (CloudLens for EBS). |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which an Elastic Block Storage (EBS) resource belongs. |
| ClearPairDrill | ClearPairDrill | Clears the disaster recovery drills that were initiated from the secondary disk of a replication pair and deletes the auto-created drill disks. |
| ClearReplicaGroupDrill | ClearReplicaGroupDrill | Clears the disaster recovery drills that were initiated from the secondary disks of a replication pair-consistent group and deletes the auto-created drill disks. |
| CreateApp | CreateApp | Creates an application. |
| CreateDedicatedBlockStorageCluster | CreateDedicatedBlockStorageCluster | Creates a dedicated block storage cluster. When you call this operation, you can specify parameters, such as Azone, Capacity, Type, and PeriodUnit, in the request. |
| CreateEnterpriseSnapshotPolicy | CreateEnterpriseSnapshotPolicy | Create an enterprise-level snapshot policy |
| DeleteApp | DeleteApp | Deletes an application. |
| DeleteDiskReplicaGroup | DeleteDiskReplicaGroup | Deletes a replication pair-consistent group. |
| DeleteDiskReplicaPair | DeleteDiskReplicaPair | Deletes replication pairs. |
| DeleteEnterpriseSnapshotPolicy | DeleteEnterpriseSnapshotPolicy | Delete a enterprise-level snapshot policy. |
| DescribeDedicatedBlockStorageClusterDisks | DescribeDedicatedBlockStorageClusterDisks | Queries information about cloud disks in a dedicated block storage cluster. |
| DescribeDedicatedBlockStorageClusters | DescribeDedicatedBlockStorageClusters | Queries dedicated clusters. |
| DescribeDiskEvents | DescribeDiskEvents | Queries the risk events of a disk. The operation is getting offline. Switch to the new operation DescribeEvents. |
| DescribeDiskMonitorData | DescribeDiskMonitorData | Queries fine-grained monitoring data of a disk. |
| DescribeDiskMonitorDataList | DescribeDiskMonitorDataList | Queries fine-grained monitoring data of multiple disks. You can query only the burst performance data of ESSD AutoPL disks. The data is aggregated by hour. |
| DescribeDiskReplicaPairProgress | DescribeDiskReplicaPairProgress | Queries the replication progress of a replication pair. |
| DescribeEnterpriseSnapshotPolicy | DescribeEnterpriseSnapshotPolicy | Queries the information about enterprise-level snapshot policies. When you call this operation, you can specify parameters, such as PolicyIds, ResourceGroupId, and Tag, in the request. |
| DescribeLensMonitorDisks | DescribeLensMonitorDisks | Queries information about one or more of your Elastic Block Storage (EBS) disks. |
| DescribeLensServiceStatus | DescribeLensServiceStatus | Queries the status of CloudLens for EBS. |
| DescribePairDrills | DescribePairDrills | Queries the disaster recovery drills that were performed on the replication pair whose secondary disk resides in a specific region. |
| DescribeRegions | DescribeRegions | Queries the details of regions in which Elastic Block Storage (EBS) features (such as async replication, CloudLens for EBS, and Dedicated Block Storage Cluster) are supported. |
| DescribeReplicaGroupDrills | DescribeReplicaGroupDrills | Queries the disaster recovery drills that were performed on the replication pair-consistent group whose secondary disk resides in a specific region. |
| DescribeSolutionInstanceConfiguration | DescribeSolutionInstanceConfiguration | Queries the default configurations of a solution. |
| DescribeUserTagKeys | DescribeUserTagKeys | Centralized Role: Query User Disk Snapshot tagKeys |
| DescribeUserTagValues | DescribeUserTagValues | Centralized Role: Query User Disk and Snapshot tagValues |
| FailoverDiskReplicaGroup | FailoverDiskReplicaGroup | Enables the failover feature for replication pairs in a replication pair-consistent group. When the primary disks of specific replication pairs in a replication pair-consistent group fail, you can call this operation to enable the read and write permissions on the secondary disks. |
| FailoverDiskReplicaPair | FailoverDiskReplicaPair | Enables the failover feature for replication pairs. |
| GetReport | Get User Cloud Disk Usage Report | Centralized Role: Obtain User Usage Report with reportId |
| ListTagResources | ListTagResources | Queries the tags that are added to EBS resources, or queries the IDs and tags of resources in a non-default resource group. |
| ModifyApp | ModifyApp | Modifies an application. |
| ModifyDedicatedBlockStorageClusterAttribute | ModifyDedicatedBlockStorageClusterAttribute | Modifies the information of a dedicated elastic block storage cluster. |
| QueryDedicatedBlockStorageClusterDiskThroughputStatus | QueryDedicatedBlockStorageClusterDiskThroughputStatus | Query the throughput status of a dedicated block storage cluster disk which has been set through the SetDedicatedBlockStorageClusterDiskThroughput API. |
| QueryDedicatedBlockStorageClusterInventoryData | QueryDedicatedBlockStorageClusterInventoryData | Queries the capacity trend data of a dedicated Elastic Block Storage (EBS) cluster within a specific time period, including the available capacity and total capacity. |
| RemoveDiskReplicaPair | RemoveDiskReplicaPair | Removes a replication pair from a replication pair-consistent group. After a replication pair is removed from a replication pair-consistent group, the pair is disassociated from the group but is not deleted. |
| ReprotectDiskReplicaGroup | ReprotectDiskReplicaGroup | Enables the reverse replication feature for replication pairs that belong to a replication pair-consistent group. After reverse replication is enabled, data stored on the original secondary disks is replicated to the original primary disks. When a reverse replication is being performed, the primary and secondary sites of the replication pair-consistent group remain unchanged, but data is replicated from the secondary site to the primary site. |
| ReprotectDiskReplicaPair | ReprotectDiskReplicaPair | Enables the reverse replication feature for a replication pair. |
| SetDedicatedBlockStorageClusterDiskThroughput | SetDedicatedBlockStorageClusterDiskThroughput | In the elastic type dedicated block storage cluster, you can easily achieve the specified throughput (Bps) for the target disk. You only need to set the cloud disk ID and the target throughput, simplifying the process of configuring. |
| StartDiskReplicaGroup | StartDiskReplicaGroup | Enables the async replication feature for replication pairs that belong to a replication pair-consistent group. The first time the async replication feature is enabled for the replication pairs, the system performs a full synchronization to synchronize all data from disks at the primary site (primary disks) to disks at the secondary site (secondary disks). Then, the system periodically synchronizes incremental data based on the recovery point objective (RPO) of the replication pair-consistent group. |
| StartDiskReplicaPair | StartDiskReplicaPair | Activates the async replication feature for a specific replication pair. |
| StartPairDrill | StartPairDrill | Starts a disaster recovery drill to ensure the continued replication and clone the data from the last recovery point of the secondary disk to a new disk. This helps you test the completeness and correctness of applications that are deployed on the disaster recovery site on a regular basis. |
| StartReplicaGroupDrill | StartReplicaGroupDrill | Starts a disaster recovery drill in a replication pair-consistent group to ensure the continued replication and restores data from the latest recovery point of secondary disks to new disks. This helps test the completeness and correctness of applications that are deployed on the disaster recovery site on a regular basis. |
| StopDiskReplicaGroup | StopDiskReplicaGroup | Stops a replication pair-consistent group. This operation stops all replication pairs in the replication pair-consistent group. |
| StopDiskReplicaPair | StopDiskReplicaPair | Stops a replication pair. |
| TagResources | TagResources | Creates tags and adds the tags to Elastic Block Storage (EBS) resources. |
| UnbindEnterpriseSnapshotPolicy | UnbindEnterpriseSnapshotPolicy | Unbind disks from a enterprise-level snapshot policy. |
| UntagResources | UntagResources | Removes tags from specified Elastic Block Storage (EBS) resources. |
| UpdateEnterpriseSnapshotPolicy | UpdateEnterpriseSnapshotPolicy | Search for a enterprise-level snapshot policy. |
| UpdateSolutionInstanceAttribute | UpdateSolutionInstanceAttribute | Updates the attributes of a solution instance. |