tencentcloud-sdk-nodejs-cbs 4.0.388 → 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.
@@ -28,44 +28,44 @@ class Client extends TencentCloudCommon.AbstractClient {
28
28
  super("cbs.tencentcloudapi.com", "2017-03-12", clientConfig);
29
29
  }
30
30
  /**
31
- * 本接口(ModifyDiskExtraPerformance)用于调整云硬盘额外的性能。
32
-
33
- * 目前仅支持极速型SSD云硬盘(CLOUD_TSSD)和高性能SSD云硬盘(CLOUD_HSSD)。
34
- */
31
+ * 本接口(ModifyDiskExtraPerformance)用于调整云硬盘额外的性能。
32
+
33
+ * 目前仅支持极速型SSD云硬盘(CLOUD_TSSD)和高性能SSD云硬盘(CLOUD_HSSD)。
34
+ */
35
35
  async ModifyDiskExtraPerformance(req, cb) {
36
36
  return this.request("ModifyDiskExtraPerformance", req, cb);
37
37
  }
38
38
  /**
39
- * 本接口(RenewDisk)用于续费云硬盘。
40
-
41
- * 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中DiskChargeType字段解释。
42
- * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到子机续费后的到期时间来续费。
43
- */
39
+ * 本接口(RenewDisk)用于续费云硬盘。
40
+
41
+ * 只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中DiskChargeType字段解释。
42
+ * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到子机续费后的到期时间来续费。
43
+ */
44
44
  async RenewDisk(req, cb) {
45
45
  return this.request("RenewDisk", req, cb);
46
46
  }
47
47
  /**
48
- * 本接口(CopySnapshotCrossRegions)用于快照跨地域复制。
49
-
50
- * 本接口为异步接口,当跨地域复制的请求下发成功后会返回一个新的快照ID,此时快照未立即复制到目标地域,可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态,判断是否复制完成。如果快照的状态为“NORMAL”,表示快照复制完成。
51
- * 本接口实现的快照跨地域复制操作将产生跨地域流量,预计2022年第三季度会针对此功能进行商业化计费;请留意后续站内信公告,避免产生预期外扣费。
52
- */
48
+ * 本接口(CopySnapshotCrossRegions)用于快照跨地域复制。
49
+
50
+ * 本接口为异步接口,当跨地域复制的请求下发成功后会返回一个新的快照ID,此时快照未立即复制到目标地域,可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态,判断是否复制完成。如果快照的状态为“NORMAL”,表示快照复制完成。
51
+ * 本接口实现的快照跨地域复制操作将产生跨地域流量,预计2022年第三季度会针对此功能进行商业化计费;请留意后续站内信公告,避免产生预期外扣费。
52
+ */
53
53
  async CopySnapshotCrossRegions(req, cb) {
54
54
  return this.request("CopySnapshotCrossRegions", req, cb);
55
55
  }
56
56
  /**
57
- * 本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。
58
-
59
- * 支持批量操作,当传入多个云服务器实例ID,返回结果会分别列出每个云服务器挂载的云硬盘数量。
60
- */
57
+ * 本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。
58
+
59
+ * 支持批量操作,当传入多个云服务器实例ID,返回结果会分别列出每个云服务器挂载的云硬盘数量。
60
+ */
61
61
  async DescribeInstancesDiskNum(req, cb) {
62
62
  return this.request("DescribeInstancesDiskNum", req, cb);
63
63
  }
64
64
  /**
65
- * 本接口(InquiryPriceResizeDisk)用于扩容云硬盘询价。
66
-
67
- * 只支持预付费模式的云硬盘扩容询价。
68
- */
65
+ * 本接口(InquiryPriceResizeDisk)用于扩容云硬盘询价。
66
+
67
+ * 只支持预付费模式的云硬盘扩容询价。
68
+ */
69
69
  async InquiryPriceResizeDisk(req, cb) {
70
70
  return this.request("InquiryPriceResizeDisk", req, cb);
71
71
  }
