tencentcloud-sdk-nodejs-cbs 4.1.23 → 4.1.27

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-cbs",
3
- "version": "4.1.23",
3
+ "version": "4.1.27",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -149,7 +149,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
149
149
  */
150
150
  CreateDisks(req: CreateDisksRequest, cb?: (error: string, rep: CreateDisksResponse) => void): Promise<CreateDisksResponse>;
151
151
  /**
152
- * * 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
152
+ * * 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。是否是弹性云盘可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
153
153
  * “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
154
154
  * 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
155
155
  */
@@ -217,7 +217,7 @@ class Client extends TencentCloudCommon.AbstractClient {
217
217
  return this.request("CreateDisks", req, cb);
218
218
  }
219
219
  /**
220
- * * 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
220
+ * * 只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。是否是弹性云盘可以通过[DescribeDisks](/document/product/362/16315)接口查询,见输出参数中Portable字段解释。
221
221
  * “云硬盘名称”仅为方便用户自己管理之用,腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
222
222
  * 支持批量操作,如果传入多个云盘ID,则所有云盘修改为同一属性。如果存在不允许操作的云盘,则操作不执行,以特定错误码返回。
223
223
  */
@@ -711,12 +711,10 @@ export interface ResizeDiskResponse {
711
711
  export interface Disk {
712
712
  /**
713
713
  * 云盘是否与挂载的实例一起销毁。<br><li>true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。</li><li>false:销毁实例时不销毁云盘。</li>
714
- 注意:此字段可能返回 null,表示取不到有效值。
715
714
  */
716
715
  DeleteWithInstance?: boolean;
717
716
  /**
718
717
  * 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费</li><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费</li><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。</li>
719
- 注意:此字段可能返回 null,表示取不到有效值。
720
718
  */
721
719
  RenewFlag?: string;
722
720
  /**
@@ -733,7 +731,6 @@ export interface Disk {
733
731
  SnapshotCount?: number;
734
732
  /**
735
733
  * 云盘已挂载到子机,且子机与云盘都是包年包月。<br><li>true:子机设置了自动续费标识,但云盘未设置</li><li>false:云盘自动续费标识正常。</li>
736
- 注意:此字段可能返回 null,表示取不到有效值。
737
734
  */
738
735
  AutoRenewFlagError?: boolean;
739
736
  /**
@@ -758,7 +755,6 @@ export interface Disk {
758
755
  BackupDisk?: boolean;
759
756
  /**
760
757
  * 与云盘绑定的标签,云盘未绑定标签则取值为空。
761
- 注意:此字段可能返回 null,表示取不到有效值。
762
758
  */
763
759
  Tags?: Array<Tag>;
764
760
  /**
@@ -767,22 +763,19 @@ export interface Disk {
767
763
  InstanceId?: string;
768
764
  /**
769
765
  * 云盘的挂载类型。取值范围:<br><li>PF: PF挂载</li><li>VF: VF挂载</li>
770
- 注意:此字段可能返回 null,表示取不到有效值。
771
766
  */
772
767
  AttachMode?: string;
773
768
  /**
774
- * 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
769
+ * 云盘关联的定期快照ID。只有在调用[DescribeDisks](/document/product/362/16315)接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
775
770
  注意:此字段可能返回 null,表示取不到有效值。
776
771
  */
777
772
  AutoSnapshotPolicyIds?: Array<string>;
778
773
  /**
779
- * 云硬盘额外性能值,单位MB/s。
780
- 注意:此字段可能返回 null,表示取不到有效值。
774
+ * 云硬盘额外性能值,单位MiB/s。
781
775
  */
782
776
  ThroughputPerformance?: number;
783
777
  /**
784
778
  * 云盘是否处于类型变更中。取值范围:<br><li>false:表示云盘不处于类型变更中</li><li>true:表示云盘已发起类型变更,正处于迁移中。</li>
785
- 注意:此字段可能返回 null,表示取不到有效值。
786
779
  */
787
780
  Migrating?: boolean;
788
781
  /**
@@ -790,7 +783,7 @@ export interface Disk {
790
783
  */
791
784
  DiskId?: string;
792
785
  /**
793
- * 云盘拥有的快照总容量,单位为MB
786
+ * 云盘拥有的快照总容量,单位为MiB
794
787
  */
795
788
  SnapshotSize?: number;
796
789
  /**
@@ -816,7 +809,6 @@ export interface Disk {
816
809
  DiskSize?: number;
817
810
  /**
818
811
  * 云盘类型变更的迁移进度,取值0到100。
819
- 注意:此字段可能返回 null,表示取不到有效值。
820
812
  */
821
813
  MigratePercent?: number;
822
814
  /**
@@ -837,7 +829,6 @@ export interface Disk {
837
829
  SnapshotAbility?: boolean;
838
830
  /**
839
831
  * 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。<br><li>true:云盘到期时间早于实例。</li><li>false:云盘到期时间晚于实例。</li>
840
- 注意:此字段可能返回 null,表示取不到有效值。
841
832
  */
842
833
  DeadlineError?: boolean;
843
834
  /**
@@ -845,13 +836,12 @@ export interface Disk {
845
836
  */
846
837
  RollbackPercent?: number;
847
838
  /**
848
- * 当前时间距离盘到期的天数(仅对预付费盘有意义)。
839
+ * 当前时间距离云硬盘到期的天数(仅对预付费云硬盘有意义)
849
840
  注意:此字段可能返回 null,表示取不到有效值。
850
841
  */
851
842
  DifferDaysOfDeadline?: number;
852
843
  /**
853
- * 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:<br><li>1:云硬盘已经退还</li><li>2:云硬盘已过期</li><li>3:云盘不支持退还</li><li>8:超过可退还数量的限制。</li>
854
- 注意:此字段可能返回 null,表示取不到有效值。
844
+ * 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:<br><li>1:云硬盘已经退还</li><li>2:云硬盘已过期</li><li>3:云盘不支持退还</li><li>8:超过可退还数量的限制。</li><li>10:非弹性云硬盘、系统盘、后付费云硬盘等不支持退还</li>
855
845
  */
856
846
  ReturnFailCode?: number;
857
847
  /**
@@ -885,19 +875,20 @@ export interface Disk {
885
875
  LastAttachInsId?: string;
886
876
  /**
887
877
  * 云硬盘最后一次操作错误提示
888
- 注意:此字段可能返回 null,表示取不到有效值。
889
878
  */
890
879
  ErrorPrompt?: string;
891
880
  /**
892
881
  * 云盘是否开启性能突发
893
- 注意:此字段可能返回 null,表示取不到有效值。
894
882
  */
895
883
  BurstPerformance?: boolean;
896
884
  /**
897
885
  * 云硬盘加密类型,值为ENCRYPT_V1和ENCRYPT_V2,分别表示第一代和第二代加密技术,两种加密技术互不兼容
898
- 注意:此字段可能返回 null,表示取不到有效值。
899
886
  */
900
887
  EncryptType?: string;
888
+ /**
889
+ * 加密盘密钥ID
890
+ */
891
+ KmsKeyId?: string;
901
892
  }
902
893
  /**
903
894
  * TerminateDisks返回参数结构体
@@ -1214,7 +1205,8 @@ export interface ModifySnapshotAttributeResponse {
1214
1205
  */
1215
1206
  export interface ModifyDiskAttributesRequest {
1216
1207
  /**
1217
- * 一个或多个待操作的云硬盘ID。如果传入多个云盘ID,仅支持所有云盘修改为同一属性。
1208
+ * 一个或多个待操作的云硬盘ID,可以通过[DescribeDisks](/document/product/362/16315)接口查询。如果传入多个云盘ID,仅支持将所有云盘修改为同一属性。
1209
+
1218
1210
  */
1219
1211
  DiskIds: Array<string>;
1220
1212
  /**
@@ -1235,10 +1227,13 @@ export interface ModifyDiskAttributesRequest {
1235
1227
  DeleteWithInstance?: boolean;
1236
1228
  /**
1237
1229
  * 变更云盘类型时,可传入该参数,表示变更的目标类型,取值范围:<br><li>CLOUD_PREMIUM:表示高性能云硬盘</li><li>CLOUD_SSD:表示SSD云硬盘。</li>当前不支持批量变更类型,即传入DiskType时,DiskIds仅支持传入一块云盘;<br>变更云盘类型时不支持同时变更其他属性。
1230
+ 具体说明请参考[调整云硬盘类型](https://cloud.tencent.com/document/product/362/32540)
1238
1231
  */
1239
1232
  DiskType?: string;
1240
1233
  /**
1241
- * 开启/关闭云盘性能突发功能
1234
+ * 开启/关闭云盘性能突发功能,取值范围:
1235
+ CREATE:开启
1236
+ CANCEL:关闭
1242
1237
  */
1243
1238
  BurstPerformanceOperation?: string;
1244
1239
  }
@@ -1363,7 +1358,7 @@ export interface ModifyDisksChargeTypeRequest {
1363
1358
  */
1364
1359
  export interface InitializeDisksRequest {
1365
1360
  /**
1366
- * 待重新初始化的云硬盘ID列表, 单次初始化限制20块以内
1361
+ * 待重新初始化的云硬盘ID列表,可以通过[DescribeDisks](/document/product/362/16315)接口查询, 单次初始化限制20块以内
1367
1362
  */
1368
1363
  DiskIds: Array<string>;
1369
1364
  }
@@ -1891,7 +1886,7 @@ export interface DiskBackup {
1891
1886
  */
1892
1887
  export interface DescribeDisksRequest {
1893
1888
  /**
1894
- * 过滤条件。参数不支持同时指定`DiskIds`和`Filters`。<br> <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按云盘类型过滤。 (SYSTEM_DISK:表示系统盘 | DATA_DISK:表示数据盘)<br></li> <li>disk-charge-type - Array of String - 是否必填:否 -(过滤条件)按照云硬盘计费模式过滤。 (PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费。)<br></li> <li>portable - Array of String - 是否必填:否 -(过滤条件)按是否为弹性云盘过滤。 (TRUE:表示弹性云盘 | FALSE:表示非弹性云盘。)<br></li> <li>project-id - Array of Integer - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。<br></li> <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照云硬盘ID过滤。云盘ID形如:`disk-11112222`。<br></li> <li>disk-name - Array of String - 是否必填:否 -(过滤条件)按照云盘名称过滤。<br></li> <li>disk-type - Array of String - 是否必填:否 -(过滤条件)按照云盘介质类型过滤。(CLOUD_BASIC:表示普通云硬盘 | CLOUD_PREMIUM:表示高性能云硬盘。| CLOUD_SSD:表示SSD云硬盘 | CLOUD_HSSD:表示增强型SSD云硬盘。| CLOUD_TSSD:表示极速型云硬盘。)<br></li> <li>disk-state - Array of String - 是否必填:否 -(过滤条件)按照云盘状态过滤。(UNATTACHED:未挂载 | ATTACHING:挂载中 | ATTACHED:已挂载 | DETACHING:解挂中 | EXPANDING:扩容中 | ROLLBACKING:回滚中 | TORECYCLE:待回收。)<br></li> <li>instance-id - Array of String - 是否必填:否 -(过滤条件)按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。<br></li> <li>zone - Array of String - 是否必填:否 -(过滤条件)按照[可用区](/document/product/213/15753#ZoneInfo)过滤。<br></li> <li>instance-ip-address - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载云主机的内网或外网IP过滤。<br></li> <li>instance-name - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载的实例名称过滤。<br></li> <li>tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键进行过滤。<br></li> <li>tag-value - Array of String - 是否必填:否 -(过滤条件)照标签值进行过滤。<br></li> <li>tag:tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。<br></li> <li>dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。<br></li> <li>cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。</li>
1889
+ * 过滤条件。参数不支持同时指定`DiskIds`和`Filters`。<br> <li>disk-usage - Array of String - 是否必填:否 -(过滤条件)按云盘类型过滤。 (SYSTEM_DISK:表示系统盘 | DATA_DISK:表示数据盘)<br></li> <li>disk-charge-type - Array of String - 是否必填:否 -(过滤条件)按照云硬盘计费模式过滤。 (PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费。)<br></li> <li>portable - Array of String - 是否必填:否 -(过滤条件)按是否为弹性云盘过滤。 (TRUE:表示弹性云盘 | FALSE:表示非弹性云盘。)<br></li> <li>project-id - Array of String - 是否必填:否 -(过滤条件)按云硬盘所属项目ID过滤。<br></li> <li>disk-id - Array of String - 是否必填:否 -(过滤条件)按照云硬盘ID过滤。云盘ID形如:`disk-11112222`。<br></li> <li>disk-name - Array of String - 是否必填:否 -(过滤条件)按照云盘名称过滤。<br></li> <li>disk-type - Array of String - 是否必填:否 -(过滤条件)按照云盘介质类型过滤。(CLOUD_BASIC:表示普通云硬盘 | CLOUD_PREMIUM:表示高性能云硬盘。| CLOUD_SSD:表示SSD云硬盘 | CLOUD_HSSD:表示增强型SSD云硬盘。| CLOUD_TSSD:表示极速型云硬盘。)<br></li> <li>disk-state - Array of String - 是否必填:否 -(过滤条件)按照云盘状态过滤。(UNATTACHED:未挂载 | ATTACHING:挂载中 | ATTACHED:已挂载 | DETACHING:解挂中 | EXPANDING:扩容中 | ROLLBACKING:回滚中 | TORECYCLE:待回收 | DUMPING:拷贝硬盘中。)<br></li> <li>instance-id - Array of String - 是否必填:否 -(过滤条件)按照云盘挂载的云主机实例ID过滤。可根据此参数查询挂载在指定云主机下的云硬盘。<br></li> <li>zone - Array of String - 是否必填:否 -(过滤条件)按照[可用区](/document/product/213/15753#ZoneInfo)过滤。<br></li> <li>instance-ip-address - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载云主机的内网或外网IP过滤。<br></li> <li>instance-name - Array of String - 是否必填:否 -(过滤条件)按云盘所挂载的实例名称过滤。<br></li> <li>tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键进行过滤。<br></li> <li>tag-value - Array of String - 是否必填:否 -(过滤条件)照标签值进行过滤。<br></li> <li>tag:tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。<br></li> <li>dedicated-cluster-id - Array of String - 是否必填:否 -(过滤条件)按照 CDC 独享集群 ID 进行过滤。<br></li> <li>cluster-group-id - String - 是否必填:否 -(过滤条件)按照 集群群组 ID 进行过滤。</li>
1895
1890
  */
1896
1891
  Filters?: Array<Filter>;
1897
1892
  /**