API standards and multilingual preset SDKs
The OpenAPI of this product (ebs/2021-07-30) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Service regions
|
API |
Title |
Description |
| 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. |
Replication pairs
|
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. |
| 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. |
| ModifyDiskReplicaPair | ModifyDiskReplicaPair | Modifies an async replication pair. |
| StartDiskReplicaPair | StartDiskReplicaPair | Activates the async replication feature for a specific replication pair. |
| StopDiskReplicaPair | StopDiskReplicaPair | Stops a replication pair. |
| ReprotectDiskReplicaPair | ReprotectDiskReplicaPair | Enables the reverse replication feature for a replication pair. |
| FailoverDiskReplicaPair | FailoverDiskReplicaPair | Enables the failover feature for replication pairs. |
| DescribeDiskReplicaPairProgress | DescribeDiskReplicaPairProgress | Queries the replication progress of a replication pair. |
| DeleteDiskReplicaPair | DeleteDiskReplicaPair | Deletes replication pairs. |
| DescribeDiskReplicaPairs | DescribeDiskReplicaPairs | Queries information about one or more replication pairs in a specified region. |
| 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. |
| DescribePairDrills | DescribePairDrills | Queries the disaster recovery drills that were performed on the replication pair whose secondary disk resides in a specific region. |
| 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. |
| 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. |
Replication groups
|
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. |
| 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. |
| StopDiskReplicaGroup | StopDiskReplicaGroup | Stops a replication pair-consistent group. This operation stops all replication pairs in the replication pair-consistent group. |
| 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. |
| 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. |
| DeleteDiskReplicaGroup | DeleteDiskReplicaGroup | Deletes a replication pair-consistent group. |
| DescribeReplicaGroupDrills | DescribeReplicaGroupDrills | Queries the disaster recovery drills that were performed on the replication pair-consistent group whose secondary disk resides in a specific region. |
| 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. |
| 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. |
Dedicated block storage clusters
|
API |
Title |
Description |
| CreateDedicatedBlockStorageCluster | Create a dedicated block storage cluster | Creates a dedicated block storage cluster by calling the CreateDedicatedBlockStorageCluster operation with parameters such as Azone, Capacity, Type, and PeriodUnit. |
| DescribeDedicatedBlockStorageClusters | DescribeDedicatedBlockStorageClusters | Queries dedicated clusters. |
| ModifyDedicatedBlockStorageClusterAttribute | ModifyDedicatedBlockStorageClusterAttribute | Modifies the information of a dedicated elastic block storage cluster. |
| DescribeDedicatedBlockStorageClusterDisks | Query cloud disks in a dedicated block storage cluster | Queries information about one or more cloud disks that you have created in a dedicated block storage cluster. |
| 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. |
Enterprise-level snapshot policies
|
API |
Title |
Description |
| CreateEnterpriseSnapshotPolicy | Create an enterprise-level snapshot policy | Creates an enterprise-level snapshot policy by calling CreateEnterpriseSnapshotPolicy. |
| DescribeEnterpriseSnapshotPolicy | Query enterprise-level snapshot policies | Queries enterprise-level snapshot policies by specifying parameters such as PolicyIds, ResourceGroupId, and Tag. |
| UpdateEnterpriseSnapshotPolicy | Modify an enterprise-level snapshot policy | Modifies the configuration of an enterprise-level snapshot policy. |
| BindEnterpriseSnapshotPolicy | BindEnterpriseSnapshotPolicy | Bind disks into a enterprise-level snapshot policy. |
| UnbindEnterpriseSnapshotPolicy | UnbindEnterpriseSnapshotPolicy | Unbind disks from a enterprise-level snapshot policy. |
| DeleteEnterpriseSnapshotPolicy | DeleteEnterpriseSnapshotPolicy | Delete a enterprise-level snapshot policy. |
EBS lens
|
API |
Title |
Description |
| ApplyLensService | Activate EBS lens | Activates EBS Lens (CloudLens for EBS). |
| DescribeLensServiceStatus | Query EBS lens service status | Queries the status of the EBS Lens service activated by the user. |
| CancelLensService | Cancel EBS lens | Cancels EBS Lens. |
| DescribeLensMonitorDisks | DescribeLensMonitorDisks | Queries information about one or more of your Elastic Block Storage (EBS) disks. |
| DescribeEvents | DescribeEvents | Queries threat events for disks. |
| DescribeMetricData | DescribeMetricData | Queries the monitoring metrics of a resource. |
| DescribeDiskMonitorData | DescribeDiskMonitorData | Queries fine-grained monitoring data of a disk. |
Labs
|
API |
Title |
Description |
| UpdateSolutionInstanceAttribute | UpdateSolutionInstanceAttribute | Updates the attributes of a solution instance. |
Others
|
API |
Title |
Description |
| TagResources | TagResources | Creates tags and adds the tags to Elastic Block Storage (EBS) resources. |
| 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. |
| UntagResources | UntagResources | Removes tags from specified Elastic Block Storage (EBS) resources. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which an Elastic Block Storage (EBS) resource belongs. |
| DescribeSolutionInstanceConfiguration | DescribeSolutionInstanceConfiguration | Queries the default configurations of a solution. |
| QueryDedicatedBlockStorageClusterDiskThroughputStatus | QueryDedicatedBlockStorageClusterDiskThroughputStatus | Query the throughput status of a dedicated block storage cluster disk which has been set through the SetDedicatedBlockStorageClusterDiskThroughput API. |
| 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. |
| ListReports | Query usage report list | Queries the historical report list for a specified application using a centralized role. |
| GetReport | Get User Cloud Disk Usage Report | Centralized Role: Obtain User Usage Report with reportId |
| DescribeUserTagKeys | DescribeUserTagKeys | Centralized Role: Query User Disk Snapshot tagKeys |
| DescribeUserTagValues | DescribeUserTagValues | Centralized Role: Query User Disk and Snapshot tagValues |
| DeleteApp | Delete an application | Deletes an application using the centralized role. |
| DescribeApps | Query application details | Queries application information as a centralized role. |
| CreateApp | Create an app | Creates an app with the centralized role. |
| ModifyApp | Modify an app | Modifies an app from a centralized role. |
| CreateDiagnoseReport | CreateDiagnoseReport | Creates a diagnostic report for a specified resource. |
| DescribeDiagnoseReport | Query resource diagnostic reports | Queries diagnostic reports. |