CbsClient (tencentcloud-sdk-java 3.1.68 API)

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

public class CbsClient
extends AbstractClient

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

Constructor Summary

Constructors
Constructor and Description
`CbsClient(Credential credential, String region)`
`CbsClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplySnapshotResponse`	`ApplySnapshot(ApplySnapshotRequest req)` 本接口（ApplySnapshot）用于回滚快照到原云硬盘。仅支持回滚到原云硬盘上。对于数据盘快照，如果您需要复制快照数据到其它云硬盘上，请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘，将快照数据复制到新购云盘上。用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。如果是弹性云盘，则云盘必须处于未挂载状态，云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询，见Attached字段解释；如果是随实例一起购买的非弹性云盘，则实例必须处于关机状态，实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
`AttachDisksResponse`	`AttachDisks(AttachDisksRequest req)` 本接口（AttachDisks）用于挂载云硬盘。支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘存在不允许挂载的云盘，则操作不执行，以返回特定的错误码返回。本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂载成功。
`BindAutoSnapshotPolicyResponse`	`BindAutoSnapshotPolicy(BindAutoSnapshotPolicyRequest req)` 本接口（BindAutoSnapshotPolicy）用于绑定云硬盘到指定的定期快照策略。每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。当已绑定定期快照策略的云硬盘处于未使用状态（即弹性云盘未挂载或非弹性云盘的主机处于关机状态）将不会创建定期快照。
`CreateAutoSnapshotPolicyResponse`	`CreateAutoSnapshotPolicy(CreateAutoSnapshotPolicyRequest req)` 本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。每个地域可创建的快照有数量和容量的限制，具体请见腾讯云控制台快照页面提示，如果快照超配额，定期快照创建会失败。
`CreateDisksResponse`	`CreateDisks(CreateDisksRequest req)` 本接口（CreateDisks）用于创建云硬盘。预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘，如果能查到云盘，且状态为'UNATTACHED'或'ATTACHED'，则表示创建成功。
`CreateSnapshotResponse`	`CreateSnapshot(CreateSnapshotRequest req)` 本接口（CreateSnapshot）用于对指定云盘创建快照。只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询，见SnapshotAbility字段。可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
`DeleteAutoSnapshotPoliciesResponse`	`DeleteAutoSnapshotPolicies(DeleteAutoSnapshotPoliciesRequest req)` 本接口（DeleteAutoSnapshotPolicies）用于删除定期快照策略。支持批量操作。如果多个定期快照策略存在无法删除的，则操作不执行，以特定错误码返回。
`DeleteSnapshotsResponse`	`DeleteSnapshots(DeleteSnapshotsRequest req)` 本接口（DeleteSnapshots）用于删除快照。快照必须处于NORMAL状态，快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。支持批量操作。如果多个快照存在无法删除的快照，则操作不执行，以返回特定的错误码返回。
`DescribeAutoSnapshotPoliciesResponse`	`DescribeAutoSnapshotPolicies(DescribeAutoSnapshotPoliciesRequest req)` 本接口（DescribeAutoSnapshotPolicies）用于查询定期快照策略。可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的定期快照策略表。
`DescribeDiskAssociatedAutoSnapshotPolicyResponse`	`DescribeDiskAssociatedAutoSnapshotPolicy(DescribeDiskAssociatedAutoSnapshotPolicyRequest req)` 本接口（DescribeDiskAssociatedAutoSnapshotPolicy）用于查询云盘绑定的定期快照策略。
`DescribeDiskConfigQuotaResponse`	`DescribeDiskConfigQuota(DescribeDiskConfigQuotaRequest req)` 本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。
`DescribeDiskOperationLogsResponse`	`DescribeDiskOperationLogs(DescribeDiskOperationLogsRequest req)` 本接口（DescribeDiskOperationLogs）用于查询云盘操作日志列表。可根据云盘ID过滤。云盘ID形如：disk-a1kmcp13。
`DescribeDisksResponse`	`DescribeDisks(DescribeDisksRequest req)` 本接口（DescribeDisks）用于查询云硬盘列表。可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。
`DescribeInstancesDiskNumResponse`	`DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)` 本接口（DescribeInstancesDiskNum）用于查询实例已挂载云硬盘数量。支持批量操作，当传入多个云服务器实例ID，返回结果会分别列出每个云服务器挂载的云硬盘数量。
`DescribeSnapshotOperationLogsResponse`	`DescribeSnapshotOperationLogs(DescribeSnapshotOperationLogsRequest req)` 本接口（DescribeSnapshotOperationLogs）用于查询快照操作日志列表。可根据快照ID过滤。快照ID形如：snap-a1kmcp13。
`DescribeSnapshotsResponse`	`DescribeSnapshots(DescribeSnapshotsRequest req)` 本接口（DescribeSnapshots）用于查询快照的详细信息。根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照列表。
`DescribeSnapshotSharePermissionResponse`	`DescribeSnapshotSharePermission(DescribeSnapshotSharePermissionRequest req)` 本接口（DescribeSnapshotSharePermission）用于查询快照的分享信息。
`DetachDisksResponse`	`DetachDisks(DetachDisksRequest req)` 本接口（DetachDisks）用于解挂云硬盘。支持批量操作，解挂挂载在同一主机上的多块云盘。如果多块云盘存在不允许解挂载的云盘，则操作不执行，以返回特定的错误码返回。本接口为异步接口，当请求成功返回时，云盘并未立即从主机解挂载，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHED”变为“UNATTACHED”，则为解挂载成功。
`GetSnapOverviewResponse`	`GetSnapOverview(GetSnapOverviewRequest req)` 获取快照概览信息
`InquiryPriceCreateDisksResponse`	`InquiryPriceCreateDisks(InquiryPriceCreateDisksRequest req)` 本接口（InquiryPriceCreateDisks）用于创建云硬盘询价。支持查询创建多块云硬盘的价格，此时返回结果为总价格。
`InquiryPriceRenewDisksResponse`	`InquiryPriceRenewDisks(InquiryPriceRenewDisksRequest req)` 本接口（InquiryPriceRenewDisks）用于续费云硬盘询价。只支持查询预付费模式的弹性云盘续费价格。支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到实例续费后的到期时间来续费询价。支持为多块云盘指定不同的续费时长，此时返回的价格为多块云盘续费的总价格。
`InquiryPriceResizeDiskResponse`	`InquiryPriceResizeDisk(InquiryPriceResizeDiskRequest req)` 本接口（InquiryPriceResizeDisk）用于扩容云硬盘询价。只支持预付费模式的云硬盘扩容询价。
`ModifyAutoSnapshotPolicyAttributeResponse`	`ModifyAutoSnapshotPolicyAttribute(ModifyAutoSnapshotPolicyAttributeRequest req)` 本接口（ModifyAutoSnapshotPolicyAttribute）用于修改定期快照策略属性。可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。修改保留天数时必须保证不与是否永久保留属性冲突，否则整个操作失败，以特定的错误码返回。
`ModifyDiskAttributesResponse`	`ModifyDiskAttributes(ModifyDiskAttributesRequest req)` 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。 “云硬盘名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。支持批量操作，如果传入多个云盘ID，则所有云盘修改为同一属性。如果存在不允许操作的云盘，则操作不执行，以特定错误码返回。
`ModifyDisksChargeTypeResponse`	`ModifyDisksChargeType(ModifyDisksChargeTypeRequest req)` 接口请求域名： cbs.tencentcloudapi.com 。本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。非弹性云盘不支持此接口，请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。默认接口请求频率限制：10次/秒。
`ModifyDisksRenewFlagResponse`	`ModifyDisksRenewFlag(ModifyDisksRenewFlagRequest req)` 本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识，支持批量修改。
`ModifySnapshotAttributeResponse`	`ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)` 本接口（ModifySnapshotAttribute）用于修改指定快照的属性。当前仅支持修改快照名称及将非永久快照修改为永久快照。 “快照名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
`ModifySnapshotsSharePermissionResponse`	`ModifySnapshotsSharePermission(ModifySnapshotsSharePermissionRequest req)` 本接口（ModifySnapshotsSharePermission）用于修改快照分享信息。分享快照后，被分享账户可以通过该快照创建云硬盘。每个快照最多可分享给50个账户。分享快照无法更改名称，描述，仅可用于创建云硬盘。只支持分享到对方账户相同地域。仅支持分享数据盘快照。
`RenewDiskResponse`	`RenewDisk(RenewDiskRequest req)` 本接口（RenewDisk）用于续费云硬盘。只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中DiskChargeType字段解释。支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到子机续费后的到期时间来续费。
`ResizeDiskResponse`	`ResizeDisk(ResizeDiskRequest req)` 本接口（ResizeDisk）用于扩容云硬盘。只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。随云主机创建的云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。本接口为异步接口，接口成功返回时，云盘并未立即扩容到指定大小，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态为“EXPANDING”，表示正在扩容中，当状态变为“UNATTACHED”，表示扩容完成。
`TerminateDisksResponse`	`TerminateDisks(TerminateDisksRequest req)` 本接口（TerminateDisks）用于退还云硬盘。不再使用的云盘，可通过本接口主动退还。本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。支持批量操作，每次请求批量云硬盘的上限为50。如果批量云盘存在不允许操作的，请求会以特定错误码返回。
`UnbindAutoSnapshotPolicyResponse`	`UnbindAutoSnapshotPolicy(UnbindAutoSnapshotPolicyRequest req)` 本接口（UnbindAutoSnapshotPolicy）用于解除云硬盘绑定的定期快照策略。支持批量操作，可一次解除多个云盘与同一定期快照策略的绑定。如果传入的云盘未绑定到当前定期快照策略，接口将自动跳过，仅解绑与当前定期快照策略绑定的云盘。

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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

