tencentcloud-sdk-python-cbs 3.0.1450__tar.gz → 3.1.25__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tencentcloud_sdk_python_cbs-3.1.25/PKG-INFO +46 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/setup.py +2 -1
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud/cbs/v20170312/cbs_client.py +46 -46
- tencentcloud_sdk_python_cbs-3.1.25/tencentcloud/cbs/v20170312/cbs_client_async.py +959 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud/cbs/v20170312/models.py +573 -573
- tencentcloud_sdk_python_cbs-3.1.25/tencentcloud_sdk_python_cbs.egg-info/PKG-INFO +46 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud_sdk_python_cbs.egg-info/SOURCES.txt +1 -0
- tencentcloud_sdk_python_cbs-3.1.25/tencentcloud_sdk_python_cbs.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-cbs-3.0.1450/PKG-INFO +0 -45
- tencentcloud-sdk-python-cbs-3.0.1450/tencentcloud_sdk_python_cbs.egg-info/PKG-INFO +0 -45
- tencentcloud-sdk-python-cbs-3.0.1450/tencentcloud_sdk_python_cbs.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/README.rst +0 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/setup.cfg +0 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud/cbs/__init__.py +0 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud/cbs/v20170312/__init__.py +0 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud/cbs/v20170312/errorcodes.py +0 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud_sdk_python_cbs.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-cbs-3.0.1450 → tencentcloud_sdk_python_cbs-3.1.25}/tencentcloud_sdk_python_cbs.egg-info/top_level.txt +0 -0
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: tencentcloud-sdk-python-cbs
|
|
3
|
+
Version: 3.1.25
|
|
4
|
+
Summary: Tencent Cloud Cbs SDK for Python
|
|
5
|
+
Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
|
|
6
|
+
Author: Tencent Cloud
|
|
7
|
+
Maintainer-email: tencentcloudapi@tencent.com
|
|
8
|
+
License: Apache License 2.0
|
|
9
|
+
Platform: any
|
|
10
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
13
|
+
Classifier: Programming Language :: Python
|
|
14
|
+
Classifier: Programming Language :: Python :: 2.7
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
18
|
+
Requires-Dist: tencentcloud-sdk-python-common<4.0.0,>=3.1.25
|
|
19
|
+
|
|
20
|
+
============================
|
|
21
|
+
Tencent Cloud SDK for Python
|
|
22
|
+
============================
|
|
23
|
+
|
|
24
|
+
Tencent Cloud Python Cbs SDK is the official software development kit, which allows Python developers to write software that makes use of Tencent Cloud services like CVM and CBS.
|
|
25
|
+
The SDK works on Python versions:
|
|
26
|
+
|
|
27
|
+
* 2.7 and greater, including 3.x
|
|
28
|
+
|
|
29
|
+
Quick Start
|
|
30
|
+
-----------
|
|
31
|
+
|
|
32
|
+
First, install the library:
|
|
33
|
+
|
|
34
|
+
.. code-block:: sh
|
|
35
|
+
|
|
36
|
+
$ pip install tencentcloud-sdk-python-common
|
|
37
|
+
$ pip install tencentcloud-sdk-python-cbs
|
|
38
|
+
|
|
39
|
+
or download source code from github and install:
|
|
40
|
+
|
|
41
|
+
.. code-block:: sh
|
|
42
|
+
|
|
43
|
+
$ git clone https://github.com/tencentcloud/tencentcloud-sdk-python.git
|
|
44
|
+
$ cd tencentcloud-sdk-python
|
|
45
|
+
$ python package.py --components common cbs
|
|
46
|
+
|
|
@@ -8,7 +8,8 @@ ROOT = os.path.dirname(__file__)
|
|
|
8
8
|
|
|
9
9
|
setup(
|
|
10
10
|
name='tencentcloud-sdk-python-cbs',
|
|
11
|
-
install_requires=["tencentcloud-sdk-python-common>=3.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common>=3.1.25,<4.0.0"],
|
|
12
|
+
|
|
12
13
|
version=tencentcloud.__version__,
|
|
13
14
|
description='Tencent Cloud Cbs SDK for Python',
|
|
14
15
|
long_description=open('README.rst').read(),
|
|
@@ -27,7 +27,7 @@ class CbsClient(AbstractClient):
|
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
def ApplyDiskBackup(self, request):
|
|
30
|
-
"""本接口(ApplyDiskBackup)用于回滚备份点到原云硬盘。
|
|
30
|
+
r"""本接口(ApplyDiskBackup)用于回滚备份点到原云硬盘。
|
|
31
31
|
|
|
32
32
|
* 仅支持回滚到原云硬盘上。对于数据盘备份点,如果您需要复制备份点数据到其它云硬盘上,请先使用[CreateSnapshot](/document/product/362/15648) 将备份点转换为快照,然后使用[CreateDisks](/document/product/362/16312) 接口创建新的弹性云硬盘,将快照数据复制到新购云硬盘上。
|
|
33
33
|
* 用于回滚的备份点必须处于NORMAL状态。备份点状态可以通过[DescribeDiskBackups](/document/product/362/80278)接口查询,见输出参数中BackupState字段解释。
|
|
@@ -54,7 +54,7 @@ class CbsClient(AbstractClient):
|
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
def ApplySnapshot(self, request):
|
|
57
|
-
"""本接口(ApplySnapshot)用于回滚快照到原云硬盘。
|
|
57
|
+
r"""本接口(ApplySnapshot)用于回滚快照到原云硬盘。
|
|
58
58
|
|
|
59
59
|
* 仅支持回滚到原云硬盘上。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘,将快照数据复制到新购云盘上。
|
|
60
60
|
* 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
|
|
@@ -81,7 +81,7 @@ class CbsClient(AbstractClient):
|
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
def ApplySnapshotGroup(self, request):
|
|
84
|
-
"""本接口(ApplySnapshotGroup)用于回滚快照组,将实例恢复到创建快照组时刻的状态。
|
|
84
|
+
r"""本接口(ApplySnapshotGroup)用于回滚快照组,将实例恢复到创建快照组时刻的状态。
|
|
85
85
|
* 1.可选择快照组全部或部分盘进行回滚;
|
|
86
86
|
* 2.如果回滚的盘中包含已挂载的盘,要求这些盘必须挂载在同一实例上,且要求该实例已关机才能回滚;
|
|
87
87
|
* 3.回滚为异步操作,接口返回成功不代表回滚成功,可通过调DescribeSnapshotGroups接口查询快照组的状态。
|
|
@@ -107,7 +107,7 @@ class CbsClient(AbstractClient):
|
|
|
107
107
|
|
|
108
108
|
|
|
109
109
|
def AttachDisks(self, request):
|
|
110
|
-
"""本接口(AttachDisks)用于挂载云硬盘。
|
|
110
|
+
r"""本接口(AttachDisks)用于挂载云硬盘。
|
|
111
111
|
|
|
112
112
|
* 支持批量操作,将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘,则操作不执行,返回特定的错误码。
|
|
113
113
|
* 本接口为异步接口,当挂载云盘的请求成功返回时,表示后台已发起挂载云盘的操作,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHING”变为“ATTACHED”,则为挂载成功。
|
|
@@ -133,7 +133,7 @@ class CbsClient(AbstractClient):
|
|
|
133
133
|
|
|
134
134
|
|
|
135
135
|
def BindAutoSnapshotPolicy(self, request):
|
|
136
|
-
"""本接口(BindAutoSnapshotPolicy)用于绑定云硬盘到指定的定期快照策略。
|
|
136
|
+
r"""本接口(BindAutoSnapshotPolicy)用于绑定云硬盘到指定的定期快照策略。
|
|
137
137
|
|
|
138
138
|
* 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
|
|
139
139
|
* 当已绑定定期快照策略的云硬盘处于未使用状态(即弹性云盘未挂载或非弹性云盘的主机处于关机状态)将不会创建定期快照。
|
|
@@ -159,7 +159,7 @@ class CbsClient(AbstractClient):
|
|
|
159
159
|
|
|
160
160
|
|
|
161
161
|
def CopySnapshotCrossRegions(self, request):
|
|
162
|
-
"""本接口(CopySnapshotCrossRegions)用于快照跨地域复制。
|
|
162
|
+
r"""本接口(CopySnapshotCrossRegions)用于快照跨地域复制。
|
|
163
163
|
|
|
164
164
|
* 本接口为异步接口,当跨地域复制的请求下发成功后会返回一个新的快照ID,此时快照未立即复制到目标地域,可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态,判断是否复制完成。如果快照的状态为“NORMAL”,表示快照复制完成。
|
|
165
165
|
* 本接口实现的快照跨地域复制操作将产生跨地域流量,预计2025年第三季度会针对此功能进行商业化计费;请留意后续站内信公告,避免产生预期外扣费。
|
|
@@ -185,7 +185,7 @@ class CbsClient(AbstractClient):
|
|
|
185
185
|
|
|
186
186
|
|
|
187
187
|
def CreateAutoSnapshotPolicy(self, request):
|
|
188
|
-
"""本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。
|
|
188
|
+
r"""本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。
|
|
189
189
|
|
|
190
190
|
* 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
|
|
191
191
|
* 每个地域可创建的快照有数量和容量的限制,具体请见腾讯云控制台快照页面提示,如果快照超配额,定期快照创建会失败。
|
|
@@ -211,7 +211,7 @@ class CbsClient(AbstractClient):
|
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
def CreateDiskBackup(self, request):
|
|
214
|
-
"""为云硬盘创建一个备份点。
|
|
214
|
+
r"""为云硬盘创建一个备份点。
|
|
215
215
|
|
|
216
216
|
:param request: Request instance for CreateDiskBackup.
|
|
217
217
|
:type request: :class:`tencentcloud.cbs.v20170312.models.CreateDiskBackupRequest`
|
|
@@ -234,7 +234,7 @@ class CbsClient(AbstractClient):
|
|
|
234
234
|
|
|
235
235
|
|
|
236
236
|
def CreateDisks(self, request):
|
|
237
|
-
"""本接口(CreateDisks)用于创建云硬盘。
|
|
237
|
+
r"""本接口(CreateDisks)用于创建云硬盘。
|
|
238
238
|
|
|
239
239
|
* 预付费云盘的购买会预先扣除本次云盘购买所需金额,在调用本接口前请确保账户余额充足。
|
|
240
240
|
* 本接口支持传入数据盘快照来创建云盘,实现将快照数据复制到新购云盘上。
|
|
@@ -261,7 +261,7 @@ class CbsClient(AbstractClient):
|
|
|
261
261
|
|
|
262
262
|
|
|
263
263
|
def CreateSnapshot(self, request):
|
|
264
|
-
"""本接口(CreateSnapshot)用于对指定云盘创建快照。
|
|
264
|
+
r"""本接口(CreateSnapshot)用于对指定云盘创建快照。
|
|
265
265
|
|
|
266
266
|
* 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
|
|
267
267
|
* 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
|
|
@@ -288,7 +288,7 @@ class CbsClient(AbstractClient):
|
|
|
288
288
|
|
|
289
289
|
|
|
290
290
|
def CreateSnapshotGroup(self, request):
|
|
291
|
-
"""本接口(CreateSnapshotGroup)用于创建快照组。
|
|
291
|
+
r"""本接口(CreateSnapshotGroup)用于创建快照组。
|
|
292
292
|
* 创建快照组的云硬盘列表必须挂载在同一实例上;
|
|
293
293
|
* 可选择挂载在实例上的全部或部分盘创建快照组。
|
|
294
294
|
|
|
@@ -313,7 +313,7 @@ class CbsClient(AbstractClient):
|
|
|
313
313
|
|
|
314
314
|
|
|
315
315
|
def DeleteAutoSnapshotPolicies(self, request):
|
|
316
|
-
"""本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
|
|
316
|
+
r"""本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
|
|
317
317
|
|
|
318
318
|
* 支持批量操作。如果多个定期快照策略存在无法删除的,则操作不执行,以特定错误码返回。
|
|
319
319
|
|
|
@@ -338,7 +338,7 @@ class CbsClient(AbstractClient):
|
|
|
338
338
|
|
|
339
339
|
|
|
340
340
|
def DeleteDiskBackups(self, request):
|
|
341
|
-
"""批量删除指定的云硬盘备份点。
|
|
341
|
+
r"""批量删除指定的云硬盘备份点。
|
|
342
342
|
|
|
343
343
|
:param request: Request instance for DeleteDiskBackups.
|
|
344
344
|
:type request: :class:`tencentcloud.cbs.v20170312.models.DeleteDiskBackupsRequest`
|
|
@@ -361,7 +361,7 @@ class CbsClient(AbstractClient):
|
|
|
361
361
|
|
|
362
362
|
|
|
363
363
|
def DeleteSnapshotGroup(self, request):
|
|
364
|
-
"""本接口(DeleteSnapshotGroup)用于删除快照组,一次调用仅支持删除一个快照组。
|
|
364
|
+
r"""本接口(DeleteSnapshotGroup)用于删除快照组,一次调用仅支持删除一个快照组。
|
|
365
365
|
* 默认会删除快照组内的所有快照;
|
|
366
366
|
* 如果快照组内的快照有关联镜像,则删除失败,所有快照均不会删除;如果需要同时删除快照绑定的镜像,可传入参数DeleteBindImages等于true。
|
|
367
367
|
|
|
@@ -386,7 +386,7 @@ class CbsClient(AbstractClient):
|
|
|
386
386
|
|
|
387
387
|
|
|
388
388
|
def DeleteSnapshots(self, request):
|
|
389
|
-
"""本接口(DeleteSnapshots)用于删除快照。
|
|
389
|
+
r"""本接口(DeleteSnapshots)用于删除快照。
|
|
390
390
|
|
|
391
391
|
* 快照必须处于NORMAL状态,快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
|
|
392
392
|
* 支持批量操作。如果多个快照存在无法删除的快照,则操作不执行,以特定的错误码返回。
|
|
@@ -412,7 +412,7 @@ class CbsClient(AbstractClient):
|
|
|
412
412
|
|
|
413
413
|
|
|
414
414
|
def DescribeAutoSnapshotPolicies(self, request):
|
|
415
|
-
"""本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
|
|
415
|
+
r"""本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
|
|
416
416
|
|
|
417
417
|
* 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
|
|
418
418
|
* 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的定期快照策略表。
|
|
@@ -438,7 +438,7 @@ class CbsClient(AbstractClient):
|
|
|
438
438
|
|
|
439
439
|
|
|
440
440
|
def DescribeDiskAssociatedAutoSnapshotPolicy(self, request):
|
|
441
|
-
"""本接口(DescribeDiskAssociatedAutoSnapshotPolicy)用于查询云盘绑定的定期快照策略。
|
|
441
|
+
r"""本接口(DescribeDiskAssociatedAutoSnapshotPolicy)用于查询云盘绑定的定期快照策略。
|
|
442
442
|
|
|
443
443
|
:param request: Request instance for DescribeDiskAssociatedAutoSnapshotPolicy.
|
|
444
444
|
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskAssociatedAutoSnapshotPolicyRequest`
|
|
@@ -461,7 +461,7 @@ class CbsClient(AbstractClient):
|
|
|
461
461
|
|
|
462
462
|
|
|
463
463
|
def DescribeDiskBackups(self, request):
|
|
464
|
-
"""本接口(DescribeDiskBackups)用于查询备份点的详细信息。
|
|
464
|
+
r"""本接口(DescribeDiskBackups)用于查询备份点的详细信息。
|
|
465
465
|
|
|
466
466
|
根据备份点ID、创建备份点的云硬盘ID、创建备份点的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器Filter。
|
|
467
467
|
如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的备份点列表。
|
|
@@ -487,7 +487,7 @@ class CbsClient(AbstractClient):
|
|
|
487
487
|
|
|
488
488
|
|
|
489
489
|
def DescribeDiskConfigQuota(self, request):
|
|
490
|
-
"""本接口(DescribeDiskConfigQuota)用于查询云硬盘配额。
|
|
490
|
+
r"""本接口(DescribeDiskConfigQuota)用于查询云硬盘配额。
|
|
491
491
|
|
|
492
492
|
:param request: Request instance for DescribeDiskConfigQuota.
|
|
493
493
|
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeDiskConfigQuotaRequest`
|
|
@@ -510,7 +510,7 @@ class CbsClient(AbstractClient):
|
|
|
510
510
|
|
|
511
511
|
|
|
512
512
|
def DescribeDiskStoragePool(self, request):
|
|
513
|
-
"""本接口(DescribeDiskStoragePool)查询用户的云硬盘独享集群列表。
|
|
513
|
+
r"""本接口(DescribeDiskStoragePool)查询用户的云硬盘独享集群列表。
|
|
514
514
|
|
|
515
515
|
* 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息,不同的过滤条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
|
|
516
516
|
* 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘独享集群列表。
|
|
@@ -536,7 +536,7 @@ class CbsClient(AbstractClient):
|
|
|
536
536
|
|
|
537
537
|
|
|
538
538
|
def DescribeDisks(self, request):
|
|
539
|
-
"""本接口(DescribeDisks)用于查询云硬盘列表。
|
|
539
|
+
r"""本接口(DescribeDisks)用于查询云硬盘列表。
|
|
540
540
|
|
|
541
541
|
* 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
|
|
542
542
|
* 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘列表。
|
|
@@ -562,7 +562,7 @@ class CbsClient(AbstractClient):
|
|
|
562
562
|
|
|
563
563
|
|
|
564
564
|
def DescribeInstancesDiskNum(self, request):
|
|
565
|
-
"""本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。
|
|
565
|
+
r"""本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。
|
|
566
566
|
|
|
567
567
|
* 支持批量操作,当传入多个云服务器实例ID,返回结果会分别列出每个云服务器挂载的云硬盘数量。
|
|
568
568
|
|
|
@@ -587,7 +587,7 @@ class CbsClient(AbstractClient):
|
|
|
587
587
|
|
|
588
588
|
|
|
589
589
|
def DescribeSnapshotGroups(self, request):
|
|
590
|
-
"""本接口(DescribeSnapshotGroups)用于查询快照组列表。
|
|
590
|
+
r"""本接口(DescribeSnapshotGroups)用于查询快照组列表。
|
|
591
591
|
* 可以根据快照组ID、快照组状态、快照组关联的快照ID等来查询快照组列表,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
|
|
592
592
|
* 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的快照组列表。
|
|
593
593
|
|
|
@@ -612,7 +612,7 @@ class CbsClient(AbstractClient):
|
|
|
612
612
|
|
|
613
613
|
|
|
614
614
|
def DescribeSnapshotOverview(self, request):
|
|
615
|
-
"""该接口用于查询用户快照使用概览,包括快照总容量、计费容量等信息。
|
|
615
|
+
r"""该接口用于查询用户快照使用概览,包括快照总容量、计费容量等信息。
|
|
616
616
|
|
|
617
617
|
:param request: Request instance for DescribeSnapshotOverview.
|
|
618
618
|
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotOverviewRequest`
|
|
@@ -635,7 +635,7 @@ class CbsClient(AbstractClient):
|
|
|
635
635
|
|
|
636
636
|
|
|
637
637
|
def DescribeSnapshotSharePermission(self, request):
|
|
638
|
-
"""本接口(DescribeSnapshotSharePermission)用于查询快照的分享信息。
|
|
638
|
+
r"""本接口(DescribeSnapshotSharePermission)用于查询快照的分享信息。
|
|
639
639
|
|
|
640
640
|
:param request: Request instance for DescribeSnapshotSharePermission.
|
|
641
641
|
:type request: :class:`tencentcloud.cbs.v20170312.models.DescribeSnapshotSharePermissionRequest`
|
|
@@ -658,7 +658,7 @@ class CbsClient(AbstractClient):
|
|
|
658
658
|
|
|
659
659
|
|
|
660
660
|
def DescribeSnapshots(self, request):
|
|
661
|
-
"""本接口(DescribeSnapshots)用于查询快照的详细信息。
|
|
661
|
+
r"""本接口(DescribeSnapshots)用于查询快照的详细信息。
|
|
662
662
|
|
|
663
663
|
* 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
|
|
664
664
|
* 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的快照列表。
|
|
@@ -684,7 +684,7 @@ class CbsClient(AbstractClient):
|
|
|
684
684
|
|
|
685
685
|
|
|
686
686
|
def DetachDisks(self, request):
|
|
687
|
-
"""本接口(DetachDisks)用于卸载云硬盘。
|
|
687
|
+
r"""本接口(DetachDisks)用于卸载云硬盘。
|
|
688
688
|
|
|
689
689
|
* 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
|
|
690
690
|
* 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
|
|
@@ -710,7 +710,7 @@ class CbsClient(AbstractClient):
|
|
|
710
710
|
|
|
711
711
|
|
|
712
712
|
def GetSnapOverview(self, request):
|
|
713
|
-
"""为进一步规范化API命名,该接口决定预下线,新接口命名为:DescribeSnapshotOverview
|
|
713
|
+
r"""为进一步规范化API命名,该接口决定预下线,新接口命名为:DescribeSnapshotOverview
|
|
714
714
|
|
|
715
715
|
获取快照概览信息
|
|
716
716
|
|
|
@@ -735,7 +735,7 @@ class CbsClient(AbstractClient):
|
|
|
735
735
|
|
|
736
736
|
|
|
737
737
|
def InitializeDisks(self, request):
|
|
738
|
-
"""重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点:
|
|
738
|
+
r"""重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点:
|
|
739
739
|
1. 如果云硬盘是由快照创建的,则重新初始化会通过此快照重新回滚此云硬盘,即将云硬盘恢复为与快照一致的状态;
|
|
740
740
|
2. 如果云硬盘不是通过快照创建的,则重新初始化会清空此云硬盘的数据;请在重新初始化云硬盘前检查并备份必要的数据;
|
|
741
741
|
3. 当前仅未挂载的、非共享属性的数据盘云硬盘支持重新初始化;
|
|
@@ -762,7 +762,7 @@ class CbsClient(AbstractClient):
|
|
|
762
762
|
|
|
763
763
|
|
|
764
764
|
def InquirePriceModifyDiskBackupQuota(self, request):
|
|
765
|
-
"""本接口(InquirePricePriceModifyDiskBackupQuota)用于修改云硬盘备份点配额询价。
|
|
765
|
+
r"""本接口(InquirePricePriceModifyDiskBackupQuota)用于修改云硬盘备份点配额询价。
|
|
766
766
|
|
|
767
767
|
:param request: Request instance for InquirePriceModifyDiskBackupQuota.
|
|
768
768
|
:type request: :class:`tencentcloud.cbs.v20170312.models.InquirePriceModifyDiskBackupQuotaRequest`
|
|
@@ -785,7 +785,7 @@ class CbsClient(AbstractClient):
|
|
|
785
785
|
|
|
786
786
|
|
|
787
787
|
def InquirePriceModifyDiskExtraPerformance(self, request):
|
|
788
|
-
"""本接口(InquirePriceModifyDiskExtraPerformance)用于调整云硬盘额外性能询价。
|
|
788
|
+
r"""本接口(InquirePriceModifyDiskExtraPerformance)用于调整云硬盘额外性能询价。
|
|
789
789
|
|
|
790
790
|
:param request: Request instance for InquirePriceModifyDiskExtraPerformance.
|
|
791
791
|
:type request: :class:`tencentcloud.cbs.v20170312.models.InquirePriceModifyDiskExtraPerformanceRequest`
|
|
@@ -808,7 +808,7 @@ class CbsClient(AbstractClient):
|
|
|
808
808
|
|
|
809
809
|
|
|
810
810
|
def InquiryPriceCreateDisks(self, request):
|
|
811
|
-
"""本接口(InquiryPriceCreateDisks)用于创建云硬盘询价。
|
|
811
|
+
r"""本接口(InquiryPriceCreateDisks)用于创建云硬盘询价。
|
|
812
812
|
|
|
813
813
|
* 支持查询创建多块云硬盘的价格,此时返回结果为总价格。
|
|
814
814
|
|
|
@@ -833,7 +833,7 @@ class CbsClient(AbstractClient):
|
|
|
833
833
|
|
|
834
834
|
|
|
835
835
|
def InquiryPriceRenewDisks(self, request):
|
|
836
|
-
"""本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
|
|
836
|
+
r"""本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
|
|
837
837
|
|
|
838
838
|
* 只支持查询预付费模式的弹性云盘续费价格。
|
|
839
839
|
* 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到实例续费后的到期时间来续费询价。
|
|
@@ -860,7 +860,7 @@ class CbsClient(AbstractClient):
|
|
|
860
860
|
|
|
861
861
|
|
|
862
862
|
def InquiryPriceResizeDisk(self, request):
|
|
863
|
-
"""本接口(InquiryPriceResizeDisk)用于扩容云硬盘询价。
|
|
863
|
+
r"""本接口(InquiryPriceResizeDisk)用于扩容云硬盘询价。
|
|
864
864
|
|
|
865
865
|
:param request: Request instance for InquiryPriceResizeDisk.
|
|
866
866
|
:type request: :class:`tencentcloud.cbs.v20170312.models.InquiryPriceResizeDiskRequest`
|
|
@@ -883,7 +883,7 @@ class CbsClient(AbstractClient):
|
|
|
883
883
|
|
|
884
884
|
|
|
885
885
|
def ModifyAutoSnapshotPolicyAttribute(self, request):
|
|
886
|
-
"""本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。
|
|
886
|
+
r"""本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。
|
|
887
887
|
|
|
888
888
|
* 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
|
|
889
889
|
* 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。
|
|
@@ -909,7 +909,7 @@ class CbsClient(AbstractClient):
|
|
|
909
909
|
|
|
910
910
|
|
|
911
911
|
def ModifyDiskAttributes(self, request):
|
|
912
|
-
"""* 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。是否是弹性云盘可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
|
|
912
|
+
r"""* 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。是否是弹性云盘可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
|
|
913
913
|
* “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
|
|
914
914
|
* 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
|
|
915
915
|
|
|
@@ -934,7 +934,7 @@ class CbsClient(AbstractClient):
|
|
|
934
934
|
|
|
935
935
|
|
|
936
936
|
def ModifyDiskBackupQuota(self, request):
|
|
937
|
-
"""此接口 (ModifyDiskBackupQuota) 用于修改云硬盘备份点配额。
|
|
937
|
+
r"""此接口 (ModifyDiskBackupQuota) 用于修改云硬盘备份点配额。
|
|
938
938
|
|
|
939
939
|
:param request: Request instance for ModifyDiskBackupQuota.
|
|
940
940
|
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDiskBackupQuotaRequest`
|
|
@@ -957,7 +957,7 @@ class CbsClient(AbstractClient):
|
|
|
957
957
|
|
|
958
958
|
|
|
959
959
|
def ModifyDiskExtraPerformance(self, request):
|
|
960
|
-
"""本接口(ModifyDiskExtraPerformance)用于调整云硬盘额外的性能。
|
|
960
|
+
r"""本接口(ModifyDiskExtraPerformance)用于调整云硬盘额外的性能。
|
|
961
961
|
|
|
962
962
|
* 目前仅支持增强型SSD云硬盘(CLOUD_HSSD)和极速型SSD云硬盘(CLOUD_TSSD)。
|
|
963
963
|
|
|
@@ -982,7 +982,7 @@ class CbsClient(AbstractClient):
|
|
|
982
982
|
|
|
983
983
|
|
|
984
984
|
def ModifyDisksChargeType(self, request):
|
|
985
|
-
"""本接口 (ModifyDisksChargeType) 用于切换云硬盘的计费模式。
|
|
985
|
+
r"""本接口 (ModifyDisksChargeType) 用于切换云硬盘的计费模式。
|
|
986
986
|
|
|
987
987
|
非弹性云硬盘不支持此接口,请通过修改实例计费模式接口将实例连同非弹性云硬盘一起转换。
|
|
988
988
|
|
|
@@ -1007,7 +1007,7 @@ class CbsClient(AbstractClient):
|
|
|
1007
1007
|
|
|
1008
1008
|
|
|
1009
1009
|
def ModifyDisksRenewFlag(self, request):
|
|
1010
|
-
"""本接口(ModifyDisksRenewFlag)用于修改云硬盘续费标识,支持批量修改。
|
|
1010
|
+
r"""本接口(ModifyDisksRenewFlag)用于修改云硬盘续费标识,支持批量修改。
|
|
1011
1011
|
|
|
1012
1012
|
:param request: Request instance for ModifyDisksRenewFlag.
|
|
1013
1013
|
:type request: :class:`tencentcloud.cbs.v20170312.models.ModifyDisksRenewFlagRequest`
|
|
@@ -1030,7 +1030,7 @@ class CbsClient(AbstractClient):
|
|
|
1030
1030
|
|
|
1031
1031
|
|
|
1032
1032
|
def ModifySnapshotAttribute(self, request):
|
|
1033
|
-
"""本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
|
|
1033
|
+
r"""本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
|
|
1034
1034
|
|
|
1035
1035
|
* 本接口支持修改快照名称及到期时间,以及将非永久快照修改为永久快照。
|
|
1036
1036
|
* “快照名称”仅为方便用户管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
|
|
@@ -1056,7 +1056,7 @@ class CbsClient(AbstractClient):
|
|
|
1056
1056
|
|
|
1057
1057
|
|
|
1058
1058
|
def ModifySnapshotsSharePermission(self, request):
|
|
1059
|
-
"""本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
|
|
1059
|
+
r"""本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
|
|
1060
1060
|
|
|
1061
1061
|
分享快照后,被分享账户可以通过该快照创建云硬盘。
|
|
1062
1062
|
* 每个快照最多可分享给50个账户。
|
|
@@ -1085,7 +1085,7 @@ class CbsClient(AbstractClient):
|
|
|
1085
1085
|
|
|
1086
1086
|
|
|
1087
1087
|
def RenewDisk(self, request):
|
|
1088
|
-
"""本接口(RenewDisk)用于续费云硬盘。
|
|
1088
|
+
r"""本接口(RenewDisk)用于续费云硬盘。
|
|
1089
1089
|
|
|
1090
1090
|
* 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中DiskChargeType字段解释。
|
|
1091
1091
|
* 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到子机续费后的到期时间来续费。
|
|
@@ -1111,7 +1111,7 @@ class CbsClient(AbstractClient):
|
|
|
1111
1111
|
|
|
1112
1112
|
|
|
1113
1113
|
def ResizeDisk(self, request):
|
|
1114
|
-
"""本接口(ResizeDisk)用于扩容云硬盘。
|
|
1114
|
+
r"""本接口(ResizeDisk)用于扩容云硬盘。
|
|
1115
1115
|
|
|
1116
1116
|
* 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
|
|
1117
1117
|
* 本接口为异步接口,接口成功返回时,云盘并未立即扩容到指定大小,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态为“EXPANDING”,表示正在扩容中。
|
|
@@ -1137,7 +1137,7 @@ class CbsClient(AbstractClient):
|
|
|
1137
1137
|
|
|
1138
1138
|
|
|
1139
1139
|
def TerminateDisks(self, request):
|
|
1140
|
-
"""本接口(TerminateDisks)用于退还云硬盘。
|
|
1140
|
+
r"""本接口(TerminateDisks)用于退还云硬盘。
|
|
1141
1141
|
|
|
1142
1142
|
* 不再使用的云盘,可通过本接口主动退还。
|
|
1143
1143
|
* 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还,预付费云盘需符合退还规则。
|
|
@@ -1164,7 +1164,7 @@ class CbsClient(AbstractClient):
|
|
|
1164
1164
|
|
|
1165
1165
|
|
|
1166
1166
|
def UnbindAutoSnapshotPolicy(self, request):
|
|
1167
|
-
"""本接口(UnbindAutoSnapshotPolicy)用于解除云硬盘绑定的定期快照策略。
|
|
1167
|
+
r"""本接口(UnbindAutoSnapshotPolicy)用于解除云硬盘绑定的定期快照策略。
|
|
1168
1168
|
|
|
1169
1169
|
* 支持批量操作,可一次解除多个云盘与同一定期快照策略的绑定。
|
|
1170
1170
|
* 如果传入的云盘未绑定到当前定期快照策略,接口将自动跳过,仅解绑与当前定期快照策略绑定的云盘。
|