@@ -76,21 +76,21 @@ class Client extends TencentCloudCommon.AbstractClient {
76
76
  return this.request("InquirePriceModifyDiskExtraPerformance", req, cb);
77
77
  }
78
78
  /**
79
- * 本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
80
-
81
- * 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
82
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的定期快照策略表。
83
-
84
- */
79
+ * 本接口(DescribeAutoSnapshotPolicies)用于查询定期快照策略。
80
+
81
+ * 可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
82
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的定期快照策略表。
83
+
84
+ */
85
85
  async DescribeAutoSnapshotPolicies(req, cb) {
86
86
  return this.request("DescribeAutoSnapshotPolicies", req, cb);
87
87
  }
88
88
  /**
89
- * 本接口(AttachDisks)用于挂载云硬盘。
90
-
91
- * 支持批量操作,将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘,则操作不执行,返回特定的错误码。
92
- * 本接口为异步接口,当挂载云盘的请求成功返回时,表示后台已发起挂载云盘的操作,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHING”变为“ATTACHED”,则为挂载成功。
93
- */
89
+ * 本接口(AttachDisks)用于挂载云硬盘。
90
+
91
+ * 支持批量操作,将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘,则操作不执行,返回特定的错误码。
92
+ * 本接口为异步接口,当挂载云盘的请求成功返回时,表示后台已发起挂载云盘的操作,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHING”变为“ATTACHED”,则为挂载成功。
93
+ */
94
94
  async AttachDisks(req, cb) {
95
95
  return this.request("AttachDisks", req, cb);
96
96
  }
@@ -101,19 +101,19 @@ class Client extends TencentCloudCommon.AbstractClient {
101
101
  return this.request("ModifyDisksRenewFlag", req, cb);
102
102
  }
103
103
  /**
104
- * 本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。
105
-
106
- * 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
107
- * 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。
108
- */
104
+ * 本接口(ModifyAutoSnapshotPolicyAttribute)用于修改定期快照策略属性。
105
+
106
+ * 可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
107
+ * 修改保留天数时必须保证不与是否永久保留属性冲突,否则整个操作失败,以特定的错误码返回。
108
+ */
109
109
  async ModifyAutoSnapshotPolicyAttribute(req, cb) {
110
110
  return this.request("ModifyAutoSnapshotPolicyAttribute", req, cb);
111
111
  }
112
112
  /**
113
- * 本接口(InquiryPriceCreateDisks)用于创建云硬盘询价。
114
-
115
- * 支持查询创建多块云硬盘的价格,此时返回结果为总价格。
116
- */
113
+ * 本接口(InquiryPriceCreateDisks)用于创建云硬盘询价。
114
+
115
+ * 支持查询创建多块云硬盘的价格,此时返回结果为总价格。
116
+ */
117
117
  async InquiryPriceCreateDisks(req, cb) {
118
118
  return this.request("InquiryPriceCreateDisks", req, cb);
119
119
  }
@@ -124,64 +124,64 @@ class Client extends TencentCloudCommon.AbstractClient {
124
124
  return this.request("DescribeDiskOperationLogs", req, cb);
125
125
  }
126
126
  /**
127
- * 本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
128
-
129
- * 支持批量操作。如果多个定期快照策略存在无法删除的,则操作不执行,以特定错误码返回。
130
- */
127
+ * 本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
128
+
129
+ * 支持批量操作。如果多个定期快照策略存在无法删除的,则操作不执行,以特定错误码返回。
130
+ */
131
131
  async DeleteAutoSnapshotPolicies(req, cb) {
132
132
  return this.request("DeleteAutoSnapshotPolicies", req, cb);
133
133
  }