- Constructor Detail
  - CbsClient
```
public CbsClient(Credential credential,
                 String region)
```
  - CbsClient
```
public CbsClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - ApplySnapshot
```
public ApplySnapshotResponse ApplySnapshot(ApplySnapshotRequest req)
                                    throws TencentCloudSDKException
```
    本接口（ApplySnapshot）用于回滚快照到原云硬盘。仅支持回滚到原云硬盘上。对于数据盘快照，如果您需要复制快照数据到其它云硬盘上，请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘，将快照数据复制到新购云盘上。用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。如果是弹性云盘，则云盘必须处于未挂载状态，云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询，见Attached字段解释；如果是随实例一起购买的非弹性云盘，则实例必须处于关机状态，实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
    
    Parameters:
    
    req - ApplySnapshotRequest
    
    Returns:
    
    ApplySnapshotResponse
    
    Throws:
    
    TencentCloudSDKException
  - AttachDisks
```
public AttachDisksResponse AttachDisks(AttachDisksRequest req)
                                throws TencentCloudSDKException
```
    本接口（AttachDisks）用于挂载云硬盘。支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘存在不允许挂载的云盘，则操作不执行，以返回特定的错误码返回。本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂载成功。
    
    Parameters:
    
    req - AttachDisksRequest
    
    Returns:
    
    AttachDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - BindAutoSnapshotPolicy
```
public BindAutoSnapshotPolicyResponse BindAutoSnapshotPolicy(BindAutoSnapshotPolicyRequest req)
                                                      throws TencentCloudSDKException
