CbsClient (tencentcloud-sdk-java-intl-en 3.0.823 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.cbs.v20170312.CbsClient

public class CbsClient
extends com.tencentcloudapi.common.AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`CbsClient(com.tencentcloudapi.common.Credential credential, String region)`
`CbsClient(com.tencentcloudapi.common.Credential credential, String region, com.tencentcloudapi.common.profile.ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplyDiskBackupResponse`	`ApplyDiskBackup(ApplyDiskBackupRequest req)` This API is used to roll back a backup point to the original cloud disk.
`ApplySnapshotResponse`	`ApplySnapshot(ApplySnapshotRequest req)` This API (ApplySnapshot) is used to roll back a snapshot to the original cloud disk.
`AttachDisksResponse`	`AttachDisks(AttachDisksRequest req)` This API is used to mount one or more cloud disks.
`BindAutoSnapshotPolicyResponse`	`BindAutoSnapshotPolicy(BindAutoSnapshotPolicyRequest req)` This API (BindAutoSnapshotPolicy) is used to bind the cloud disk to the specified scheduled snapshot policy.
`CopySnapshotCrossRegionsResponse`	`CopySnapshotCrossRegions(CopySnapshotCrossRegionsRequest req)` This API is used to replicate a snapshot to another region.
`CreateAutoSnapshotPolicyResponse`	`CreateAutoSnapshotPolicy(CreateAutoSnapshotPolicyRequest req)` This API (CreateAutoSnapshotPolicy) is used to create a scheduled snapshot policy.
`CreateDiskBackupResponse`	`CreateDiskBackup(CreateDiskBackupRequest req)` This API is used to create a backup point for a cloud disk.
`CreateDisksResponse`	`CreateDisks(CreateDisksRequest req)` This API is used to create cloud disks.
`CreateSnapshotResponse`	`CreateSnapshot(CreateSnapshotRequest req)` This API is used to create a snapshot for the specified cloud disk.
`DeleteAutoSnapshotPoliciesResponse`	`DeleteAutoSnapshotPolicies(DeleteAutoSnapshotPoliciesRequest req)` This API (DeleteAutoSnapshotPolicies) is used to delete scheduled snapshot policies.
`DeleteDiskBackupsResponse`	`DeleteDiskBackups(DeleteDiskBackupsRequest req)` This API is used to delete the backup points of the specified cloud disk in batches.
`DeleteSnapshotsResponse`	`DeleteSnapshots(DeleteSnapshotsRequest req)` This API is used to delete snapshots.
`DescribeAutoSnapshotPoliciesResponse`	`DescribeAutoSnapshotPolicies(DescribeAutoSnapshotPoliciesRequest req)` This API is used to query scheduled snapshot policies.
`DescribeDiskAssociatedAutoSnapshotPolicyResponse`	`DescribeDiskAssociatedAutoSnapshotPolicy(DescribeDiskAssociatedAutoSnapshotPolicyRequest req)` This API (DescribeDiskAssociatedAutoSnapshotPolicy) is used to query the scheduled snapshot policy bound to a cloud disk.
`DescribeDiskBackupsResponse`	`DescribeDiskBackups(DescribeDiskBackupsRequest req)` This API is used to query the details of backup points.
`DescribeDiskConfigQuotaResponse`	`DescribeDiskConfigQuota(DescribeDiskConfigQuotaRequest req)` This API (DescribeDiskConfigQuota) is used to query the cloud disk quota.
`DescribeDiskOperationLogsResponse`	`DescribeDiskOperationLogs(DescribeDiskOperationLogsRequest req)` 接口已废弃，切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007 This API has been disused.
`DescribeDisksResponse`	`DescribeDisks(DescribeDisksRequest req)` This API (DescribeDisks) is used to query the list of cloud disks.
`DescribeInstancesDiskNumResponse`	`DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)` This API (DescribeInstancesDiskNum) is used to query the number of cloud disks mounted in the instance.
`DescribeSnapshotOperationLogsResponse`	`DescribeSnapshotOperationLogs(DescribeSnapshotOperationLogsRequest req)` 接口已废弃，切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007 This API has been disused.
`DescribeSnapshotsResponse`	`DescribeSnapshots(DescribeSnapshotsRequest req)` This API (DescribeSnapshots) is used to query the details of snapshots.
`DescribeSnapshotSharePermissionResponse`	`DescribeSnapshotSharePermission(DescribeSnapshotSharePermissionRequest req)` This API is used to query the sharing information of snapshots.
`DetachDisksResponse`	`DetachDisks(DetachDisksRequest req)` This API is used to unmount one or more cloud disks.
`GetSnapOverviewResponse`	`GetSnapOverview(GetSnapOverviewRequest req)` This API is used to get snapshot overview information.
`InitializeDisksResponse`	`InitializeDisks(InitializeDisksRequest req)` This API is used to reinitialize the cloud disks.
`InquirePriceModifyDiskBackupQuotaResponse`	`InquirePriceModifyDiskBackupQuota(InquirePriceModifyDiskBackupQuotaRequest req)` This API is used to query the price of a cloud disk after its backup point quota is modified.
`InquirePriceModifyDiskExtraPerformanceResponse`	`InquirePriceModifyDiskExtraPerformance(InquirePriceModifyDiskExtraPerformanceRequest req)` This API is used to query the price for adjusting the cloud disk’s extra performance.
`InquiryPriceCreateDisksResponse`	`InquiryPriceCreateDisks(InquiryPriceCreateDisksRequest req)` This API is used to query the price of creating cloud disks.
`InquiryPriceResizeDiskResponse`	`InquiryPriceResizeDisk(InquiryPriceResizeDiskRequest req)` This API is used to query the price for expanding cloud disks.
`ModifyAutoSnapshotPolicyAttributeResponse`	`ModifyAutoSnapshotPolicyAttribute(ModifyAutoSnapshotPolicyAttributeRequest req)` This API (ModifyAutoSnapshotPolicyAttribute) is used to modify the attributes of an automatic snapshot policy.
`ModifyDiskAttributesResponse`	`ModifyDiskAttributes(ModifyDiskAttributesRequest req)` Only the project ID of elastic cloud disk can be modified.
`ModifyDiskBackupQuotaResponse`	`ModifyDiskBackupQuota(ModifyDiskBackupQuotaRequest req)` This API is used to modify the cloud disk backup point quota.
`ModifyDiskExtraPerformanceResponse`	`ModifyDiskExtraPerformance(ModifyDiskExtraPerformanceRequest req)` This API is used to adjust extra performance for Enhanced SSD (CLOUD_HSSD) and ulTra SSD.
`ModifySnapshotAttributeResponse`	`ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)` This API (ModifySnapshotAttribute) is used to modify the attributes of a specified snapshot.
`ModifySnapshotsSharePermissionResponse`	`ModifySnapshotsSharePermission(ModifySnapshotsSharePermissionRequest req)` This API is used to modify snapshot sharing information.
`ResizeDiskResponse`	`ResizeDisk(ResizeDiskRequest req)` This API is used to expand cloud disks.
`TerminateDisksResponse`	`TerminateDisks(TerminateDisksRequest req)` This API is used to return cloud disks.
`UnbindAutoSnapshotPolicyResponse`	`UnbindAutoSnapshotPolicy(UnbindAutoSnapshotPolicyRequest req)` This API (UnbindAutoSnapshotPolicy) is used to unbind the cloud disk from the specified scheduled snapshot policy.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CbsClient
```
public CbsClient(com.tencentcloudapi.common.Credential credential,
                 String region)
```
  - CbsClient
```
public CbsClient(com.tencentcloudapi.common.Credential credential,
                 String region,
                 com.tencentcloudapi.common.profile.ClientProfile profile)
```
- Method Detail
  - ApplyDiskBackup
```
public ApplyDiskBackupResponse ApplyDiskBackup(ApplyDiskBackupRequest req)
                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to roll back a backup point to the original cloud disk. Only rollback to the original cloud disk is supported. For a data disk backup point, if you want to copy the backup point data to another cloud disk, use the `CreateSnapshot` API to convert the backup point into a snapshot, use the `CreateDisks` API to create an elastic cloud disk, and then copy the snapshot data to it. Only backup points in `NORMAL` status can be rolled back. To query the status of a backup point, call the `DescribeDiskBackups` API and see the `BackupState` field in the response. For an elastic cloud disk, it must be in unattached status. To query the status of the cloud disk, call the `DescribeDisks` API and see the `Attached` field in the response. For a non-elastic cloud disk purchased together with an instance, the instance must be in shutdown status, which can be queried through the `DescribeInstancesStatus` API.
    
    Parameters:
    
    req - ApplyDiskBackupRequest
    
    Returns:
    
    ApplyDiskBackupResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ApplySnapshot
```
public ApplySnapshotResponse ApplySnapshot(ApplySnapshotRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (ApplySnapshot) is used to roll back a snapshot to the original cloud disk. The snapshot can only be rolled back to the original cloud disk. For data disk snapshots, if you need to copy the snapshot data to other cloud disks, use the API [CreateDisks](https://intl.cloud.tencent.com/document/product/362/16312?from_cn_redirect=1) to create an elastic cloud disk and then copy the snapshot data to the created cloud disk. The snapshot for rollback must be in NORMAL status. The snapshot status can be queried in the SnapshotState field in the output parameters through the API [DescribeSnapshots](https://intl.cloud.tencent.com/document/product/362/15647?from_cn_redirect=1). For elastic cloud disks, the cloud disk must be in UNMOUNTED status. The cloud disk status can be queried in the Attached field returned by the API [DescribeDisks](https://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1). For non-elastic cloud disks purchased together with instances, the instance must be in SHUTDOWN status. The instance status can be queried through the API [DescribeInstancesStatus](https://intl.cloud.tencent.com/document/product/213/15738?from_cn_redirect=1).
    
    Parameters:
    
    req - ApplySnapshotRequest
    
    Returns:
    
    ApplySnapshotResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - AttachDisks
```
public AttachDisksResponse AttachDisks(AttachDisksRequest req)
                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to mount one or more cloud disks. Batch operation is supported. You can mount multiple cloud disks to one CVM in a single request. If any of these cloud disks cannot be mounted, the operation fails and a specific error code returns. This is an async API. A successful request indicates that the mounting is initiated. You can call the [DescribeDisks](https://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1) API to query the status of cloud disks. If the status changes from `ATTACHING` to `ATTACHED`, the mounting is successful.
    
    Parameters:
    
    req - AttachDisksRequest
    
    Returns:
    
    AttachDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - BindAutoSnapshotPolicy
```
public BindAutoSnapshotPolicyResponse BindAutoSnapshotPolicy(BindAutoSnapshotPolicyRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (BindAutoSnapshotPolicy) is used to bind the cloud disk to the specified scheduled snapshot policy. For the scheduled snapshot policy limit of each region, see [Scheduled Snapshots](https://intl.cloud.tencent.com/document/product/362/8191?from_cn_redirect=1). When a cloud disk that is bound to a scheduled snapshot policy is in the unused state (that is, an elastic cloud disk has not been mounted or the server of an inelastic disk is powered off) scheduled snapshots are not created.
    
    Parameters:
    
    req - BindAutoSnapshotPolicyRequest
    
    Returns:
    
    BindAutoSnapshotPolicyResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CopySnapshotCrossRegions
```
public CopySnapshotCrossRegionsResponse CopySnapshotCrossRegions(CopySnapshotCrossRegionsRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to replicate a snapshot to another region. This is an async API. A new snapshot ID is issued when the cross-region replication task is generated. It does not mean that the snapshot has been replicated successfully. You can all the [DescribeSnapshots](https://intl.cloud.tencent.com/document/product/362/15647?from_cn_redirect=1) API in the destination region to check for this snapshot. If the snapshot status is `NORMAL`, the snapshot is replicated successfully. The snapshot cross-region replication service will be commercialized in the Q3 of 2022. We will notify users about the commercialization in advance. Please check your messages in the Message Center.
    
    Parameters:
    
    req - CopySnapshotCrossRegionsRequest
    
    Returns:
    
    CopySnapshotCrossRegionsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateAutoSnapshotPolicy
```
public CreateAutoSnapshotPolicyResponse CreateAutoSnapshotPolicy(CreateAutoSnapshotPolicyRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (CreateAutoSnapshotPolicy) is used to create a scheduled snapshot policy. For the limits on the number of scheduled snapshot policies that can be created in each region, see [Scheduled Snapshots](https://intl.cloud.tencent.com/document/product/362/8191?from_cn_redirect=1). The quantity and capacity of the snapshots that can be created in each region are limited. For more information, see the **Snapshots** page on the Tencent Cloud Console. If the number of snapshots exceeds the quota, the creation of the scheduled snapshots will fail.
    
    Parameters:
    
    req - CreateAutoSnapshotPolicyRequest
    
    Returns:
    
    CreateAutoSnapshotPolicyResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateDiskBackup
```
public CreateDiskBackupResponse CreateDiskBackup(CreateDiskBackupRequest req)
                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create a backup point for a cloud disk.
    
    Parameters:
    
    req - CreateDiskBackupRequest
    
    Returns:
    
    CreateDiskBackupResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateDisks
```
public CreateDisksResponse CreateDisks(CreateDisksRequest req)
                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create cloud disks. This API supports creating a cloud disk with a data disk snapshot so that the snapshot data can be copied to the purchased cloud disk. This API is async. A cloud disk ID list will be returned when a request is made successfully, but it does not mean that the creation has been completed. You can call the [DescribeDisks](https://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1) API to query cloud disks by `DiskId`. If a new cloud disk can be found and its status is `UNATTACHED` or `ATTACHED`, the cloud disk has been created successfully.
    
    Parameters:
    
    req - CreateDisksRequest
    
    Returns:
    
    CreateDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - CreateSnapshot
```
public CreateSnapshotResponse CreateSnapshot(CreateSnapshotRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to create a snapshot for the specified cloud disk. You can only create snapshots for cloud disks with the snapshot capability. To check whether a cloud disk is snapshot-enabled, call the [DescribeDisks](https://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1) API and see the `SnapshotAbility` field in the response. For the maximum number of snapshots that can be created, see [Use Limits](https://intl.cloud.tencent.com/doc/product/362/5145?from_cn_redirect=1). Currently, you can convert backup points into general snapshots. After the conversion, snapshot usage fees may be charged, backup points will not be retained, and the occupied backup point quota will be released.
    
    Parameters:
    
    req - CreateSnapshotRequest
    
    Returns:
    
    CreateSnapshotResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteAutoSnapshotPolicies
```
public DeleteAutoSnapshotPoliciesResponse DeleteAutoSnapshotPolicies(DeleteAutoSnapshotPoliciesRequest req)
                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (DeleteAutoSnapshotPolicies) is used to delete scheduled snapshot policies. Batch operations are supported. If one of the scheduled snapshot policies in a batch cannot be deleted, the operation is not performed and a specific error code is returned.
    
    Parameters:
    
    req - DeleteAutoSnapshotPoliciesRequest
    
    Returns:
    
    DeleteAutoSnapshotPoliciesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteDiskBackups
```
public DeleteDiskBackupsResponse DeleteDiskBackups(DeleteDiskBackupsRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete the backup points of the specified cloud disk in batches.
    
    Parameters:
    
    req - DeleteDiskBackupsRequest
    
    Returns:
    
    DeleteDiskBackupsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DeleteSnapshots
```
public DeleteSnapshotsResponse DeleteSnapshots(DeleteSnapshotsRequest req)
                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to delete snapshots. Only snapshots in the `NORMAL` state can be deleted. To query the state of a snapshot, you can call the [DescribeSnapshots](https://intl.cloud.tencent.com/document/product/362/15647?from_cn_redirect=1) API and check the `SnapshotState` field in the response. Batch operations are supported. If there is any snapshot that cannot be deleted, the operation will not be performed and a specific error code will be returned.
    
    Parameters:
    
    req - DeleteSnapshotsRequest
    
    Returns:
    
    DeleteSnapshotsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeAutoSnapshotPolicies
```
public DescribeAutoSnapshotPoliciesResponse DescribeAutoSnapshotPolicies(DescribeAutoSnapshotPoliciesRequest req)
                                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query scheduled snapshot policies. You can filter scheduled snapshot policies by ID, name, state, etc. The relationship between different filters is logical `AND`. For details on filters, see `Filter`. If no parameter is specified, a certain number of scheduled snapshot policies under the current account will be returned. The number is specified by `Limit` and is 20 by default.
    
    Parameters:
    
    req - DescribeAutoSnapshotPoliciesRequest
    
    Returns:
    
    DescribeAutoSnapshotPoliciesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDiskAssociatedAutoSnapshotPolicy
```
public DescribeDiskAssociatedAutoSnapshotPolicyResponse DescribeDiskAssociatedAutoSnapshotPolicy(DescribeDiskAssociatedAutoSnapshotPolicyRequest req)
                                                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (DescribeDiskAssociatedAutoSnapshotPolicy) is used to query the scheduled snapshot policy bound to a cloud disk.
    
    Parameters:
    
    req - DescribeDiskAssociatedAutoSnapshotPolicyRequest
    
    Returns:
    
    DescribeDiskAssociatedAutoSnapshotPolicyResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDiskBackups
```
public DescribeDiskBackupsResponse DescribeDiskBackups(DescribeDiskBackupsRequest req)
                                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the details of backup points. You can filter results by backup point ID. You can also look for certain backup points by specifying the ID or type of the cloud disk for which the backup points are created. The relationship between different filters is logical `AND`. For more information on filters, see `Filter`. If the parameter is empty, a certain number (as specified by `Limit` and 20 by default) of backup points will be returned.
    
    Parameters:
    
    req - DescribeDiskBackupsRequest
    
    Returns:
    
    DescribeDiskBackupsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDiskConfigQuota
```
public DescribeDiskConfigQuotaResponse DescribeDiskConfigQuota(DescribeDiskConfigQuotaRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (DescribeDiskConfigQuota) is used to query the cloud disk quota.
    
    Parameters:
    
    req - DescribeDiskConfigQuotaRequest
    
    Returns:
    
    DescribeDiskConfigQuotaResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDiskOperationLogs
```
public DescribeDiskOperationLogsResponse DescribeDiskOperationLogs(DescribeDiskOperationLogsRequest req)
                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    接口已废弃，切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007 This API has been disused. Use the CloudAudit API instead, For more information, visit https://tapd.woa.com/pro/prong/stories/view/1010114221880719007. This API is used to query the operation logs of a cloud disk. It will be disused soon. Use [LookUpEvents](https://intl.cloud.tencent.com/document/product/629/12359?from_cn_redirect=1) instead.
    
    Parameters:
    
    req - DescribeDiskOperationLogsRequest
    
    Returns:
    
    DescribeDiskOperationLogsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeDisks
```
public DescribeDisksResponse DescribeDisks(DescribeDisksRequest req)
                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (DescribeDisks) is used to query the list of cloud disks. The details of the cloud disk can be queried based on the ID, type or status of the cloud disk. The relationship between different conditions is AND. For more information about filtering, please see the `Filter`. If the parameter is empty, a certain number (specified by `Limit`; the default is 20) of cloud disk lists are returned to the current user.
    
    Parameters:
    
    req - DescribeDisksRequest
    
    Returns:
    
    DescribeDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeInstancesDiskNum
```
public DescribeInstancesDiskNumResponse DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (DescribeInstancesDiskNum) is used to query the number of cloud disks mounted in the instance. Batch operations are supported. If multiple CVM instance IDs are specified, the returned results will list the number of cloud disks mounted on each CVM.
    
    Parameters:
    
    req - DescribeInstancesDiskNumRequest
    
    Returns:
    
    DescribeInstancesDiskNumResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSnapshotOperationLogs
```
public DescribeSnapshotOperationLogsResponse DescribeSnapshotOperationLogs(DescribeSnapshotOperationLogsRequest req)
                                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    接口已废弃，切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007 This API has been disused. Use the CloudAudit API instead, For more information, visit https://tapd.woa.com/pro/prong/stories/view/1010114221880719007. This API is used to query the operation logs of a snapshot. It will be disused soon. Use [LookUpEvents](https://intl.cloud.tencent.com/document/product/629/12359?from_cn_redirect=1) instead.
    
    Parameters:
    
    req - DescribeSnapshotOperationLogsRequest
    
    Returns:
    
    DescribeSnapshotOperationLogsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSnapshotSharePermission
```
public DescribeSnapshotSharePermissionResponse DescribeSnapshotSharePermission(DescribeSnapshotSharePermissionRequest req)
                                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the sharing information of snapshots.
    
    Parameters:
    
    req - DescribeSnapshotSharePermissionRequest
    
    Returns:
    
    DescribeSnapshotSharePermissionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DescribeSnapshots
```
public DescribeSnapshotsResponse DescribeSnapshots(DescribeSnapshotsRequest req)
                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (DescribeSnapshots) is used to query the details of snapshots. Filter the results by the snapshot ID, the ID of cloud disk, for which the snapshot is created, and the type of cloud disk, for which the snapshot is created. The relationship between different conditions is AND. For more information about filtering, please see `Filter`. If the parameter is empty, a certain number (specified by `Limit`; the default is 20) of snapshot lists are returned to the current user.
    
    Parameters:
    
    req - DescribeSnapshotsRequest
    
    Returns:
    
    DescribeSnapshotsResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - DetachDisks
```
public DetachDisksResponse DetachDisks(DetachDisksRequest req)
                                throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to unmount one or more cloud disks. Batch operation is supported. You can unmount multiple cloud disks from the same CVM in a single request. If any of these cloud disks cannot be unmounted, the operation fails and a specific error code returns. This is an async API. A successful request does not mean that the cloud disks have been unmounted successfully. You can call the [DescribeDisks](https://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1) API to query the status of cloud disks. When the status changes from `ATTACHED` to `UNATTACHED`, the unmounting is successful.
    
    Parameters:
    
    req - DetachDisksRequest
    
    Returns:
    
    DetachDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - GetSnapOverview
```
public GetSnapOverviewResponse GetSnapOverview(GetSnapOverviewRequest req)
                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to get snapshot overview information.
    
    Parameters:
    
    req - GetSnapOverviewRequest
    
    Returns:
    
    GetSnapOverviewResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InitializeDisks
```
public InitializeDisksResponse InitializeDisks(InitializeDisksRequest req)
                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to reinitialize the cloud disks. Note the following when reinitializing the cloud disks: 1. For a cloud disk created from a snapshot, it is rolled back to the state of the snapshot; 2. For a cloud disk created from the scratch, all data are cleared. Please check and back up the necessary data before the reinitialization; 3. Currently, you can only re-initialize a cloud disk when it’s not attached to a resource and not shared by others; 4. For a cloud disk created from a snapshot, if the snapshot has been deleted, it cannot be reinitialized.
    
    Parameters:
    
    req - InitializeDisksRequest
    
    Returns:
    
    InitializeDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquirePriceModifyDiskBackupQuota
```
public InquirePriceModifyDiskBackupQuotaResponse InquirePriceModifyDiskBackupQuota(InquirePriceModifyDiskBackupQuotaRequest req)
                                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price of a cloud disk after its backup point quota is modified.
    
    Parameters:
    
    req - InquirePriceModifyDiskBackupQuotaRequest
    
    Returns:
    
    InquirePriceModifyDiskBackupQuotaResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquirePriceModifyDiskExtraPerformance
```
public InquirePriceModifyDiskExtraPerformanceResponse InquirePriceModifyDiskExtraPerformance(InquirePriceModifyDiskExtraPerformanceRequest req)
                                                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price for adjusting the cloud disk’s extra performance.
    
    Parameters:
    
    req - InquirePriceModifyDiskExtraPerformanceRequest
    
    Returns:
    
    InquirePriceModifyDiskExtraPerformanceResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceCreateDisks
```
public InquiryPriceCreateDisksResponse InquiryPriceCreateDisks(InquiryPriceCreateDisksRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price of creating cloud disks. You can query the price of creating multiple cloud disks in a single request. In this case, the price returned will be the total price.
    
    Parameters:
    
    req - InquiryPriceCreateDisksRequest
    
    Returns:
    
    InquiryPriceCreateDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - InquiryPriceResizeDisk
```
public InquiryPriceResizeDiskResponse InquiryPriceResizeDisk(InquiryPriceResizeDiskRequest req)
                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to query the price for expanding cloud disks.
    
    Parameters:
    
    req - InquiryPriceResizeDiskRequest
    
    Returns:
    
    InquiryPriceResizeDiskResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyAutoSnapshotPolicyAttribute
```
public ModifyAutoSnapshotPolicyAttributeResponse ModifyAutoSnapshotPolicyAttribute(ModifyAutoSnapshotPolicyAttributeRequest req)
                                                                            throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (ModifyAutoSnapshotPolicyAttribute) is used to modify the attributes of an automatic snapshot policy. You can use this API to modify the attributes of a scheduled snapshot policy, including the execution policy, name, and activation. When modifying the number of days for retention, you must ensure that there is no clash with the permanent retention attribute. Otherwise, the entire operation will fail and a specific error code will be returned.
    
    Parameters:
    
    req - ModifyAutoSnapshotPolicyAttributeRequest
    
    Returns:
    
    ModifyAutoSnapshotPolicyAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyDiskAttributes
```
public ModifyDiskAttributesResponse ModifyDiskAttributes(ModifyDiskAttributesRequest req)
                                                  throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    Only the project ID of elastic cloud disk can be modified. The project ID of the cloud disk created with the CVM is linked with the CVM. The project ID can be can be queried in the Portable field in the output parameters through the API [DescribeDisks](https://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1). "Cloud disk name" is only used by users for their management. Tencent Cloud does not use the name as the basis for ticket submission or cloud disk management. Batch operations are supported. If multiple cloud disk IDs are specified, all the specified cloud disks must have the same attribute. If there is a cloud disk that does not allow this operation, the operation is not performed and a specific error code is returned.
    
    Parameters:
    
    req - ModifyDiskAttributesRequest
    
    Returns:
    
    ModifyDiskAttributesResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyDiskBackupQuota
```
public ModifyDiskBackupQuotaResponse ModifyDiskBackupQuota(ModifyDiskBackupQuotaRequest req)
                                                    throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify the cloud disk backup point quota.
    
    Parameters:
    
    req - ModifyDiskBackupQuotaRequest
    
    Returns:
    
    ModifyDiskBackupQuotaResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifyDiskExtraPerformance
```
public ModifyDiskExtraPerformanceResponse ModifyDiskExtraPerformance(ModifyDiskExtraPerformanceRequest req)
                                                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to adjust extra performance for Enhanced SSD (CLOUD_HSSD) and ulTra SSD. This API only supports adjust extra performance for Enhanced SSD and ulTra SSD.
    
    Parameters:
    
    req - ModifyDiskExtraPerformanceRequest
    
    Returns:
    
    ModifyDiskExtraPerformanceResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifySnapshotAttribute
```
public ModifySnapshotAttributeResponse ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)
                                                        throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (ModifySnapshotAttribute) is used to modify the attributes of a specified snapshot. Currently, you can only modify snapshot name and change non-permanent snapshots into permanent snapshots. "Snapshot name" is only used by users for their management. Tencent Cloud does not use the name as the basis for ticket submission or snapshot management.
    
    Parameters:
    
    req - ModifySnapshotAttributeRequest
    
    Returns:
    
    ModifySnapshotAttributeResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ModifySnapshotsSharePermission
```
public ModifySnapshotsSharePermissionResponse ModifySnapshotsSharePermission(ModifySnapshotsSharePermissionRequest req)
                                                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to modify snapshot sharing information. After snapshots are shared, the accounts they are shared to can use the snapshot to create cloud disks. Each snapshot can be shared to at most 50 accounts. You can use a shared snapshot to create cloud disks, but you cannot change its name or description. Snapshots can only be shared with accounts in the same region. Only data disk snapshots can be shared.
    
    Parameters:
    
    req - ModifySnapshotsSharePermissionRequest
    
    Returns:
    
    ModifySnapshotsSharePermissionResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - ResizeDisk
```
public ResizeDiskResponse ResizeDisk(ResizeDiskRequest req)
                              throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to expand cloud disks. This API supports only the expansion of elastic cloud disks. To query the type of a cloud disk, you can call the [DescribeDisks](https://intl.cloud.tencent.comhttps://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1?from_cn_redirect=1) API and check the `Portable` field in the response. To expand non-elastic cloud disks, you can call the [ResizeInstanceDisks](https://intl.cloud.tencent.com/document/product/213/15731?from_cn_redirect=1) API. *This is an async API. A successful return of this API does not mean that the cloud disk has been expanded successfully. You can call the [DescribeDisks](https://intl.cloud.tencent.comhttps://intl.cloud.tencent.com/document/product/362/16315?from_cn_redirect=1?from_cn_redirect=1) API to query the status of a cloud disk. `EXPANDING` indicates that the expansion is in process.
    
    Parameters:
    
    req - ResizeDiskRequest
    
    Returns:
    
    ResizeDiskResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - TerminateDisks
```
public TerminateDisksResponse TerminateDisks(TerminateDisksRequest req)
                                      throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API is used to return cloud disks. You can use this API to return cloud disks you no longer need. This API can be used to return pay-as-you-go cloud disks billed on hourly basis. Batch operations are supported. The maximum number of cloud disks in each request is 50. If there is any specified cloud disk that cannot be returned, an error code will be returned.
    
    Parameters:
    
    req - TerminateDisksRequest
    
    Returns:
    
    TerminateDisksResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException
  - UnbindAutoSnapshotPolicy
```
public UnbindAutoSnapshotPolicyResponse UnbindAutoSnapshotPolicy(UnbindAutoSnapshotPolicyRequest req)
                                                          throws com.tencentcloudapi.common.exception.TencentCloudSDKException
```
    This API (UnbindAutoSnapshotPolicy) is used to unbind the cloud disk from the specified scheduled snapshot policy. Batch operations are supported. Multiple cloud disks can be unbound from a snapshot policy at one time. If the passed-in cloud disks are not bound to the current scheduled snapshot policy, they will be skipped. Only cloud disks that are bound to the current scheduled snapshot policy are processed.
    
    Parameters:
    
    req - UnbindAutoSnapshotPolicyRequest
    
    Returns:
    
    UnbindAutoSnapshotPolicyResponse
    
    Throws:
    
    com.tencentcloudapi.common.exception.TencentCloudSDKException

Class CbsClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

CbsClient

CbsClient

Method Detail

ApplyDiskBackup

ApplySnapshot

AttachDisks

BindAutoSnapshotPolicy

CopySnapshotCrossRegions

CreateAutoSnapshotPolicy

CreateDiskBackup

CreateDisks

CreateSnapshot

DeleteAutoSnapshotPolicies

DeleteDiskBackups

DeleteSnapshots

DescribeAutoSnapshotPolicies

DescribeDiskAssociatedAutoSnapshotPolicy

DescribeDiskBackups

DescribeDiskConfigQuota

DescribeDiskOperationLogs

DescribeDisks

DescribeInstancesDiskNum

DescribeSnapshotOperationLogs

DescribeSnapshotSharePermission

DescribeSnapshots

DetachDisks

GetSnapOverview

InitializeDisks

InquirePriceModifyDiskBackupQuota

InquirePriceModifyDiskExtraPerformance

InquiryPriceCreateDisks

InquiryPriceResizeDisk

ModifyAutoSnapshotPolicyAttribute

ModifyDiskAttributes

ModifyDiskBackupQuota

ModifyDiskExtraPerformance

ModifySnapshotAttribute

ModifySnapshotsSharePermission

ResizeDisk

TerminateDisks

UnbindAutoSnapshotPolicy