# -*- coding: utf8 -*-
# Copyright (c) 2017-2021 THL A29 Limited, a Tencent company. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import json
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.common.abstract_client import AbstractClient
from tencentcloud.cbs.v20170312 import models
class CbsClient(AbstractClient):
_apiVersion = '2017-03-12'
_endpoint = 'cbs.tencentcloudapi.com'
_service = 'cbs'
def ApplyDiskBackup(self, request):
"""本接口（ApplyDiskBackup）用于回滚备份点到原云硬盘。
* 仅支持回滚到原云硬盘上。对于数据盘备份点，如果您需要复制备份点数据到其它云硬盘上，请先使用 CreateSnapshot 将备份点转换为快照，然后使用 CreateDisks 接口创建新的弹性云硬盘，将快照数据复制到新购云硬盘上。
* 用于回滚的备份点必须处于NORMAL状态。备份点状态可以通过DescribeDiskBackups接口查询，见输出参数中BackupState字段解释。
* 如果是弹性云硬盘，则云硬盘必须处于未挂载状态，云硬盘挂载状态可以通过DescribeDisks接口查询，见Attached字段解释；如果是随实例一起购买的非弹性云硬盘，则实例必须处于关机状态，实例状态可以通过DescribeInstancesStatus接口查询。
:param request: Request instance for ApplyDiskBackup.
:type request: :class:`tencentcloud.cbs.v20170312.models.ApplyDiskBackupRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ApplyDiskBackupResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ApplyDiskBackup", params, headers=headers)
response = json.loads(body)
model = models.ApplyDiskBackupResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ApplySnapshot(self, request):
"""本接口（ApplySnapshot）用于回滚快照到原云硬盘。
* 仅支持回滚到原云硬盘上。对于数据盘快照，如果您需要复制快照数据到其它云硬盘上，请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘，将快照数据复制到新购云盘上。
* 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。
* 如果是弹性云盘，则云盘必须处于未挂载状态，云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询，见Attached字段解释；如果是随实例一起购买的非弹性云盘，则实例必须处于关机状态，实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
:param request: Request instance for ApplySnapshot.
:type request: :class:`tencentcloud.cbs.v20170312.models.ApplySnapshotRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ApplySnapshotResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ApplySnapshot", params, headers=headers)
response = json.loads(body)
model = models.ApplySnapshotResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ApplySnapshotGroup(self, request):
"""本接口（ApplySnapshotGroup）用于回滚快照组，将实例恢复到创建快照组时刻的状态。
* 1.可选择快照组全部或部分盘进行回滚；
* 2.如果回滚的盘中包含已挂载的盘，要求这些盘必须挂载在同一实例上，且要求该实例已关机才能回滚；
* 3.回滚为异步操作，接口返回成功不代表回滚成功，可通过调DescribeSnapshotGroups接口查询快照组的状态。
:param request: Request instance for ApplySnapshotGroup.
:type request: :class:`tencentcloud.cbs.v20170312.models.ApplySnapshotGroupRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ApplySnapshotGroupResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ApplySnapshotGroup", params, headers=headers)
response = json.loads(body)
model = models.ApplySnapshotGroupResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def AttachDisks(self, request):
"""本接口（AttachDisks）用于挂载云硬盘。
* 支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘，则操作不执行，返回特定的错误码。
* 本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂载成功。
:param request: Request instance for AttachDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.AttachDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.AttachDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("AttachDisks", params, headers=headers)
response = json.loads(body)
model = models.AttachDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def BindAutoSnapshotPolicy(self, request):
"""本接口（BindAutoSnapshotPolicy）用于绑定云硬盘到指定的定期快照策略。
* 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
* 当已绑定定期快照策略的云硬盘处于未使用状态（即弹性云盘未挂载或非弹性云盘的主机处于关机状态）将不会创建定期快照。
:param request: Request instance for BindAutoSnapshotPolicy.
:type request: :class:`tencentcloud.cbs.v20170312.models.BindAutoSnapshotPolicyRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.BindAutoSnapshotPolicyResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("BindAutoSnapshotPolicy", params, headers=headers)
response = json.loads(body)
model = models.BindAutoSnapshotPolicyResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CopySnapshotCrossRegions(self, request):
"""本接口（CopySnapshotCrossRegions）用于快照跨地域复制。
* 本接口为异步接口，当跨地域复制的请求下发成功后会返回一个新的快照ID，此时快照未立即复制到目标地域，可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态，判断是否复制完成。如果快照的状态为“NORMAL”，表示快照复制完成。
* 本接口实现的快照跨地域复制操作将产生跨地域流量，预计2022年第三季度会针对此功能进行商业化计费；请留意后续站内信公告，避免产生预期外扣费。
:param request: Request instance for CopySnapshotCrossRegions.
:type request: :class:`tencentcloud.cbs.v20170312.models.CopySnapshotCrossRegionsRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.CopySnapshotCrossRegionsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CopySnapshotCrossRegions", params, headers=headers)
response = json.loads(body)
model = models.CopySnapshotCrossRegionsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateAutoSnapshotPolicy(self, request):
"""本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。
* 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
* 每个地域可创建的快照有数量和容量的限制，具体请见腾讯云控制台快照页面提示，如果快照超配额，定期快照创建会失败。
:param request: Request instance for CreateAutoSnapshotPolicy.
:type request: :class:`tencentcloud.cbs.v20170312.models.CreateAutoSnapshotPolicyRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.CreateAutoSnapshotPolicyResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateAutoSnapshotPolicy", params, headers=headers)
response = json.loads(body)
model = models.CreateAutoSnapshotPolicyResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateDiskBackup(self, request):
"""为云硬盘创建一个备份点。
:param request: Request instance for CreateDiskBackup.
:type request: :class:`tencentcloud.cbs.v20170312.models.CreateDiskBackupRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.CreateDiskBackupResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateDiskBackup", params, headers=headers)
response = json.loads(body)
model = models.CreateDiskBackupResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateDisks(self, request):
"""本接口（CreateDisks）用于创建云硬盘。
* 预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。
* 本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。
* 本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘，如果能查到云盘，且状态为'UNATTACHED'或'ATTACHED'，则表示创建成功。
:param request: Request instance for CreateDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.CreateDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.CreateDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateDisks", params, headers=headers)
response = json.loads(body)
model = models.CreateDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateSnapshot(self, request):
"""本接口（CreateSnapshot）用于对指定云盘创建快照。
* 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询，见SnapshotAbility字段。
* 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
* 当前支持将备份点转化为普通快照，转化之后可能会收取快照使用费用，备份点不保留，其占用的备份点配额也将被释放。
:param request: Request instance for CreateSnapshot.
:type request: :class:`tencentcloud.cbs.v20170312.models.CreateSnapshotRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.CreateSnapshotResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateSnapshot", params, headers=headers)
response = json.loads(body)
model = models.CreateSnapshotResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def CreateSnapshotGroup(self, request):
"""本接口（CreateSnapshotGroup）用于创建快照组。
* 创建快照组的云硬盘列表必须挂载在同一实例上；
* 可选择挂载在实例上的全部或部分盘创建快照组。
:param request: Request instance for CreateSnapshotGroup.
:type request: :class:`tencentcloud.cbs.v20170312.models.CreateSnapshotGroupRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.CreateSnapshotGroupResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("CreateSnapshotGroup", params, headers=headers)
response = json.loads(body)
model = models.CreateSnapshotGroupResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DeleteAutoSnapshotPolicies(self, request):
"""本接口（DeleteAutoSnapshotPolicies）用于删除定期快照策略。
* 支持批量操作。如果多个定期快照策略存在无法删除的，则操作不执行，以特定错误码返回。
:param request: Request instance for DeleteAutoSnapshotPolicies.
:type request: :class:`tencentcloud.cbs.v20170312.models.DeleteAutoSnapshotPoliciesRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DeleteAutoSnapshotPoliciesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteAutoSnapshotPolicies", params, headers=headers)
response = json.loads(body)
model = models.DeleteAutoSnapshotPoliciesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DeleteDiskBackups(self, request):
"""批量删除指定的云硬盘备份点。
:param request: Request instance for DeleteDiskBackups.
:type request: :class:`tencentcloud.cbs.v20170312.models.DeleteDiskBackupsRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DeleteDiskBackupsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteDiskBackups", params, headers=headers)
response = json.loads(body)
model = models.DeleteDiskBackupsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DeleteSnapshotGroup(self, request):
"""本接口（DeleteSnapshotGroup）用于删除快照组，一次调用仅支持删除一个快照组。
* 默认会删除快照组内的所有快照；
* 如果快照组内的快照有关联镜像，则删除失败，所有快照均不会删除；如果需要同时删除快照绑定的镜像，可传入参数DeleteBindImages等于true。
:param request: Request instance for DeleteSnapshotGroup.
:type request: :class:`tencentcloud.cbs.v20170312.models.DeleteSnapshotGroupRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DeleteSnapshotGroupResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteSnapshotGroup", params, headers=headers)
response = json.loads(body)
model = models.DeleteSnapshotGroupResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DeleteSnapshots(self, request):
"""本接口（DeleteSnapshots）用于删除快照。
* 快照必须处于NORMAL状态，快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。
* 支持批量操作。如果多个快照存在无法删除的快照，则操作不执行，以特定的错误码返回。
:param request: Request instance for DeleteSnapshots.
:type request: :class:`tencentcloud.cbs.v20170312.models.DeleteSnapshotsRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DeleteSnapshotsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DeleteSnapshots", params, headers=headers)
response = json.loads(body)
model = models.DeleteSnapshotsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeAutoSnapshotPolicies(self, request):
"""本接口（DescribeAutoSnapshotPolicies）用于查询定期快照策略。
* 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
* 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的定期快照策略表。
:param request: Request instance for DescribeAutoSnapshotPolicies.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeAutoSnapshotPoliciesRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeAutoSnapshotPoliciesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeAutoSnapshotPolicies", params, headers=headers)
response = json.loads(body)
model = models.DescribeAutoSnapshotPoliciesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeDiskAssociatedAutoSnapshotPolicy(self, request):
"""本接口（DescribeDiskAssociatedAutoSnapshotPolicy）用于查询云盘绑定的定期快照策略。
:param request: Request instance for DescribeDiskAssociatedAutoSnapshotPolicy.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskAssociatedAutoSnapshotPolicyRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskAssociatedAutoSnapshotPolicyResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeDiskAssociatedAutoSnapshotPolicy", params, headers=headers)
response = json.loads(body)
model = models.DescribeDiskAssociatedAutoSnapshotPolicyResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeDiskBackups(self, request):
"""本接口（DescribeDiskBackups）用于查询备份点的详细信息。
根据备份点ID、创建备份点的云硬盘ID、创建备份点的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的备份点列表。
:param request: Request instance for DescribeDiskBackups.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskBackupsRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskBackupsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeDiskBackups", params, headers=headers)
response = json.loads(body)
model = models.DescribeDiskBackupsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeDiskConfigQuota(self, request):
"""本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。
:param request: Request instance for DescribeDiskConfigQuota.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskConfigQuotaRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskConfigQuotaResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeDiskConfigQuota", params, headers=headers)
response = json.loads(body)
model = models.DescribeDiskConfigQuotaResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeDiskStoragePool(self, request):
"""本接口（DescribeDiskStoragePool）查询用户的云硬盘独享集群列表。
* 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息，不同的过滤条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
* 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘独享集群列表。
:param request: Request instance for DescribeDiskStoragePool.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskStoragePoolRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskStoragePoolResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeDiskStoragePool", params, headers=headers)
response = json.loads(body)
model = models.DescribeDiskStoragePoolResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeDisks(self, request):
"""本接口（DescribeDisks）用于查询云硬盘列表。
* 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
* 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。
:param request: Request instance for DescribeDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeDisks", params, headers=headers)
response = json.loads(body)
model = models.DescribeDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeInstancesDiskNum(self, request):
"""本接口（DescribeInstancesDiskNum）用于查询实例已挂载云硬盘数量。
* 支持批量操作，当传入多个云服务器实例ID，返回结果会分别列出每个云服务器挂载的云硬盘数量。
:param request: Request instance for DescribeInstancesDiskNum.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeInstancesDiskNumRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeInstancesDiskNumResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeInstancesDiskNum", params, headers=headers)
response = json.loads(body)
model = models.DescribeInstancesDiskNumResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeSnapshotGroups(self, request):
"""本接口（DescribeSnapshotGroups）用于查询快照组列表。
* 可以根据快照组ID、快照组状态、快照组关联的快照ID等来查询快照组列表，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
* 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照组列表。
:param request: Request instance for DescribeSnapshotGroups.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotGroupsRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotGroupsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeSnapshotGroups", params, headers=headers)
response = json.loads(body)
model = models.DescribeSnapshotGroupsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeSnapshotOverview(self, request):
"""该接口用于查询用户快照使用概览，包括快照总容量、计费容量等信息。
:param request: Request instance for DescribeSnapshotOverview.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotOverviewRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotOverviewResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeSnapshotOverview", params, headers=headers)
response = json.loads(body)
model = models.DescribeSnapshotOverviewResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeSnapshotSharePermission(self, request):
"""本接口（DescribeSnapshotSharePermission）用于查询快照的分享信息。
:param request: Request instance for DescribeSnapshotSharePermission.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotSharePermissionRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotSharePermissionResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeSnapshotSharePermission", params, headers=headers)
response = json.loads(body)
model = models.DescribeSnapshotSharePermissionResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DescribeSnapshots(self, request):
"""本接口（DescribeSnapshots）用于查询快照的详细信息。
* 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
* 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照列表。
:param request: Request instance for DescribeSnapshots.
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotsRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotsResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DescribeSnapshots", params, headers=headers)
response = json.loads(body)
model = models.DescribeSnapshotsResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def DetachDisks(self, request):
"""本接口（DetachDisks）用于卸载云硬盘。
* 支持批量操作，卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘，则操作不执行，返回特定的错误码。
* 本接口为异步接口，当请求成功返回时，云盘并未立即从主机卸载，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHED”变为“UNATTACHED”，则为卸载成功。
:param request: Request instance for DetachDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.DetachDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.DetachDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("DetachDisks", params, headers=headers)
response = json.loads(body)
model = models.DetachDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def GetSnapOverview(self, request):
"""为进一步规范化API命名，该接口决定预下线，新接口命名为：DescribeSnapshotOverview
获取快照概览信息
:param request: Request instance for GetSnapOverview.
:type request: :class:`tencentcloud.cbs.v20170312.models.GetSnapOverviewRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.GetSnapOverviewResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("GetSnapOverview", params, headers=headers)
response = json.loads(body)
model = models.GetSnapOverviewResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InitializeDisks(self, request):
"""重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点：
1. 如果云硬盘是由快照创建的，则重新初始化会通过此快照重新回滚此云硬盘，即将云硬盘恢复为与快照一致的状态；
2. 如果云硬盘不是通过快照创建的，则重新初始化会清空此云硬盘的数据；请在重新初始化云硬盘前检查并备份必要的数据；
3. 当前仅未挂载的、非共享属性的数据盘云硬盘支持重新初始化；
4. 当创建此云硬盘的原始快照被删除时，不再支持重新初始化此云硬盘。
:param request: Request instance for InitializeDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.InitializeDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.InitializeDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InitializeDisks", params, headers=headers)
response = json.loads(body)
model = models.InitializeDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InquirePriceModifyDiskBackupQuota(self, request):
"""本接口（InquirePricePriceModifyDiskBackupQuota）用于修改云硬盘备份点配额询价。
:param request: Request instance for InquirePriceModifyDiskBackupQuota.
:type request: :class:`tencentcloud.cbs.v20170312.models.InquirePriceModifyDiskBackupQuotaRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.InquirePriceModifyDiskBackupQuotaResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InquirePriceModifyDiskBackupQuota", params, headers=headers)
response = json.loads(body)
model = models.InquirePriceModifyDiskBackupQuotaResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InquirePriceModifyDiskExtraPerformance(self, request):
"""本接口（InquirePriceModifyDiskExtraPerformance）用于调整云硬盘额外性能询价。
:param request: Request instance for InquirePriceModifyDiskExtraPerformance.
:type request: :class:`tencentcloud.cbs.v20170312.models.InquirePriceModifyDiskExtraPerformanceRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.InquirePriceModifyDiskExtraPerformanceResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InquirePriceModifyDiskExtraPerformance", params, headers=headers)
response = json.loads(body)
model = models.InquirePriceModifyDiskExtraPerformanceResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InquiryPriceCreateDisks(self, request):
"""本接口（InquiryPriceCreateDisks）用于创建云硬盘询价。
* 支持查询创建多块云硬盘的价格，此时返回结果为总价格。
:param request: Request instance for InquiryPriceCreateDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceCreateDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceCreateDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InquiryPriceCreateDisks", params, headers=headers)
response = json.loads(body)
model = models.InquiryPriceCreateDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InquiryPriceRenewDisks(self, request):
"""本接口（InquiryPriceRenewDisks）用于续费云硬盘询价。
* 只支持查询预付费模式的弹性云盘续费价格。
* 支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到实例续费后的到期时间来续费询价。
* 支持为多块云盘指定不同的续费时长，此时返回的价格为多块云盘续费的总价格。
:param request: Request instance for InquiryPriceRenewDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceRenewDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceRenewDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InquiryPriceRenewDisks", params, headers=headers)
response = json.loads(body)
model = models.InquiryPriceRenewDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def InquiryPriceResizeDisk(self, request):
"""本接口（InquiryPriceResizeDisk）用于扩容云硬盘询价。
:param request: Request instance for InquiryPriceResizeDisk.
:type request: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceResizeDiskRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceResizeDiskResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("InquiryPriceResizeDisk", params, headers=headers)
response = json.loads(body)
model = models.InquiryPriceResizeDiskResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyAutoSnapshotPolicyAttribute(self, request):
"""本接口（ModifyAutoSnapshotPolicyAttribute）用于修改定期快照策略属性。
* 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
* 修改保留天数时必须保证不与是否永久保留属性冲突，否则整个操作失败，以特定的错误码返回。
:param request: Request instance for ModifyAutoSnapshotPolicyAttribute.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyAutoSnapshotPolicyAttributeRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifyAutoSnapshotPolicyAttributeResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyAutoSnapshotPolicyAttribute", params, headers=headers)
response = json.loads(body)
model = models.ModifyAutoSnapshotPolicyAttributeResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyDiskAttributes(self, request):
"""* 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。
* “云硬盘名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
* 支持批量操作，如果传入多个云盘ID，则所有云盘修改为同一属性。如果存在不允许操作的云盘，则操作不执行，以特定错误码返回。
:param request: Request instance for ModifyDiskAttributes.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskAttributesRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskAttributesResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyDiskAttributes", params, headers=headers)
response = json.loads(body)
model = models.ModifyDiskAttributesResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyDiskBackupQuota(self, request):
"""此接口 (ModifyDiskBackupQuota) 用于修改云硬盘备份点配额。
:param request: Request instance for ModifyDiskBackupQuota.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskBackupQuotaRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskBackupQuotaResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyDiskBackupQuota", params, headers=headers)
response = json.loads(body)
model = models.ModifyDiskBackupQuotaResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyDiskExtraPerformance(self, request):
"""本接口（ModifyDiskExtraPerformance）用于调整云硬盘额外的性能。
* 目前仅支持增强型SSD云硬盘(CLOUD_HSSD)和极速型SSD云硬盘（CLOUD_TSSD）。
:param request: Request instance for ModifyDiskExtraPerformance.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskExtraPerformanceRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskExtraPerformanceResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyDiskExtraPerformance", params, headers=headers)
response = json.loads(body)
model = models.ModifyDiskExtraPerformanceResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyDisksChargeType(self, request):
"""本接口 (ModifyDisksChargeType) 用于切换云硬盘的计费模式。
非弹性云硬盘不支持此接口，请通过修改实例计费模式接口将实例连同非弹性云硬盘一起转换。
默认接口请求频率限制：10次/秒。
:param request: Request instance for ModifyDisksChargeType.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDisksChargeTypeRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifyDisksChargeTypeResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyDisksChargeType", params, headers=headers)
response = json.loads(body)
model = models.ModifyDisksChargeTypeResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifyDisksRenewFlag(self, request):
"""本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识，支持批量修改。
:param request: Request instance for ModifyDisksRenewFlag.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDisksRenewFlagRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifyDisksRenewFlagResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifyDisksRenewFlag", params, headers=headers)
response = json.loads(body)
model = models.ModifyDisksRenewFlagResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifySnapshotAttribute(self, request):
"""本接口（ModifySnapshotAttribute）用于修改指定快照的属性。
* 本接口支持修改快照名称及到期时间，以及将非永久快照修改为永久快照。
* “快照名称”仅为方便用户管理之用，腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
:param request: Request instance for ModifySnapshotAttribute.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifySnapshotAttributeRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifySnapshotAttributeResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifySnapshotAttribute", params, headers=headers)
response = json.loads(body)
model = models.ModifySnapshotAttributeResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ModifySnapshotsSharePermission(self, request):
"""本接口（ModifySnapshotsSharePermission）用于修改快照分享信息。
分享快照后，被分享账户可以通过该快照创建云硬盘。
* 每个快照最多可分享给50个账户。
* 分享快照无法更改名称，描述，仅可用于创建云硬盘。
* 只支持分享到对方账户相同地域。
* 仅支持分享数据盘快照。
:param request: Request instance for ModifySnapshotsSharePermission.
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifySnapshotsSharePermissionRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ModifySnapshotsSharePermissionResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ModifySnapshotsSharePermission", params, headers=headers)
response = json.loads(body)
model = models.ModifySnapshotsSharePermissionResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def RenewDisk(self, request):
"""本接口（RenewDisk）用于续费云硬盘。
* 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中DiskChargeType字段解释。
* 支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到子机续费后的到期时间来续费。
:param request: Request instance for RenewDisk.
:type request: :class:`tencentcloud.cbs.v20170312.models.RenewDiskRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.RenewDiskResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("RenewDisk", params, headers=headers)
response = json.loads(body)
model = models.RenewDiskResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def ResizeDisk(self, request):
"""本接口（ResizeDisk）用于扩容云硬盘。
* 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
* 本接口为异步接口，接口成功返回时，云盘并未立即扩容到指定大小，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态为“EXPANDING”，表示正在扩容中。
:param request: Request instance for ResizeDisk.
:type request: :class:`tencentcloud.cbs.v20170312.models.ResizeDiskRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.ResizeDiskResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("ResizeDisk", params, headers=headers)
response = json.loads(body)
model = models.ResizeDiskResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def TerminateDisks(self, request):
"""本接口（TerminateDisks）用于退还云硬盘。
* 不再使用的云盘，可通过本接口主动退还。
* 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。
* 支持批量操作，每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的，请求会以特定错误码返回。
:param request: Request instance for TerminateDisks.
:type request: :class:`tencentcloud.cbs.v20170312.models.TerminateDisksRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.TerminateDisksResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("TerminateDisks", params, headers=headers)
response = json.loads(body)
model = models.TerminateDisksResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))
def UnbindAutoSnapshotPolicy(self, request):
"""本接口（UnbindAutoSnapshotPolicy）用于解除云硬盘绑定的定期快照策略。
* 支持批量操作，可一次解除多个云盘与同一定期快照策略的绑定。
* 如果传入的云盘未绑定到当前定期快照策略，接口将自动跳过，仅解绑与当前定期快照策略绑定的云盘。
:param request: Request instance for UnbindAutoSnapshotPolicy.
:type request: :class:`tencentcloud.cbs.v20170312.models.UnbindAutoSnapshotPolicyRequest`
:rtype: :class:`tencentcloud.cbs.v20170312.models.UnbindAutoSnapshotPolicyResponse`
"""
try:
params = request._serialize()
headers = request.headers
body = self.call("UnbindAutoSnapshotPolicy", params, headers=headers)
response = json.loads(body)
model = models.UnbindAutoSnapshotPolicyResponse()
model._deserialize(response["Response"])
return model
except Exception as e:
if isinstance(e, TencentCloudSDKException):
raise
else:
raise TencentCloudSDKException(type(e).__name__, str(e))