This product(
ebs/2021-07-30) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Region
| 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. |
ReplicaPair
| API | Title | Description |
|---|---|---|
| CreateDiskReplicaPair | CreateDiskReplicaPair | Creates a replication pair to asynchronously replicate data between disks. |
| 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 a replication pair. |
| StartDiskReplicaPair | StartDiskReplicaPair | Activates a 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 replication pairs in a specific 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. |
ReplicaGroup
| API | Title | Description |
|---|---|---|
| CreateDiskReplicaGroup | CreateDiskReplicaGroup | Creates a replication pair-consistent group. |
| DescribeDiskReplicaGroups | DescribeDiskReplicaGroups | Queries the details of replication pair-consistent groups in a specific 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. |
DedicatedBlockStorageCluster
| API | Title | Description |
|---|---|---|
| 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. |
| DescribeDedicatedBlockStorageClusters | DescribeDedicatedBlockStorageClusters | Queries dedicated clusters. |
| ModifyDedicatedBlockStorageClusterAttribute | ModifyDedicatedBlockStorageClusterAttribute | Modifies the information of a dedicated block storage cluster. |
| DescribeDedicatedBlockStorageClusterDisks | DescribeDedicatedBlockStorageClusterDisks | Queries the details of one or more disks 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 Snapshot Policy
| API | Title | Description |
|---|---|---|
| CreateEnterpriseSnapshotPolicy | CreateEnterpriseSnapshotPolicy | Create an enterprise-level snapshot policy |
| 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. |
| UpdateEnterpriseSnapshotPolicy | UpdateEnterpriseSnapshotPolicy | Search for a 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. |
CloudLens
| API | Title | Description |
|---|---|---|
| ApplyLensService | ApplyLensService | Enables CloudLens for EBS. |
| DescribeLensServiceStatus | DescribeLensServiceStatus | |
| CancelLensService | CancelLensService | Disables CloudLens for EBS. |
| DescribeLensMonitorDisks | DescribeLensMonitorDisks | Queries one or more Elastic Block Storage (EBS) devices that you created. |
| DescribeEvents | DescribeEvents | Queries the risk events of a disk. |
| DescribeMetricData | DescribeMetricData | Queries the statistics about a metric of Elastic Block Storage (EBS) disks. |
| DescribeDiskMonitorDataList | DescribeDiskMonitorDataList | Queries the near real-time monitoring data of disks. You can query only the burst performance data of ESSD AutoPL disks. The data is aggregated by hour. |
| DescribeDiskMonitorData | DescribeDiskMonitorData | Queries the near real-time monitoring data of a disk. |
| DescribeDiskEvents | DescribeDiskEvents | Queries the risk events of a disk. |
Laboratory
| API | Title | Description |
|---|---|---|
| UpdateSolutionInstanceAttribute | UpdateSolutionInstanceAttribute | Updates the attributes of a solution instance. |
Other
| 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 one or more Elastic Block Storage (EBS) resources, or queries the IDs and tags of resources in a specified 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. |