tencentcloud-sdk-nodejs 4.0.635 → 4.0.636

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.
@@ -4759,7 +4759,7 @@ export interface CreateHiveTableByDDLResponse {
4759
4759
  /**
4760
4760
  * 表名称
4761
4761
  */
4762
- Data: string
4762
+ Data?: string
4763
4763
  /**
4764
4764
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4765
4765
  */
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.635";
1
+ export declare const sdkVersion = "4.0.636";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.635";
4
+ exports.sdkVersion = "4.0.636";
@@ -594,6 +594,10 @@ export declare type ListUserStoreRequest = null;
594
594
  * CreateUserGroup返回参数结构体
595
595
  */
596
596
  export interface CreateUserGroupResponse {
597
+ /**
598
+ * 用户组ID
599
+ */
600
+ UserGroupId?: string;
597
601
  /**
598
602
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
599
603
  */
@@ -1410,6 +1414,10 @@ export interface SetPasswordResponse {
1410
1414
  * CreateUserStore返回参数结构体
1411
1415
  */
1412
1416
  export interface CreateUserStoreResponse {
1417
+ /**
1418
+ * 用户目录ID
1419
+ */
1420
+ UserStoreId?: string;
1413
1421
  /**
1414
1422
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1415
1423
  */
@@ -4177,7 +4177,7 @@ export interface ModifyWorkGroupRequest {
4177
4177
  */
4178
4178
  WorkGroupId: number;
4179
4179
  /**
4180
- * 工作组描述
4180
+ * 工作组描述,最大字符数限制50
4181
4181
  */
4182
4182
  WorkGroupDescription: string;
4183
4183
  }
@@ -12,119 +12,144 @@ export interface DescribeSpecInfoRequest {
12
12
  */
13
13
  export interface CreateDBInstanceRequest {
14
14
  /**
15
- * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
15
+ * 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
16
16
  */
17
17
  NodeNum: number;
18
18
  /**
19
- * 实例内存大小,单位:GB
19
+ * 实例内存大小,单位:GB
20
20
  */
21
21
  Memory: number;
22
22
  /**
23
- * 实例硬盘大小,单位:GB
23
+ * 实例硬盘大小,单位:GB
24
24
  */
25
25
  Volume: number;
26
26
  /**
27
- * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本,MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本,MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本
27
+ * 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
28
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
29
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
30
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
31
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
28
32
  */
29
33
  MongoVersion: string;
30
34
  /**
31
- * 实例数量, 最小值1,最大值为10
35
+ * 实例数量, 最小值1,最大值为10
32
36
  */
33
37
  GoodsNum: number;
34
38
  /**
35
- * 实例所属区域名称,格式如:ap-guangzhou-2。注:此参数填写的是主可用区,如果选择多可用区部署,Zone必须是AvailabilityZoneList中的一个
39
+ * 可用区信息,输入格式如:ap-guangzhou-2
40
+ - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
41
+ - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
36
42
  */
37
43
  Zone: string;
38
44
  /**
39
- * 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
45
+ * 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
40
46
  */
41
47
  Period: number;
42
48
  /**
43
- * 机器类型,HIO:高IO型;HIO10G:高IO万兆型;STDS5:标准型
49
+ * 机器类型。
50
+ - HIO:高IO型。
51
+ - HIO10G:高IO万兆。
44
52
  */
45
53
  MachineCode: string;
46
54
  /**
47
- * 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
55
+ * 实例架构类型。
56
+ - REPLSET:副本集。
57
+ - SHARD:分片集群。
48
58
  */
49
59
  ClusterType: string;
50
60
  /**
51
- * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0
61
+ * 指副本集数量。
62
+ - 创建副本集实例,该参数只能为1。
63
+ - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
52
64
  */
53
65
  ReplicateSetNum: number;
54
66
  /**
55
- * 项目ID,不设置为默认项目
67
+ * 项目ID。若不设置该参数,则为默认项目。
56
68
  */
57
69
  ProjectId?: number;
58
70
  /**
59
- * 私有网络 ID,如果不传则默认选择基础网络,请使用 查询私有网络列表
71
+ * 私有网络ID。如果不设置该参数,则默认选择基础网络。
60
72
  */
61
73
  VpcId?: string;
62
74
  /**
63
- * 私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 查询子网列表
75
+ * 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
64
76
  */
65
77
  SubnetId?: string;
66
78
  /**
67
- * 实例密码,不设置该参数则默认密码规则为 实例ID+"@"+主账户uin。举例实例id为cmgo-higv73ed,uin为100000001,则默认密码为"cmgo-higv73ed@100000001"。 自定义密码格式为8-32个字符长度,至少包含字母、数字和字符(!@#%^*()_)中的两种
79
+ * 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
68
80
  */
69
81
  Password?: string;
70
82
  /**
71
- * 实例标签信息
83
+ * 实例标签信息。
72
84
  */
73
85
  Tags?: Array<TagInfo>;
74
86
  /**
75
- * 自动续费标记,可选值为:0 - 不自动续费;1 - 自动续费。默认为不自动续费
87
+ * 自动续费标记。
88
+ - 0:不自动续费。默认为不自动续费。
89
+ - 1:自动续费。
76
90
  */
77
91
  AutoRenewFlag?: number;
78
92
  /**
79
- * 是否自动选择代金券,可选值为:1 - 是;0 - 否; 默认为0
93
+ * 是否自动选择代金券。
94
+ - 1:是。
95
+ - 0:否。默认为0。
80
96
  */
81
97
  AutoVoucher?: number;
82
98
  /**
83
- * 1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例
99
+ * 实例类型。
100
+ - 1:正式实例。
101
+ - 3:只读实例。
102
+ - 4:灾备实例。
84
103
  */
85
104
  Clone?: number;
86
105
  /**
87
- * 若是只读,灾备实例或克隆实例,Father必须填写,即主实例ID
106
+ * 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
88
107
  */
89
108
  Father?: string;
90
109
  /**
91
- * 安全组
110
+ * 安全组。
92
111
  */
93
112
  SecurityGroup?: Array<string>;
94
113
  /**
95
- * 克隆实例回档时间。若是克隆实例,则必须填写,格式:2021-08-13 16:30:00。注:只能回档7天内的时间点
114
+ * 克隆实例回档时间。
115
+ - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
116
+ - 回档时间范围:仅能回档7天内时间点的数据。
96
117
  */
97
118
  RestoreTime?: string;
98
119
  /**
99
- * 实例名称。注:名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
120
+ * 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
100
121
  */
101
122
  InstanceName?: string;
102
123
  /**
103
- * 多可用区部署的节点列表,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:1、多可用区部署节点只能部署在3个不同可用区;2、为了保障跨可用区切换,不支持将集群的大多数节点部署在同一个可用区(如3节点集群不支持2个节点部署在同一个区);3、不支持4.2及以上版本;4、不支持只读灾备实例;5、不能选择基础网络
124
+ * 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
125
+ - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
126
+ - 不支持4.2及以上版本。
127
+ - 不支持只读灾备实例。
128
+ - 不能选择基础网络。
104
129
  */
105
130
  AvailabilityZoneList?: Array<string>;
106
131
  /**
107
- * mongos cpu数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
132
+ * Mongos CPU 核数,购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
108
133
  */
109
134
  MongosCpu?: number;
110
135
  /**
111
- * mongos 内存大小,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
136
+ * Mongos 内存大小。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
112
137
  */
113
138
  MongosMemory?: number;
114
139
  /**
115
- * mongos 数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:为了保障高可用,最低需要购买3个mongos,上限为32
140
+ * Mongos 数量。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。为了保障高可用,取值范围为[3,32]。
116
141
  */
117
142
  MongosNodeNum?: number;
118
143
  /**
119
- * 只读节点数量,最大不超过7个
144
+ * 只读节点数量,取值范围[0,5]。
120
145
  */
121
146
  ReadonlyNodeNum?: number;
122
147
  /**
123
- * 只读节点部署可用区
148
+ * 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
124
149
  */
125
150
  ReadonlyNodeAvailabilityZoneList?: Array<string>;
126
151
  /**
127
- * Hidden节点所在的可用区,跨可用区实例必传
152
+ * Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
128
153
  */
129
154
  HiddenZone?: string;
130
155
  }
@@ -181,7 +206,7 @@ export interface DBInstancePrice {
181
206
  */
182
207
  OriginalPrice: number;
183
208
  /**
184
- * 折扣加
209
+ * 折扣价
185
210
  */
186
211
  DiscountPrice: number;
187
212
  }
@@ -1025,11 +1050,11 @@ export interface CreateDBInstanceResponse {
1025
1050
  /**
1026
1051
  * 订单ID
1027
1052
  */
1028
- DealId: string;
1053
+ DealId?: string;
1029
1054
  /**
1030
1055
  * 创建的实例ID列表
1031
1056
  */
1032
- InstanceIds: Array<string>;
1057
+ InstanceIds?: Array<string>;
1033
1058
  /**
1034
1059
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1035
1060
  */
@@ -1970,21 +1995,20 @@ export interface CreateDBInstanceHourRequest {
1970
1995
  */
1971
1996
  AvailabilityZoneList?: Array<string>;
1972
1997
  /**
1973
- * Mongos CPU 核数。
1974
- - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
1975
- - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
1998
+ * Mongos CPU 核数。购买分片集群时,必须填写。
1999
+
1976
2000
  */
1977
2001
  MongosCpu?: number;
1978
2002
  /**
1979
- * Mongos 内存大小。
1980
- - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
1981
- - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2003
+ * Mongos 内存大小。购买分片集群时,必须填写。
2004
+
2005
+
1982
2006
  */
1983
2007
  MongosMemory?: number;
1984
2008
  /**
1985
- * Mongos 数量。
1986
- - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
1987
- - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2009
+ * Mongos 数量。购买分片集群时,必须填写。
2010
+
2011
+
1988
2012
  */
1989
2013
  MongosNodeNum?: number;
1990
2014
  /**
@@ -163,15 +163,15 @@ export interface ModifyRecordsStatusResponse {
163
163
  /**
164
164
  * 私有域ID
165
165
  */
166
- ZoneId: string;
166
+ ZoneId?: string;
167
167
  /**
168
168
  * 解析记录ID列表
169
169
  */
170
- RecordIds: Array<number>;
170
+ RecordIds?: Array<number>;
171
171
  /**
172
172
  * enabled:生效,disabled:失效
173
173
  */
174
- Status: string;
174
+ Status?: string;
175
175
  /**
176
176
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
177
177
  */
@@ -556,9 +556,16 @@ export interface ModifyInstanceRequest {
556
556
  */
557
557
  RegistryId: string;
558
558
  /**
559
- * 实例的规格
559
+ * 实例的规格,
560
+ 基础版:basic
561
+ 标准版:standard
562
+ 高级版:premium
560
563
  */
561
- RegistryType: string;
564
+ RegistryType?: string;
565
+ /**
566
+ * 实例删除保护,false为关闭
567
+ */
568
+ DeletionProtection?: boolean;
562
569
  }
563
570
  /**
564
571
  * RenewInstance返回参数结构体
@@ -2906,6 +2913,10 @@ export interface CreateInstanceRequest {
2906
2913
  * 是否开启Cos桶多AZ特性
2907
2914
  */
2908
2915
  EnableCosMAZ?: boolean;
2916
+ /**
2917
+ * 是否开启实例删除保护
2918
+ */
2919
+ DeletionProtection?: boolean;
2909
2920
  }
2910
2921
  /**
2911
2922
  * DescribeInstanceToken请求参数结构体