134
134
  /**
135
- * 本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。
136
-
137
- * 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
138
- * 每个地域可创建的快照有数量和容量的限制,具体请见腾讯云控制台快照页面提示,如果快照超配额,定期快照创建会失败。
139
- */
135
+ * 本接口(CreateAutoSnapshotPolicy)用于创建定期快照策略。
136
+
137
+ * 每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
138
+ * 每个地域可创建的快照有数量和容量的限制,具体请见腾讯云控制台快照页面提示,如果快照超配额,定期快照创建会失败。
139
+ */
140
140
  async CreateAutoSnapshotPolicy(req, cb) {
141
141
  return this.request("CreateAutoSnapshotPolicy", req, cb);
142
142
  }
143
143
  /**
144
- * 本接口(DescribeDisks)用于查询云硬盘列表。
145
-
146
- * 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
147
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘列表。
148
- */
144
+ * 本接口(DescribeDisks)用于查询云硬盘列表。
145
+
146
+ * 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
147
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘列表。
148
+ */
149
149
  async DescribeDisks(req, cb) {
150
150
  return this.request("DescribeDisks", req, cb);
151
151
  }
152
152
  /**
153
- * 本接口(CreateDisks)用于创建云硬盘。
154
-
155
- * 预付费云盘的购买会预先扣除本次云盘购买所需金额,在调用本接口前请确保账户余额充足。
156
- * 本接口支持传入数据盘快照来创建云盘,实现将快照数据复制到新购云盘上。
157
- * 本接口为异步接口,当创建请求下发成功后会返回一个新建的云盘ID列表,此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘,如果能查到云盘,且状态为'UNATTACHED'或'ATTACHED',则表示创建成功。
158
- */
153
+ * 本接口(CreateDisks)用于创建云硬盘。
154
+
155
+ * 预付费云盘的购买会预先扣除本次云盘购买所需金额,在调用本接口前请确保账户余额充足。
156
+ * 本接口支持传入数据盘快照来创建云盘,实现将快照数据复制到新购云盘上。
157
+ * 本接口为异步接口,当创建请求下发成功后会返回一个新建的云盘ID列表,此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘,如果能查到云盘,且状态为'UNATTACHED'或'ATTACHED',则表示创建成功。
158
+ */
159
159
  async CreateDisks(req, cb) {
160
160
  return this.request("CreateDisks", req, cb);
161
161
  }
162
162
  /**
163
163
  * * 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
164
- * “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
165
- * 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
164
+ * “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
165
+ * 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
166
166
  */
167
167
  async ModifyDiskAttributes(req, cb) {
168
168
  return this.request("ModifyDiskAttributes", req, cb);
169
169
  }
170
170
  /**
171
- * 本接口(DeleteSnapshots)用于删除快照。
172
-
173
- * 快照必须处于NORMAL状态,快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
174
- * 支持批量操作。如果多个快照存在无法删除的快照,则操作不执行,以特定的错误码返回。
175
- */
171
+ * 本接口(DeleteSnapshots)用于删除快照。
172
+
173
+ * 快照必须处于NORMAL状态,快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
174
+ * 支持批量操作。如果多个快照存在无法删除的快照,则操作不执行,以特定的错误码返回。
175
+ */
176
176
  async DeleteSnapshots(req, cb) {
177
177
  return this.request("DeleteSnapshots", req, cb);
178
178
  }
179
179
  /**
180
- * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
181
-
182
- * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
183
- * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
184
- */
180
+ * 本接口(ModifySnapshotAttribute)用于修改指定快照的属性。
181
+
182
+ * 当前仅支持修改快照名称及将非永久快照修改为永久快照。
183
+ * “快照名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
184
+ */
185
185
  async ModifySnapshotAttribute(req, cb) {
186
186
  return this.request("ModifySnapshotAttribute", req, cb);
187
187
  }
@@ -192,20 +192,20 @@ class Client extends TencentCloudCommon.AbstractClient {
192
192
  return this.request("DescribeDiskAssociatedAutoSnapshotPolicy", req, cb);
193
193
  }