```
    本接口（BindAutoSnapshotPolicy）用于绑定云硬盘到指定的定期快照策略。每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。当已绑定定期快照策略的云硬盘处于未使用状态（即弹性云盘未挂载或非弹性云盘的主机处于关机状态）将不会创建定期快照。
    
    Parameters:
    
    req - BindAutoSnapshotPolicyRequest
    
    Returns:
    
    BindAutoSnapshotPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateAutoSnapshotPolicy
```
public CreateAutoSnapshotPolicyResponse CreateAutoSnapshotPolicy(CreateAutoSnapshotPolicyRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。每个地域可创建的快照有数量和容量的限制，具体请见腾讯云控制台快照页面提示，如果快照超配额，定期快照创建会失败。
    
    Parameters:
    
    req - CreateAutoSnapshotPolicyRequest
    
    Returns:
    
    CreateAutoSnapshotPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDisks
```
public CreateDisksResponse CreateDisks(CreateDisksRequest req)
                                throws TencentCloudSDKException
```
    本接口（CreateDisks）用于创建云硬盘。预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘，如果能查到云盘，且状态为'UNATTACHED'或'ATTACHED'，则表示创建成功。
    
    Parameters:
    
    req - CreateDisksRequest
    
    Returns:
    
    CreateDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSnapshot
```
public CreateSnapshotResponse CreateSnapshot(CreateSnapshotRequest req)
                                      throws TencentCloudSDKException
```
    本接口（CreateSnapshot）用于对指定云盘创建快照。只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询，见SnapshotAbility字段。可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
    
    Parameters:
    
    req - CreateSnapshotRequest
    
    Returns:
    
    CreateSnapshotResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteAutoSnapshotPolicies
```
public DeleteAutoSnapshotPoliciesResponse DeleteAutoSnapshotPolicies(DeleteAutoSnapshotPoliciesRequest req)
                                                              throws TencentCloudSDKException
```
    本接口（DeleteAutoSnapshotPolicies）用于删除定期快照策略。支持批量操作。如果多个定期快照策略存在无法删除的，则操作不执行，以特定错误码返回。
    
    Parameters:
    
    req - DeleteAutoSnapshotPoliciesRequest
    
    Returns:
    
    DeleteAutoSnapshotPoliciesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteSnapshots
```
public DeleteSnapshotsResponse DeleteSnapshots(DeleteSnapshotsRequest req)
                                        throws TencentCloudSDKException
```
    本接口（DeleteSnapshots）用于删除快照。快照必须处于NORMAL状态，快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。支持批量操作。如果多个快照存在无法删除的快照，则操作不执行，以返回特定的错误码返回。
    
    Parameters:
    
    req - DeleteSnapshotsRequest
    
    Returns:
    
    DeleteSnapshotsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAutoSnapshotPolicies
```
public DescribeAutoSnapshotPoliciesResponse DescribeAutoSnapshotPolicies(DescribeAutoSnapshotPoliciesRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口（DescribeAutoSnapshotPolicies）用于查询定期快照策略。可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的定期快照策略表。
    
    Parameters:
    
    req - DescribeAutoSnapshotPoliciesRequest
    
    Returns:
    
    DescribeAutoSnapshotPoliciesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDiskAssociatedAutoSnapshotPolicy
```
public DescribeDiskAssociatedAutoSnapshotPolicyResponse DescribeDiskAssociatedAutoSnapshotPolicy(DescribeDiskAssociatedAutoSnapshotPolicyRequest req)
                                                                                          throws TencentCloudSDKException
```
    本接口（DescribeDiskAssociatedAutoSnapshotPolicy）用于查询云盘绑定的定期快照策略。
    
    Parameters:
    
    req - DescribeDiskAssociatedAutoSnapshotPolicyRequest
    
    Returns:
    
    DescribeDiskAssociatedAutoSnapshotPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDiskConfigQuota
```
public DescribeDiskConfigQuotaResponse DescribeDiskConfigQuota(DescribeDiskConfigQuotaRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。
    
    Parameters:
    
    req - DescribeDiskConfigQuotaRequest
    
    Returns:
    
    DescribeDiskConfigQuotaResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDiskOperationLogs
```
public DescribeDiskOperationLogsResponse DescribeDiskOperationLogs(DescribeDiskOperationLogsRequest req)
                                                            throws TencentCloudSDKException
```
    本接口（DescribeDiskOperationLogs）用于查询云盘操作日志列表。可根据云盘ID过滤。云盘ID形如：disk-a1kmcp13。
    
    Parameters:
    
    req - DescribeDiskOperationLogsRequest
    
    Returns:
    
    DescribeDiskOperationLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDisks
```
public DescribeDisksResponse DescribeDisks(DescribeDisksRequest req)
                                    throws TencentCloudSDKException
```
    本接口（DescribeDisks）用于查询云硬盘列表。可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。
    
    Parameters:
    
    req - DescribeDisksRequest
    
    Returns:
    
    DescribeDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstancesDiskNum
```
public DescribeInstancesDiskNumResponse DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（DescribeInstancesDiskNum）用于查询实例已挂载云硬盘数量。支持批量操作，当传入多个云服务器实例ID，返回结果会分别列出每个云服务器挂载的云硬盘数量。
    
    Parameters:
    
    req - DescribeInstancesDiskNumRequest
    
    Returns:
    
    DescribeInstancesDiskNumResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSnapshotOperationLogs
```
public DescribeSnapshotOperationLogsResponse DescribeSnapshotOperationLogs(DescribeSnapshotOperationLogsRequest req)
                                                                    throws TencentCloudSDKException
```
    本接口（DescribeSnapshotOperationLogs）用于查询快照操作日志列表。可根据快照ID过滤。快照ID形如：snap-a1kmcp13。
    
    Parameters:
    
    req - DescribeSnapshotOperationLogsRequest
    
    Returns:
    
    DescribeSnapshotOperationLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSnapshotSharePermission
```
public DescribeSnapshotSharePermissionResponse DescribeSnapshotSharePermission(DescribeSnapshotSharePermissionRequest req)
                                                                        throws TencentCloudSDKException
```
    本接口（DescribeSnapshotSharePermission）用于查询快照的分享信息。
    
    Parameters:
    
    req - DescribeSnapshotSharePermissionRequest
    
    Returns:
    
    DescribeSnapshotSharePermissionResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSnapshots
```
public DescribeSnapshotsResponse DescribeSnapshots(DescribeSnapshotsRequest req)
                                            throws TencentCloudSDKException
```
    本接口（DescribeSnapshots）用于查询快照的详细信息。根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照列表。
    
    Parameters:
    
    req - DescribeSnapshotsRequest
    
    Returns:
    
    DescribeSnapshotsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DetachDisks
```
public DetachDisksResponse DetachDisks(DetachDisksRequest req)
                                throws TencentCloudSDKException
```
    本接口（DetachDisks）用于解挂云硬盘。支持批量操作，解挂挂载在同一主机上的多块云盘。如果多块云盘存在不允许解挂载的云盘，则操作不执行，以返回特定的错误码返回。本接口为异步接口，当请求成功返回时，云盘并未立即从主机解挂载，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHED”变为“UNATTACHED”，则为解挂载成功。
    
    Parameters:
    
    req - DetachDisksRequest
    
    Returns:
    
    DetachDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - GetSnapOverview
```
public GetSnapOverviewResponse GetSnapOverview(GetSnapOverviewRequest req)
                                        throws TencentCloudSDKException
```
    获取快照概览信息
    
    Parameters:
    
    req - GetSnapOverviewRequest
    
    Returns:
    
    GetSnapOverviewResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquiryPriceCreateDisks
```
public InquiryPriceCreateDisksResponse InquiryPriceCreateDisks(InquiryPriceCreateDisksRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（InquiryPriceCreateDisks）用于创建云硬盘询价。支持查询创建多块云硬盘的价格，此时返回结果为总价格。
    
    Parameters:
    
    req - InquiryPriceCreateDisksRequest
    
    Returns:
    
    InquiryPriceCreateDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquiryPriceRenewDisks
```
public InquiryPriceRenewDisksResponse InquiryPriceRenewDisks(InquiryPriceRenewDisksRequest req)
                                                      throws TencentCloudSDKException
```
    本接口（InquiryPriceRenewDisks）用于续费云硬盘询价。只支持查询预付费模式的弹性云盘续费价格。支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到实例续费后的到期时间来续费询价。支持为多块云盘指定不同的续费时长，此时返回的价格为多块云盘续费的总价格。
    
    Parameters:
    
    req - InquiryPriceRenewDisksRequest
    
    Returns:
    
    InquiryPriceRenewDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquiryPriceResizeDisk
```
public InquiryPriceResizeDiskResponse InquiryPriceResizeDisk(InquiryPriceResizeDiskRequest req)
                                                      throws TencentCloudSDKException
```
    本接口（InquiryPriceResizeDisk）用于扩容云硬盘询价。只支持预付费模式的云硬盘扩容询价。
    
    Parameters:
    
    req - InquiryPriceResizeDiskRequest
    
    Returns:
    
    InquiryPriceResizeDiskResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyAutoSnapshotPolicyAttribute
```
public ModifyAutoSnapshotPolicyAttributeResponse ModifyAutoSnapshotPolicyAttribute(ModifyAutoSnapshotPolicyAttributeRequest req)
                                                                            throws TencentCloudSDKException
```
    本接口（ModifyAutoSnapshotPolicyAttribute）用于修改定期快照策略属性。可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。修改保留天数时必须保证不与是否永久保留属性冲突，否则整个操作失败，以特定的错误码返回。
    
    Parameters:
    
    req - ModifyAutoSnapshotPolicyAttributeRequest
    
    Returns:
    
    ModifyAutoSnapshotPolicyAttributeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDiskAttributes
```
public ModifyDiskAttributesResponse ModifyDiskAttributes(ModifyDiskAttributesRequest req)
                                                  throws TencentCloudSDKException
```
    只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。 “云硬盘名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。支持批量操作，如果传入多个云盘ID，则所有云盘修改为同一属性。如果存在不允许操作的云盘，则操作不执行，以特定错误码返回。
    
    Parameters:
    
    req - ModifyDiskAttributesRequest
    
    Returns:
    
    ModifyDiskAttributesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDisksChargeType
```
public ModifyDisksChargeTypeResponse ModifyDisksChargeType(ModifyDisksChargeTypeRequest req)
                                                    throws TencentCloudSDKException
```
    接口请求域名： cbs.tencentcloudapi.com 。本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。非弹性云盘不支持此接口，请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。默认接口请求频率限制：10次/秒。
    
    Parameters:
    
    req - ModifyDisksChargeTypeRequest
    
    Returns:
    
    ModifyDisksChargeTypeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDisksRenewFlag
```
public ModifyDisksRenewFlagResponse ModifyDisksRenewFlag(ModifyDisksRenewFlagRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识，支持批量修改。
    
    Parameters:
    
    req - ModifyDisksRenewFlagRequest
    
    Returns:
    
    ModifyDisksRenewFlagResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySnapshotAttribute
```
public ModifySnapshotAttributeResponse ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（ModifySnapshotAttribute）用于修改指定快照的属性。当前仅支持修改快照名称及将非永久快照修改为永久快照。 “快照名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
    
    Parameters:
    
    req - ModifySnapshotAttributeRequest
    
    Returns:
    
    ModifySnapshotAttributeResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifySnapshotsSharePermission
```
public ModifySnapshotsSharePermissionResponse ModifySnapshotsSharePermission(ModifySnapshotsSharePermissionRequest req)
                                                                      throws TencentCloudSDKException
```
    本接口（ModifySnapshotsSharePermission）用于修改快照分享信息。分享快照后，被分享账户可以通过该快照创建云硬盘。每个快照最多可分享给50个账户。分享快照无法更改名称，描述，仅可用于创建云硬盘。只支持分享到对方账户相同地域。仅支持分享数据盘快照。
    
    Parameters:
    
    req - ModifySnapshotsSharePermissionRequest
    
    Returns:
    
    ModifySnapshotsSharePermissionResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenewDisk
```
public RenewDiskResponse RenewDisk(RenewDiskRequest req)
                            throws TencentCloudSDKException
```
    本接口（RenewDisk）用于续费云硬盘。只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中DiskChargeType字段解释。支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到子机续费后的到期时间来续费。
    
    Parameters:
    
    req - RenewDiskRequest
    
    Returns:
    
    RenewDiskResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResizeDisk
```
public ResizeDiskResponse ResizeDisk(ResizeDiskRequest req)
                              throws TencentCloudSDKException
```
    本接口（ResizeDisk）用于扩容云硬盘。只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。随云主机创建的云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。本接口为异步接口，接口成功返回时，云盘并未立即扩容到指定大小，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态为“EXPANDING”，表示正在扩容中，当状态变为“UNATTACHED”，表示扩容完成。
    
    Parameters:
    
    req - ResizeDiskRequest
    
    Returns:
    
    ResizeDiskResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateDisks
```
public TerminateDisksResponse TerminateDisks(TerminateDisksRequest req)
                                      throws TencentCloudSDKException
```
    本接口（TerminateDisks）用于退还云硬盘。不再使用的云盘，可通过本接口主动退还。本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。支持批量操作，每次请求批量云硬盘的上限为50。如果批量云盘存在不允许操作的，请求会以特定错误码返回。
    
    Parameters:
    
    req - TerminateDisksRequest
    
    Returns:
    
    TerminateDisksResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindAutoSnapshotPolicy
```
public UnbindAutoSnapshotPolicyResponse UnbindAutoSnapshotPolicy(UnbindAutoSnapshotPolicyRequest req)
                                                          throws TencentCloudSDKException
```
    本接口（UnbindAutoSnapshotPolicy）用于解除云硬盘绑定的定期快照策略。支持批量操作，可一次解除多个云盘与同一定期快照策略的绑定。如果传入的云盘未绑定到当前定期快照策略，接口将自动跳过，仅解绑与当前定期快照策略绑定的云盘。
    
    Parameters:
    
    req - UnbindAutoSnapshotPolicyRequest
    
    Returns:
    
    UnbindAutoSnapshotPolicyResponse
    
    Throws:
    
    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

ApplySnapshot

AttachDisks

BindAutoSnapshotPolicy

CreateAutoSnapshotPolicy

CreateDisks

CreateSnapshot

DeleteAutoSnapshotPolicies

DeleteSnapshots

DescribeAutoSnapshotPolicies

DescribeDiskAssociatedAutoSnapshotPolicy

DescribeDiskConfigQuota

DescribeDiskOperationLogs

DescribeDisks

DescribeInstancesDiskNum

DescribeSnapshotOperationLogs

DescribeSnapshotSharePermission

DescribeSnapshots

DetachDisks

GetSnapOverview

InquiryPriceCreateDisks

InquiryPriceRenewDisks

InquiryPriceResizeDisk

ModifyAutoSnapshotPolicyAttribute

ModifyDiskAttributes

ModifyDisksChargeType

ModifyDisksRenewFlag

ModifySnapshotAttribute

ModifySnapshotsSharePermission

RenewDisk

ResizeDisk

TerminateDisks

UnbindAutoSnapshotPolicy