tencentcloud-sdk-nodejs-cbs 4.0.397 → 4.0.431

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.
@@ -1,6 +1,6 @@
1
1
  import * as Models from "./cbs_models"
2
2
  import { Client } from "./cbs_client"
3
3
  export const v20170312 = {
4
- Client: Client,
5
- Models: Models,
6
- }
4
+ Client: Client,
5
+ Models: Models
6
+ }
@@ -7,249 +7,249 @@ import { ModifyDiskExtraPerformanceRequest, ModifyDiskAttributesResponse, Descri
7
7
  export declare class Client extends TencentCloudCommon.AbstractClient {
8
8
  constructor(clientConfig: TencentCloudCommon.ClientConfig);
9
9
  /**
10
- * 本接口(ModifyDiskExtraPerformance)用于调整云硬盘额外的性能。
11
-
12
- * 目前仅支持极速型SSD云硬盘(CLOUD_TSSD)和高性能SSD云硬盘(CLOUD_HSSD)。
13
- */
10
+ * 本接口(ModifyDiskExtraPerformance)用于调整云硬盘额外的性能。
11
+
12
+ * 目前仅支持极速型SSD云硬盘(CLOUD_TSSD)和高性能SSD云硬盘(CLOUD_HSSD)。
13
+ */
14
14
  ModifyDiskExtraPerformance(req: ModifyDiskExtraPerformanceRequest, cb?: (error: string, rep: ModifyDiskExtraPerformanceResponse) => void): Promise<ModifyDiskExtraPerformanceResponse>;
15
15
  /**
16
- * 本接口(RenewDisk)用于续费云硬盘。
17
-
18
- * 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中DiskChargeType字段解释。
19
- * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到子机续费后的到期时间来续费。
20
- */
16
+ * 本接口(RenewDisk)用于续费云硬盘。
17
+
18
+ * 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中DiskChargeType字段解释。
19
+ * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到子机续费后的到期时间来续费。
20
+ */
21
21
  RenewDisk(req: RenewDiskRequest, cb?: (error: string, rep: RenewDiskResponse) => void): Promise<RenewDiskResponse>;
22
22
  /**
23
- * 本接口(CopySnapshotCrossRegions)用于快照跨地域复制。
24
-
25
- * 本接口为异步接口,当跨地域复制的请求下发成功后会返回一个新的快照ID,此时快照未立即复制到目标地域,可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态,判断是否复制完成。如果快照的状态为“NORMAL”,表示快照复制完成。
26
- * 本接口实现的快照跨地域复制操作将产生跨地域流量,预计2022年第三季度会针对此功能进行商业化计费;请留意后续站内信公告,避免产生预期外扣费。
27
- */
23
+ * 本接口(CopySnapshotCrossRegions)用于快照跨地域复制。
24
+
25
+ * 本接口为异步接口,当跨地域复制的请求下发成功后会返回一个新的快照ID,此时快照未立即复制到目标地域,可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态,判断是否复制完成。如果快照的状态为“NORMAL”,表示快照复制完成。
26
+ * 本接口实现的快照跨地域复制操作将产生跨地域流量,预计2022年第三季度会针对此功能进行商业化计费;请留意后续站内信公告,避免产生预期外扣费。
27
+ */
28
28
  CopySnapshotCrossRegions(req: CopySnapshotCrossRegionsRequest, cb?: (error: string, rep: CopySnapshotCrossRegionsResponse) => void): Promise<CopySnapshotCrossRegionsResponse>;
29
29
  /**
30
- * 本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。
31
-
32
- * 支持批量操作,当传入多个云服务器实例ID,返回结果会分别列出每个云服务器挂载的云硬盘数量。
33
- */
30
+ * 本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。
31
+
32
+ * 支持批量操作,当传入多个云服务器实例ID,返回结果会分别列出每个云服务器挂载的云硬盘数量。
33
+ */
34
34
  DescribeInstancesDiskNum(req: DescribeInstancesDiskNumRequest, cb?: (error: string, rep: DescribeInstancesDiskNumResponse) => void): Promise<DescribeInstancesDiskNumResponse>;
35
35
  /**
36
- * 本接口(InquiryPriceResizeDisk)用于扩容云硬盘询价。
37
-
38
- * 只支持预付费模式的云硬盘扩容询价。
39
- */
36
+ * 本接口(InquiryPriceResizeDisk)用于扩容云硬盘询价。
37
+
38
+ * 只支持预付费模式的云硬盘扩容询价。
39
+ */
40
40
  InquiryPriceResizeDisk(req: InquiryPriceResizeDiskRequest, cb?: (error: string, rep: InquiryPriceResizeDiskResponse) => void): Promise<InquiryPriceResizeDiskResponse>;
41
41
  /**
42
42
  * 本接口(InquirePriceModifyDiskExtraPerformance)用于调整云硬盘额外性能询价。
43
43
  */
44
44
  InquirePriceModifyDiskExtraPerformance(req: InquirePriceModifyDiskExtraPerformanceRequest, cb?: (error: string, rep: InquirePriceModifyDiskExtraPerformanceResponse) => void): Promise<InquirePriceModifyDiskExtraPerformanceResponse>;
45
45
  /**
46
- * 本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
47
-
48
- * 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
49
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的定期快照策略表。
50
-
51
- */
46
+ * 本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
47
+
48
+ * 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
49
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的定期快照策略表。
50
+
51
+ */
52
52
  DescribeAutoSnapshotPolicies(req: DescribeAutoSnapshotPoliciesRequest, cb?: (error: string, rep: DescribeAutoSnapshotPoliciesResponse) => void): Promise<DescribeAutoSnapshotPoliciesResponse>;
53
53
  /**
54
- * 本接口(AttachDisks)用于挂载云硬盘。
55
-
56
- * 支持批量操作,将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘,则操作不执行,返回特定的错误码。
57
- * 本接口为异步接口,当挂载云盘的请求成功返回时,表示后台已发起挂载云盘的操作,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHING”变为“ATTACHED”,则为挂载成功。
58
- */
54
+ * 本接口(AttachDisks)用于挂载云硬盘。
55
+
56
+ * 支持批量操作,将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘,则操作不执行,返回特定的错误码。
57
+ * 本接口为异步接口,当挂载云盘的请求成功返回时,表示后台已发起挂载云盘的操作,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHING”变为“ATTACHED”,则为挂载成功。
58
+ */
59
59
  AttachDisks(req: AttachDisksRequest, cb?: (error: string, rep: AttachDisksResponse) => void): Promise<AttachDisksResponse>;
60
60
  /**
61
61
  * 本接口(ModifyDisksRenewFlag)用于修改云硬盘续费标识,支持批量修改。
62
62
  */
63
63
  ModifyDisksRenewFlag(req: ModifyDisksRenewFlagRequest, cb?: (error: string, rep: ModifyDisksRenewFlagResponse) => void): Promise<ModifyDisksRenewFlagResponse>;
64
64
  /**
65
- * 本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。
66
-
67
- * 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
68
- * 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。
69
- */
65
+ * 本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。
66
+
67
+ * 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
68
+ * 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。
69
+ */
70
70
  ModifyAutoSnapshotPolicyAttribute(req: ModifyAutoSnapshotPolicyAttributeRequest, cb?: (error: string, rep: ModifyAutoSnapshotPolicyAttributeResponse) => void): Promise<ModifyAutoSnapshotPolicyAttributeResponse>;
71
71
  /**
72
- * 本接口(InquiryPriceCreateDisks)用于创建云硬盘询价。
73
-
74
- * 支持查询创建多块云硬盘的价格,此时返回结果为总价格。
75
- */
72
+ * 本接口(InquiryPriceCreateDisks)用于创建云硬盘询价。
73
+
74
+ * 支持查询创建多块云硬盘的价格,此时返回结果为总价格。
75
+ */
76
76
  InquiryPriceCreateDisks(req: InquiryPriceCreateDisksRequest, cb?: (error: string, rep: InquiryPriceCreateDisksResponse) => void): Promise<InquiryPriceCreateDisksResponse>;
77
77
  /**
78
78
  * 查询云盘操作日志功能已迁移至LookUpEvents接口(https://cloud.tencent.com/document/product/629/12359),本接口(DescribeDiskOperationLogs)即将下线,后续不再提供调用,请知悉。
79
79
  */
80
80
  DescribeDiskOperationLogs(req: DescribeDiskOperationLogsRequest, cb?: (error: string, rep: DescribeDiskOperationLogsResponse) => void): Promise<DescribeDiskOperationLogsResponse>;
81
81
  /**
82
- * 本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
83
-
84
- * 支持批量操作。如果多个定期快照策略存在无法删除的,则操作不执行,以特定错误码返回。
85
- */
82
+ * 本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
83
+
84
+ * 支持批量操作。如果多个定期快照策略存在无法删除的,则操作不执行,以特定错误码返回。
85
+ */
86
86
  DeleteAutoSnapshotPolicies(req: DeleteAutoSnapshotPoliciesRequest, cb?: (error: string, rep: DeleteAutoSnapshotPoliciesResponse) => void): Promise<DeleteAutoSnapshotPoliciesResponse>;
87
87
  /**
88
- * 本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。
89
-
90
- * 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
91
- * 每个地域可创建的快照有数量和容量的限制,具体请见腾讯云控制台快照页面提示,如果快照超配额,定期快照创建会失败。
92
- */
88
+ * 本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。
89
+
90
+ * 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
91
+ * 每个地域可创建的快照有数量和容量的限制,具体请见腾讯云控制台快照页面提示,如果快照超配额,定期快照创建会失败。
92
+ */
93
93
  CreateAutoSnapshotPolicy(req: CreateAutoSnapshotPolicyRequest, cb?: (error: string, rep: CreateAutoSnapshotPolicyResponse) => void): Promise<CreateAutoSnapshotPolicyResponse>;
94
94
  /**
95
- * 本接口(DescribeDisks)用于查询云硬盘列表。
96
-
97
- * 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
98
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘列表。
99
- */
95
+ * 本接口(DescribeDisks)用于查询云硬盘列表。
96
+
97
+ * 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
98
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘列表。
99
+ */
100
100
  DescribeDisks(req: DescribeDisksRequest, cb?: (error: string, rep: DescribeDisksResponse) => void): Promise<DescribeDisksResponse>;
101
101
  /**
102
- * 本接口(CreateDisks)用于创建云硬盘。
103
-
104
- * 预付费云盘的购买会预先扣除本次云盘购买所需金额,在调用本接口前请确保账户余额充足。
105
- * 本接口支持传入数据盘快照来创建云盘,实现将快照数据复制到新购云盘上。
106
- * 本接口为异步接口,当创建请求下发成功后会返回一个新建的云盘ID列表,此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘,如果能查到云盘,且状态为'UNATTACHED'或'ATTACHED',则表示创建成功。
107
- */
102
+ * 本接口(CreateDisks)用于创建云硬盘。
103
+
104
+ * 预付费云盘的购买会预先扣除本次云盘购买所需金额,在调用本接口前请确保账户余额充足。
105
+ * 本接口支持传入数据盘快照来创建云盘,实现将快照数据复制到新购云盘上。
106
+ * 本接口为异步接口,当创建请求下发成功后会返回一个新建的云盘ID列表,此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘,如果能查到云盘,且状态为'UNATTACHED'或'ATTACHED',则表示创建成功。
107
+ */
108
108
  CreateDisks(req: CreateDisksRequest, cb?: (error: string, rep: CreateDisksResponse) => void): Promise<CreateDisksResponse>;
109
109
  /**
110
110
  * * 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
111
- * “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
112
- * 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
111
+ * “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
112
+ * 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
113
113
  */
114
114
  ModifyDiskAttributes(req: ModifyDiskAttributesRequest, cb?: (error: string, rep: ModifyDiskAttributesResponse) => void): Promise<ModifyDiskAttributesResponse>;
115
115
  /**
116
- * 本接口(DeleteSnapshots)用于删除快照。
117
-
118
- * 快照必须处于NORMAL状态,快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
119
- * 支持批量操作。如果多个快照存在无法删除的快照,则操作不执行,以特定的错误码返回。
120
- */
116
+ * 本接口(DeleteSnapshots)用于删除快照。
117
+
118
+ * 快照必须处于NORMAL状态,快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
119
+ * 支持批量操作。如果多个快照存在无法删除的快照,则操作不执行,以特定的错误码返回。
120
+ */
121
121
  DeleteSnapshots(req: DeleteSnapshotsRequest, cb?: (error: string, rep: DeleteSnapshotsResponse) => void): Promise<DeleteSnapshotsResponse>;
122
122
  /**
123
- * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
124
-
125
- * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
126
- * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
127
- */
123
+ * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
124
+
125
+ * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
126
+ * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
127
+ */
128
128
  ModifySnapshotAttribute(req: ModifySnapshotAttributeRequest, cb?: (error: string, rep: ModifySnapshotAttributeResponse) => void): Promise<ModifySnapshotAttributeResponse>;
129
129
  /**
130
130
  * 本接口(DescribeDiskAssociatedAutoSnapshotPolicy)用于查询云盘绑定的定期快照策略。
131
131
  */
132
132
  DescribeDiskAssociatedAutoSnapshotPolicy(req: DescribeDiskAssociatedAutoSnapshotPolicyRequest, cb?: (error: string, rep: DescribeDiskAssociatedAutoSnapshotPolicyResponse) => void): Promise<DescribeDiskAssociatedAutoSnapshotPolicyResponse>;
133
133
  /**
134
- * 本接口(BindAutoSnapshotPolicy)用于绑定云硬盘到指定的定期快照策略。
135
-
136
- * 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
137
- * 当已绑定定期快照策略的云硬盘处于未使用状态(即弹性云盘未挂载或非弹性云盘的主机处于关机状态)将不会创建定期快照。
138
- */
134
+ * 本接口(BindAutoSnapshotPolicy)用于绑定云硬盘到指定的定期快照策略。
135
+
136
+ * 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
137
+ * 当已绑定定期快照策略的云硬盘处于未使用状态(即弹性云盘未挂载或非弹性云盘的主机处于关机状态)将不会创建定期快照。
138
+ */
139
139
  BindAutoSnapshotPolicy(req: BindAutoSnapshotPolicyRequest, cb?: (error: string, rep: BindAutoSnapshotPolicyResponse) => void): Promise<BindAutoSnapshotPolicyResponse>;
140
140
  /**
141
- * 本接口(DescribeSnapshots)用于查询快照的详细信息。
142
-
143
- * 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
144
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的快照列表。
145
- */
141
+ * 本接口(DescribeSnapshots)用于查询快照的详细信息。
142
+
143
+ * 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
144
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的快照列表。
145
+ */
146
146
  DescribeSnapshots(req: DescribeSnapshotsRequest, cb?: (error: string, rep: DescribeSnapshotsResponse) => void): Promise<DescribeSnapshotsResponse>;
147
147
  /**
148
148
  * 本接口(DescribeSnapshotSharePermission)用于查询快照的分享信息。
149
149
  */
150
150
  DescribeSnapshotSharePermission(req: DescribeSnapshotSharePermissionRequest, cb?: (error: string, rep: DescribeSnapshotSharePermissionResponse) => void): Promise<DescribeSnapshotSharePermissionResponse>;
151
151
  /**
152
- * 重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点:
153
- 1. 如果云硬盘是由快照创建的,则重新初始化会通过此快照重新回滚此云硬盘,即将云硬盘恢复为与快照一致的状态;
154
- 2. 如果云硬盘不是通过快照创建的,则重新初始化会清空此云硬盘的数据;请在重新初始化云硬盘前检查并备份必要的数据;
155
- 3. 当前仅未挂载的、非共享属性的数据盘云硬盘支持重新初始化;
156
- 4. 当创建此云硬盘的原始快照被删除时,不再支持重新初始化此云硬盘。
157
- */
152
+ * 重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点:
153
+ 1. 如果云硬盘是由快照创建的,则重新初始化会通过此快照重新回滚此云硬盘,即将云硬盘恢复为与快照一致的状态;
154
+ 2. 如果云硬盘不是通过快照创建的,则重新初始化会清空此云硬盘的数据;请在重新初始化云硬盘前检查并备份必要的数据;
155
+ 3. 当前仅未挂载的、非共享属性的数据盘云硬盘支持重新初始化;
156
+ 4. 当创建此云硬盘的原始快照被删除时,不再支持重新初始化此云硬盘。
157
+ */
158
158
  InitializeDisks(req: InitializeDisksRequest, cb?: (error: string, rep: InitializeDisksResponse) => void): Promise<InitializeDisksResponse>;
159
159
  /**
160
- * 接口请求域名: cbs.tencentcloudapi.com 。
161
-
162
- 本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。
163
-
164
- 只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。
165
- 非弹性云盘不支持此接口,请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。
166
- 默认接口请求频率限制:10次/秒。
167
-
168
- */
160
+ * 接口请求域名: cbs.tencentcloudapi.com 。
161
+
162
+ 本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。
163
+
164
+ 只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。
165
+ 非弹性云盘不支持此接口,请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。
166
+ 默认接口请求频率限制:10次/秒。
167
+
168
+ */
169
169
  ModifyDisksChargeType(req: ModifyDisksChargeTypeRequest, cb?: (error: string, rep: ModifyDisksChargeTypeResponse) => void): Promise<ModifyDisksChargeTypeResponse>;
170
170
  /**
171
- * 本接口(TerminateDisks)用于退还云硬盘。
172
-
173
- * 不再使用的云盘,可通过本接口主动退还。
174
- * 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还,预付费云盘需符合退还规则。
175
- * 支持批量操作,每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的,请求会以特定错误码返回。
176
- */
171
+ * 本接口(TerminateDisks)用于退还云硬盘。
172
+
173
+ * 不再使用的云盘,可通过本接口主动退还。
174
+ * 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还,预付费云盘需符合退还规则。
175
+ * 支持批量操作,每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的,请求会以特定错误码返回。
176
+ */
177
177
  TerminateDisks(req: TerminateDisksRequest, cb?: (error: string, rep: TerminateDisksResponse) => void): Promise<TerminateDisksResponse>;
178
178
  /**
179
179
  * 本接口(DescribeDiskConfigQuota)用于查询云硬盘配额。
180
180
  */
181
181
  DescribeDiskConfigQuota(req: DescribeDiskConfigQuotaRequest, cb?: (error: string, rep: DescribeDiskConfigQuotaResponse) => void): Promise<DescribeDiskConfigQuotaResponse>;
182
182
  /**
183
- * 本接口(UnbindAutoSnapshotPolicy)用于解除云硬盘绑定的定期快照策略。
184
-
185
- * 支持批量操作,可一次解除多个云盘与同一定期快照策略的绑定。
186
- * 如果传入的云盘未绑定到当前定期快照策略,接口将自动跳过,仅解绑与当前定期快照策略绑定的云盘。
187
- */
183
+ * 本接口(UnbindAutoSnapshotPolicy)用于解除云硬盘绑定的定期快照策略。
184
+
185
+ * 支持批量操作,可一次解除多个云盘与同一定期快照策略的绑定。
186
+ * 如果传入的云盘未绑定到当前定期快照策略,接口将自动跳过,仅解绑与当前定期快照策略绑定的云盘。
187
+ */
188
188
  UnbindAutoSnapshotPolicy(req: UnbindAutoSnapshotPolicyRequest, cb?: (error: string, rep: UnbindAutoSnapshotPolicyResponse) => void): Promise<UnbindAutoSnapshotPolicyResponse>;
189
189
  /**
190
- * 本接口(DescribeDiskStoragePool)查询用户的云硬盘独享集群列表。
191
-
192
- * 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息,不同的过滤条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
193
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘独享集群列表。
194
- */
190
+ * 本接口(DescribeDiskStoragePool)查询用户的云硬盘独享集群列表。
191
+
192
+ * 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息,不同的过滤条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
193
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘独享集群列表。
194
+ */
195
195
  DescribeDiskStoragePool(req: DescribeDiskStoragePoolRequest, cb?: (error: string, rep: DescribeDiskStoragePoolResponse) => void): Promise<DescribeDiskStoragePoolResponse>;
196
196
  /**
197
- * 本接口(ApplySnapshot)用于回滚快照到原云硬盘。
198
-
199
- * 仅支持回滚到原云硬盘上。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘,将快照数据复制到新购云盘上。
200
- * 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
201
- * 如果是弹性云盘,则云盘必须处于未挂载状态,云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询,见Attached字段解释;如果是随实例一起购买的非弹性云盘,则实例必须处于关机状态,实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
202
- */
197
+ * 本接口(ApplySnapshot)用于回滚快照到原云硬盘。
198
+
199
+ * 仅支持回滚到原云硬盘上。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘,将快照数据复制到新购云盘上。
200
+ * 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
201
+ * 如果是弹性云盘,则云盘必须处于未挂载状态,云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询,见Attached字段解释;如果是随实例一起购买的非弹性云盘,则实例必须处于关机状态,实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
202
+ */
203
203
  ApplySnapshot(req: ApplySnapshotRequest, cb?: (error: string, rep: ApplySnapshotResponse) => void): Promise<ApplySnapshotResponse>;
204
204
  /**
205
- * 本接口(DescribeSnapshotOperationLogs)用于查询快照操作日志列表。
206
-
207
- 可根据快照ID过滤。快照ID形如:snap-a1kmcp13。
208
-
209
- */
205
+ * 本接口(DescribeSnapshotOperationLogs)用于查询快照操作日志列表。
206
+
207
+ 可根据快照ID过滤。快照ID形如:snap-a1kmcp13。
208
+
209
+ */
210
210
  DescribeSnapshotOperationLogs(req: DescribeSnapshotOperationLogsRequest, cb?: (error: string, rep: DescribeSnapshotOperationLogsResponse) => void): Promise<DescribeSnapshotOperationLogsResponse>;
211
211
  /**
212
- * 本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
213
-
214
- 分享快照后,被分享账户可以通过该快照创建云硬盘。
215
- * 每个快照最多可分享给50个账户。
216
- * 分享快照无法更改名称,描述,仅可用于创建云硬盘。
217
- * 只支持分享到对方账户相同地域。
218
- * 仅支持分享数据盘快照。
219
- */
212
+ * 本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
213
+
214
+ 分享快照后,被分享账户可以通过该快照创建云硬盘。
215
+ * 每个快照最多可分享给50个账户。
216
+ * 分享快照无法更改名称,描述,仅可用于创建云硬盘。
217
+ * 只支持分享到对方账户相同地域。
218
+ * 仅支持分享数据盘快照。
219
+ */
220
220
  ModifySnapshotsSharePermission(req: ModifySnapshotsSharePermissionRequest, cb?: (error: string, rep: ModifySnapshotsSharePermissionResponse) => void): Promise<ModifySnapshotsSharePermissionResponse>;
221
221
  /**
222
- * 本接口(CreateSnapshot)用于对指定云盘创建快照。
223
-
224
- * 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
225
- * 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
226
- * 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
227
- */
222
+ * 本接口(CreateSnapshot)用于对指定云盘创建快照。
223
+
224
+ * 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
225
+ * 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
226
+ * 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
227
+ */
228
228
  CreateSnapshot(req: CreateSnapshotRequest, cb?: (error: string, rep: CreateSnapshotResponse) => void): Promise<CreateSnapshotResponse>;
229
229
  /**
230
230
  * 获取快照概览信息
231
231
  */
232
232
  GetSnapOverview(req?: GetSnapOverviewRequest, cb?: (error: string, rep: GetSnapOverviewResponse) => void): Promise<GetSnapOverviewResponse>;
233
233
  /**
234
- * 本接口(ResizeDisk)用于扩容云硬盘。
235
-
236
- * 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
237
- * 本接口为异步接口,接口成功返回时,云盘并未立即扩容到指定大小,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态为“EXPANDING”,表示正在扩容中。
238
- */
234
+ * 本接口(ResizeDisk)用于扩容云硬盘。
235
+
236
+ * 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
237
+ * 本接口为异步接口,接口成功返回时,云盘并未立即扩容到指定大小,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态为“EXPANDING”,表示正在扩容中。
238
+ */
239
239
  ResizeDisk(req: ResizeDiskRequest, cb?: (error: string, rep: ResizeDiskResponse) => void): Promise<ResizeDiskResponse>;
240
240
  /**
241
- * 本接口(DetachDisks)用于卸载云硬盘。
242
-
243
- * 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
244
- * 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
245
- */
241
+ * 本接口(DetachDisks)用于卸载云硬盘。
242
+
243
+ * 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
244
+ * 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
245
+ */
246
246
  DetachDisks(req: DetachDisksRequest, cb?: (error: string, rep: DetachDisksResponse) => void): Promise<DetachDisksResponse>;
247
247
  /**
248
- * 本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
249
-
250
- * 只支持查询预付费模式的弹性云盘续费价格。
251
- * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到实例续费后的到期时间来续费询价。
252
- * 支持为多块云盘指定不同的续费时长,此时返回的价格为多块云盘续费的总价格。
253
- */
248
+ * 本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
249
+
250
+ * 只支持查询预付费模式的弹性云盘续费价格。
251
+ * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到实例续费后的到期时间来续费询价。
252
+ * 支持为多块云盘指定不同的续费时长,此时返回的价格为多块云盘续费的总价格。
253
+ */
254
254
  InquiryPriceRenewDisks(req: InquiryPriceRenewDisksRequest, cb?: (error: string, rep: InquiryPriceRenewDisksResponse) => void): Promise<InquiryPriceRenewDisksResponse>;
255
255
  }