194
194
  /**
195
- * 本接口(BindAutoSnapshotPolicy)用于绑定云硬盘到指定的定期快照策略。
196
-
197
- * 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
198
- * 当已绑定定期快照策略的云硬盘处于未使用状态(即弹性云盘未挂载或非弹性云盘的主机处于关机状态)将不会创建定期快照。
199
- */
195
+ * 本接口(BindAutoSnapshotPolicy)用于绑定云硬盘到指定的定期快照策略。
196
+
197
+ * 每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
198
+ * 当已绑定定期快照策略的云硬盘处于未使用状态(即弹性云盘未挂载或非弹性云盘的主机处于关机状态)将不会创建定期快照。
199
+ */
200
200
  async BindAutoSnapshotPolicy(req, cb) {
201
201
  return this.request("BindAutoSnapshotPolicy", req, cb);
202
202
  }
203
203
  /**
204
- * 本接口(DescribeSnapshots)用于查询快照的详细信息。
205
-
206
- * 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
207
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的快照列表。
208
- */
204
+ * 本接口(DescribeSnapshots)用于查询快照的详细信息。
205
+
206
+ * 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤,不同条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
207
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的快照列表。
208
+ */
209
209
  async DescribeSnapshots(req, cb) {
210
210
  return this.request("DescribeSnapshots", req, cb);
211
211
  }
@@ -216,35 +216,35 @@ class Client extends TencentCloudCommon.AbstractClient {
216
216
  return this.request("DescribeSnapshotSharePermission", req, cb);
217
217
  }
218
218
  /**
219
- * 重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点:
220
- 1. 如果云硬盘是由快照创建的,则重新初始化会通过此快照重新回滚此云硬盘,即将云硬盘恢复为与快照一致的状态;
221
- 2. 如果云硬盘不是通过快照创建的,则重新初始化会清空此云硬盘的数据;请在重新初始化云硬盘前检查并备份必要的数据;
222
- 3. 当前仅未挂载的、非共享属性的数据盘云硬盘支持重新初始化;
223
- 4. 当创建此云硬盘的原始快照被删除时,不再支持重新初始化此云硬盘。
224
- */
219
+ * 重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点:
220
+ 1. 如果云硬盘是由快照创建的,则重新初始化会通过此快照重新回滚此云硬盘,即将云硬盘恢复为与快照一致的状态;
221
+ 2. 如果云硬盘不是通过快照创建的,则重新初始化会清空此云硬盘的数据;请在重新初始化云硬盘前检查并备份必要的数据;
222
+ 3. 当前仅未挂载的、非共享属性的数据盘云硬盘支持重新初始化;
223
+ 4. 当创建此云硬盘的原始快照被删除时,不再支持重新初始化此云硬盘。
224
+ */
225
225
  async InitializeDisks(req, cb) {
226
226
  return this.request("InitializeDisks", req, cb);
227
227
  }
228
228
  /**
229
- * 接口请求域名: cbs.tencentcloudapi.com 。
230
-
231
- 本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。
232
-
233
- 只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。
234
- 非弹性云盘不支持此接口,请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。
235
- 默认接口请求频率限制:10次/秒。
236
-
237
- */
229
+ * 接口请求域名: cbs.tencentcloudapi.com 。
230
+
231
+ 本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。
232
+
233
+ 只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。
234
+ 非弹性云盘不支持此接口,请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。
235
+ 默认接口请求频率限制:10次/秒。
236
+
237
+ */
238
238
  async ModifyDisksChargeType(req, cb) {
239
239
  return this.request("ModifyDisksChargeType", req, cb);
240
240
  }
241
241
  /**
242
- * 本接口(TerminateDisks)用于退还云硬盘。
243
-
244
- * 不再使用的云盘,可通过本接口主动退还。
245
- * 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还,预付费云盘需符合退还规则。
246
- * 支持批量操作,每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的,请求会以特定错误码返回。
247
- */
242
+ * 本接口(TerminateDisks)用于退还云硬盘。
243
+
244
+ * 不再使用的云盘,可通过本接口主动退还。
245
+ * 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还,预付费云盘需符合退还规则。
246
+ * 支持批量操作,每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的,请求会以特定错误码返回。
247
+ */
248
248
  async TerminateDisks(req, cb) {
249
249
  return this.request("TerminateDisks", req, cb);
250
250
  }
@@ -255,61 +255,61 @@ class Client extends TencentCloudCommon.AbstractClient {
255
255
  return this.request("DescribeDiskConfigQuota", req, cb);
256
256
  }
257
257
  /**
258
- * 本接口(UnbindAutoSnapshotPolicy)用于解除云硬盘绑定的定期快照策略。
259
-
260
- * 支持批量操作,可一次解除多个云盘与同一定期快照策略的绑定。
261
- * 如果传入的云盘未绑定到当前定期快照策略,接口将自动跳过,仅解绑与当前定期快照策略绑定的云盘。
262
- */
258
+ * 本接口(UnbindAutoSnapshotPolicy)用于解除云硬盘绑定的定期快照策略。
259
+
260
+ * 支持批量操作,可一次解除多个云盘与同一定期快照策略的绑定。
261
+ * 如果传入的云盘未绑定到当前定期快照策略,接口将自动跳过,仅解绑与当前定期快照策略绑定的云盘。
262
+ */
263
263
  async UnbindAutoSnapshotPolicy(req, cb) {
264
264
  return this.request("UnbindAutoSnapshotPolicy", req, cb);
265
265
  }
266
266
  /**
267
- * 本接口(DescribeDiskStoragePool)查询用户的云硬盘独享集群列表。
268
-
269
- * 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息,不同的过滤条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
270
- * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘独享集群列表。
271
- */
267
+ * 本接口(DescribeDiskStoragePool)查询用户的云硬盘独享集群列表。
268
+
269
+ * 可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息,不同的过滤条件之间为与(AND)的关系,过滤信息详细请见过滤器`Filter`。
270
+ * 如果参数为空,返回当前用户一定数量(`Limit`所指定的数量,默认为20)的云硬盘独享集群列表。
271
+ */
272
272
  async DescribeDiskStoragePool(req, cb) {
273
273
  return this.request("DescribeDiskStoragePool", req, cb);
274
274
  }
275
275
  /**
276
- * 本接口(ApplySnapshot)用于回滚快照到原云硬盘。
277
-
278
- * 仅支持回滚到原云硬盘上。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘,将快照数据复制到新购云盘上。
279
- * 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
280
- * 如果是弹性云盘,则云盘必须处于未挂载状态,云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询,见Attached字段解释;如果是随实例一起购买的非弹性云盘,则实例必须处于关机状态,实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
281
- */
276
+ * 本接口(ApplySnapshot)用于回滚快照到原云硬盘。
277
+
278
+ * 仅支持回滚到原云硬盘上。对于数据盘快照,如果您需要复制快照数据到其它云硬盘上,请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘,将快照数据复制到新购云盘上。
279
+ * 用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询,见输出参数中SnapshotState字段解释。
280
+ * 如果是弹性云盘,则云盘必须处于未挂载状态,云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询,见Attached字段解释;如果是随实例一起购买的非弹性云盘,则实例必须处于关机状态,实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
281
+ */
282
282
  async ApplySnapshot(req, cb) {
283
283
  return this.request("ApplySnapshot", req, cb);
284
284
  }
285
285
  /**
286
- * 本接口(DescribeSnapshotOperationLogs)用于查询快照操作日志列表。
287
-
288
- 可根据快照ID过滤。快照ID形如:snap-a1kmcp13。
289
-
290
- */
286
+ * 本接口(DescribeSnapshotOperationLogs)用于查询快照操作日志列表。
287
+
288
+ 可根据快照ID过滤。快照ID形如:snap-a1kmcp13。
289
+
290
+ */
291
291
  async DescribeSnapshotOperationLogs(req, cb) {
292
292
  return this.request("DescribeSnapshotOperationLogs", req, cb);
293
293
  }
294
294
  /**
295
- * 本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
296
-
297
- 分享快照后,被分享账户可以通过该快照创建云硬盘。
298
- * 每个快照最多可分享给50个账户。
299
- * 分享快照无法更改名称,描述,仅可用于创建云硬盘。
300
- * 只支持分享到对方账户相同地域。
301
- * 仅支持分享数据盘快照。
302
- */
295
+ * 本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
296
+
297
+ 分享快照后,被分享账户可以通过该快照创建云硬盘。
298
+ * 每个快照最多可分享给50个账户。
299
+ * 分享快照无法更改名称,描述,仅可用于创建云硬盘。
300
+ * 只支持分享到对方账户相同地域。
301
+ * 仅支持分享数据盘快照。
302
+ */
303
303
  async ModifySnapshotsSharePermission(req, cb) {
304
304
  return this.request("ModifySnapshotsSharePermission", req, cb);
305
305
  }
306
306
  /**
307
- * 本接口(CreateSnapshot)用于对指定云盘创建快照。
308
-
309
- * 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
310
- * 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
311
- * 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
312
- */
307
+ * 本接口(CreateSnapshot)用于对指定云盘创建快照。
308
+
309
+ * 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
310
+ * 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
311
+ * 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
312
+ */
313
313
  async CreateSnapshot(req, cb) {
314
314
  return this.request("CreateSnapshot", req, cb);
315
315
  }
@@ -320,30 +320,30 @@ class Client extends TencentCloudCommon.AbstractClient {
320
320
  return this.request("GetSnapOverview", req, cb);
321
321
  }
322
322
  /**
323
- * 本接口(ResizeDisk)用于扩容云硬盘。
324
-
325
- * 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
326
- * 本接口为异步接口,接口成功返回时,云盘并未立即扩容到指定大小,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态为“EXPANDING”,表示正在扩容中。
327
- */
323
+ * 本接口(ResizeDisk)用于扩容云硬盘。
324
+
325
+ * 只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。非弹性云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
326
+ * 本接口为异步接口,接口成功返回时,云盘并未立即扩容到指定大小,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态为“EXPANDING”,表示正在扩容中。
327
+ */
328
328
  async ResizeDisk(req, cb) {
329
329
  return this.request("ResizeDisk", req, cb);
330
330
  }
331
331
  /**
332
- * 本接口(DetachDisks)用于卸载云硬盘。
333
-
334
- * 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
335
- * 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
336
- */
332
+ * 本接口(DetachDisks)用于卸载云硬盘。
333
+
334
+ * 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
335
+ * 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
336
+ */
337
337
  async DetachDisks(req, cb) {
338
338
  return this.request("DetachDisks", req, cb);
339
339
  }
340
340
  /**
341
- * 本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
342
-
343
- * 只支持查询预付费模式的弹性云盘续费价格。
344
- * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到实例续费后的到期时间来续费询价。
345
- * 支持为多块云盘指定不同的续费时长,此时返回的价格为多块云盘续费的总价格。
346
- */
341
+ * 本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
342
+
343
+ * 只支持查询预付费模式的弹性云盘续费价格。
344
+ * 支持与挂载实例一起续费的场景,需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline,此时会按对齐到实例续费后的到期时间来续费询价。
345
+ * 支持为多块云盘指定不同的续费时长,此时返回的价格为多块云盘续费的总价格。
346
+ */
347
347
  async InquiryPriceRenewDisks(req, cb) {
348
348
  return this.request("InquiryPriceRenewDisks", req, cb);
349
349
  }