tencentcloud-sdk-nodejs 4.0.634 → 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.
Files changed (76) hide show
  1. package/CHANGELOG.md +509 -0
  2. package/SERVICE_CHANGELOG.md +615 -53
  3. package/package.json +1 -1
  4. package/products.md +26 -26
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_models.ts +2 -2
  7. package/src/services/asr/v20190614/asr_client.ts +168 -112
  8. package/src/services/asr/v20190614/asr_models.ts +176 -3
  9. package/src/services/cfw/v20190904/cfw_models.ts +1 -1
  10. package/src/services/ciam/v20220331/ciam_models.ts +8 -0
  11. package/src/services/cls/v20201016/cls_models.ts +17 -2
  12. package/src/services/dlc/v20210125/dlc_client.ts +1 -1
  13. package/src/services/dlc/v20210125/dlc_models.ts +20 -3
  14. package/src/services/emr/v20190103/emr_client.ts +60 -21
  15. package/src/services/emr/v20190103/emr_models.ts +652 -102
  16. package/src/services/ess/v20201111/ess_models.ts +42 -7
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +2 -1
  18. package/src/services/live/v20180801/live_models.ts +18 -0
  19. package/src/services/mongodb/v20190725/mongodb_models.ts +65 -41
  20. package/src/services/postgres/v20170312/postgres_client.ts +1 -1
  21. package/src/services/postgres/v20170312/postgres_models.ts +57 -23
  22. package/src/services/privatedns/v20201028/privatedns_models.ts +4 -4
  23. package/src/services/sqlserver/v20180328/sqlserver_models.ts +12 -11
  24. package/src/services/tcr/v20190924/tcr_models.ts +13 -2
  25. package/src/services/teo/v20220901/teo_client.ts +462 -790
  26. package/src/services/teo/v20220901/teo_models.ts +533 -2272
  27. package/src/services/trp/v20210515/trp_client.ts +13 -0
  28. package/src/services/trp/v20210515/trp_models.ts +98 -3
  29. package/src/services/trtc/v20190722/trtc_models.ts +2 -2
  30. package/src/services/vpc/v20170312/vpc_client.ts +1 -1
  31. package/src/services/vpc/v20170312/vpc_models.ts +28 -16
  32. package/src/services/waf/v20180125/waf_models.ts +33 -13
  33. package/src/services/wedata/v20210820/wedata_client.ts +9 -3
  34. package/src/services/wedata/v20210820/wedata_models.ts +294 -33
  35. package/tencentcloud/common/sdk_version.d.ts +1 -1
  36. package/tencentcloud/common/sdk_version.js +1 -1
  37. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +2 -2
  38. package/tencentcloud/services/asr/v20190614/asr_client.d.ts +70 -48
  39. package/tencentcloud/services/asr/v20190614/asr_client.js +94 -64
  40. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +166 -3
  41. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1 -1
  42. package/tencentcloud/services/ciam/v20220331/ciam_models.d.ts +8 -0
  43. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +17 -2
  44. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +1 -1
  45. package/tencentcloud/services/dlc/v20210125/dlc_client.js +1 -1
  46. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +20 -3
  47. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +17 -5
  48. package/tencentcloud/services/emr/v20190103/emr_client.js +24 -6
  49. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +649 -108
  50. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +42 -7
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +2 -1
  52. package/tencentcloud/services/live/v20180801/live_models.d.ts +18 -0
  53. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +65 -41
  54. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +1 -1
  55. package/tencentcloud/services/postgres/v20170312/postgres_client.js +1 -1
  56. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +57 -23
  57. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +4 -4
  58. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +12 -11
  59. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +13 -2
  60. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +121 -223
  61. package/tencentcloud/services/teo/v20220901/teo_client.js +179 -333
  62. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +576 -2245
  63. package/tencentcloud/services/trp/v20210515/trp_client.d.ts +5 -1
  64. package/tencentcloud/services/trp/v20210515/trp_client.js +6 -0
  65. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +95 -3
  66. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +2 -2
  67. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  68. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  69. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +28 -16
  70. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +33 -13
  71. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -1
  72. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +288 -33
  73. package/test/asr.v20190614.test.js +74 -34
  74. package/test/emr.v20190103.test.js +34 -4
  75. package/test/teo.v20220901.test.js +118 -378
  76. package/test/trp.v20210515.test.js +10 -0
@@ -484,7 +484,8 @@ export interface CreateIntegrationEmployeesRequest {
484
484
  Operator: UserInfo
485
485
  /**
486
486
  * 待创建员工的信息,不超过20个。
487
- Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
487
+ 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
488
+ 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
488
489
  */
489
490
  Employees: Array<Staff>
490
491
  /**
@@ -1793,6 +1794,18 @@ REJECT: 拒绝
1793
1794
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1794
1795
  */
1795
1796
  Agent?: Agent
1797
+ /**
1798
+ * 审核签署节点使用 非必填 如果填写则审核该签署节点。给个人审核时必填。
1799
+ */
1800
+ RecipientId?: string
1801
+ /**
1802
+ * 操作类型:
1803
+ 操作类型,默认:SignReview;SignReview:签署审核
1804
+ 注:接口通过该字段区分操作类型
1805
+ 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
1806
+ 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
1807
+ */
1808
+ OperateType?: string
1796
1809
  }
1797
1810
 
1798
1811
  /**
@@ -2139,6 +2152,7 @@ export interface CreateFlowApproversRequest {
2139
2152
  export interface Staff {
2140
2153
  /**
2141
2154
  * 用户在电子签平台的id
2155
+ 注:创建和更新场景无需填写
2142
2156
  */
2143
2157
  UserId?: string
2144
2158
  /**
@@ -2161,6 +2175,7 @@ export interface Staff {
2161
2175
  OpenId?: string
2162
2176
  /**
2163
2177
  * 员工角色
2178
+ 注:创建和更新场景无需填写
2164
2179
  注意:此字段可能返回 null,表示取不到有效值。
2165
2180
  */
2166
2181
  Roles?: Array<StaffRole>
@@ -2171,30 +2186,42 @@ export interface Staff {
2171
2186
  Department?: Department
2172
2187
  /**
2173
2188
  * 员工是否实名
2189
+ 注:创建和更新场景无需填写
2174
2190
  */
2175
2191
  Verified?: boolean
2176
2192
  /**
2177
2193
  * 员工创建时间戳,单位秒
2194
+ 注:创建和更新场景无需填写
2178
2195
  */
2179
2196
  CreatedOn?: number
2180
2197
  /**
2181
2198
  * 员工实名时间戳,单位秒
2199
+ 注:创建和更新场景无需填写
2182
2200
  注意:此字段可能返回 null,表示取不到有效值。
2183
2201
  */
2184
2202
  VerifiedOn?: number
2185
2203
  /**
2186
2204
  * 员工是否离职:0-未离职,1-离职
2205
+ 注:创建和更新场景无需填写
2187
2206
  注意:此字段可能返回 null,表示取不到有效值。
2188
2207
  */
2189
2208
  QuiteJob?: number
2190
2209
  /**
2191
2210
  * 员工离职交接人用户id
2211
+ 注:创建和更新场景无需填写
2192
2212
  */
2193
2213
  ReceiveUserId?: string
2194
2214
  /**
2195
2215
  * 员工离职交接人用户OpenId
2216
+ 注:创建和更新场景无需填写
2196
2217
  */
2197
2218
  ReceiveOpenId?: string
2219
+ /**
2220
+ * 企业微信用户账号ID
2221
+ 注:仅企微类型的企业创建员工接口支持该字段
2222
+ 注意:此字段可能返回 null,表示取不到有效值。
2223
+ */
2224
+ WeworkOpenId?: string
2198
2225
  }
2199
2226
 
2200
2227
  /**
@@ -2786,20 +2813,24 @@ export interface SuccessCreateStaffData {
2786
2813
  /**
2787
2814
  * 员工名
2788
2815
  */
2789
- DisplayName: string
2816
+ DisplayName?: string
2790
2817
  /**
2791
2818
  * 员工手机号
2792
2819
  */
2793
- Mobile: string
2820
+ Mobile?: string
2794
2821
  /**
2795
2822
  * 员工在电子签平台的id
2796
2823
  */
2797
- UserId: string
2824
+ UserId?: string
2798
2825
  /**
2799
2826
  * 提示,当创建已存在未实名用户时,该字段有值
2800
2827
  注意:此字段可能返回 null,表示取不到有效值。
2801
2828
  */
2802
2829
  Note?: string
2830
+ /**
2831
+ * 传入的企微账号id
2832
+ */
2833
+ WeworkOpenId?: string
2803
2834
  }
2804
2835
 
2805
2836
  /**
@@ -3143,15 +3174,19 @@ export interface FailedCreateStaffData {
3143
3174
  /**
3144
3175
  * 员工名
3145
3176
  */
3146
- DisplayName: string
3177
+ DisplayName?: string
3147
3178
  /**
3148
3179
  * 员工手机号
3149
3180
  */
3150
- Mobile: string
3181
+ Mobile?: string
3182
+ /**
3183
+ * 传入的企微账号id
3184
+ */
3185
+ WeworkOpenId?: string
3151
3186
  /**
3152
3187
  * 失败原因
3153
3188
  */
3154
- Reason: string
3189
+ Reason?: string
3155
3190
  }
3156
3191
 
3157
3192
  /**
@@ -147,7 +147,7 @@ SIGN_REJECT:拒签(流程结束)
147
147
  */
148
148
  ReviewMessage?: string
149
149
  /**
150
- * 签署节点审核时需要指定
150
+ * 签署节点审核时需要指定,给个人审核时必填。
151
151
  */
152
152
  RecipientId?: string
153
153
  /**
@@ -155,6 +155,7 @@ SIGN_REJECT:拒签(流程结束)
155
155
  注:接口通过该字段区分操作类型
156
156
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
157
157
  若想使用发起审核,请指定该字段为:CreateReview
158
+ 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
158
159
  */
159
160
  OperateType?: string
160
161
  }
@@ -555,6 +555,11 @@ export interface DiagnoseResult {
555
555
  注意:此字段可能返回 null,表示取不到有效值。
556
556
  */
557
557
  LowFrameRateResults?: Array<string>
558
+ /**
559
+ * 流格式诊断信息
560
+ 注意:此字段可能返回 null,表示取不到有效值。
561
+ */
562
+ StreamFormatResults?: Array<string>
558
563
  }
559
564
 
560
565
  /**
@@ -2082,6 +2087,10 @@ export interface CreateLiveStreamMonitorRequest {
2082
2087
  * 是否存储监播事件到监播报告,以及是否允许查询监播报告。
2083
2088
  */
2084
2089
  AllowMonitorReport?: number
2090
+ /**
2091
+ * 是否开启格式诊断。
2092
+ */
2093
+ AiFormatDiagnose?: number
2085
2094
  }
2086
2095
 
2087
2096
  /**
@@ -5408,6 +5417,10 @@ export interface ModifyLiveStreamMonitorRequest {
5408
5417
  * 是否存储监播事件到监播报告,以及是否允许查询监播报告。
5409
5418
  */
5410
5419
  AllowMonitorReport?: number
5420
+ /**
5421
+ * 是否开启格式诊断。
5422
+ */
5423
+ AiFormatDiagnose?: number
5411
5424
  }
5412
5425
 
5413
5426
  /**
@@ -8645,6 +8658,11 @@ export interface LiveStreamMonitorInfo {
8645
8658
  注意:此字段可能返回 null,表示取不到有效值。
8646
8659
  */
8647
8660
  AllowMonitorReport?: number
8661
+ /**
8662
+ * 是否开启格式诊断
8663
+ 注意:此字段可能返回 null,表示取不到有效值。
8664
+ */
8665
+ AiFormatDiagnose?: number
8648
8666
  }
8649
8667
 
8650
8668
  /**
@@ -30,119 +30,144 @@ export interface DescribeSpecInfoRequest {
30
30
  */
31
31
  export interface CreateDBInstanceRequest {
32
32
  /**
33
- * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
33
+ * 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
34
34
  */
35
35
  NodeNum: number
36
36
  /**
37
- * 实例内存大小,单位:GB
37
+ * 实例内存大小,单位:GB
38
38
  */
39
39
  Memory: number
40
40
  /**
41
- * 实例硬盘大小,单位:GB
41
+ * 实例硬盘大小,单位:GB
42
42
  */
43
43
  Volume: number
44
44
  /**
45
- * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(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存储引擎版本
45
+ * 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
46
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
47
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
48
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
49
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
46
50
  */
47
51
  MongoVersion: string
48
52
  /**
49
- * 实例数量, 最小值1,最大值为10
53
+ * 实例数量, 最小值1,最大值为10
50
54
  */
51
55
  GoodsNum: number
52
56
  /**
53
- * 实例所属区域名称,格式如:ap-guangzhou-2。注:此参数填写的是主可用区,如果选择多可用区部署,Zone必须是AvailabilityZoneList中的一个
57
+ * 可用区信息,输入格式如:ap-guangzhou-2
58
+ - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
59
+ - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
54
60
  */
55
61
  Zone: string
56
62
  /**
57
- * 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
63
+ * 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
58
64
  */
59
65
  Period: number
60
66
  /**
61
- * 机器类型,HIO:高IO型;HIO10G:高IO万兆型;STDS5:标准型
67
+ * 机器类型。
68
+ - HIO:高IO型。
69
+ - HIO10G:高IO万兆。
62
70
  */
63
71
  MachineCode: string
64
72
  /**
65
- * 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
73
+ * 实例架构类型。
74
+ - REPLSET:副本集。
75
+ - SHARD:分片集群。
66
76
  */
67
77
  ClusterType: string
68
78
  /**
69
- * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0
79
+ * 指副本集数量。
80
+ - 创建副本集实例,该参数只能为1。
81
+ - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
70
82
  */
71
83
  ReplicateSetNum: number
72
84
  /**
73
- * 项目ID,不设置为默认项目
85
+ * 项目ID。若不设置该参数,则为默认项目。
74
86
  */
75
87
  ProjectId?: number
76
88
  /**
77
- * 私有网络 ID,如果不传则默认选择基础网络,请使用 查询私有网络列表
89
+ * 私有网络ID。如果不设置该参数,则默认选择基础网络。
78
90
  */
79
91
  VpcId?: string
80
92
  /**
81
- * 私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 查询子网列表
93
+ * 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
82
94
  */
83
95
  SubnetId?: string
84
96
  /**
85
- * 实例密码,不设置该参数则默认密码规则为 实例ID+"@"+主账户uin。举例实例id为cmgo-higv73ed,uin为100000001,则默认密码为"cmgo-higv73ed@100000001"。 自定义密码格式为8-32个字符长度,至少包含字母、数字和字符(!@#%^*()_)中的两种
97
+ * 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
86
98
  */
87
99
  Password?: string
88
100
  /**
89
- * 实例标签信息
101
+ * 实例标签信息。
90
102
  */
91
103
  Tags?: Array<TagInfo>
92
104
  /**
93
- * 自动续费标记,可选值为:0 - 不自动续费;1 - 自动续费。默认为不自动续费
105
+ * 自动续费标记。
106
+ - 0:不自动续费。默认为不自动续费。
107
+ - 1:自动续费。
94
108
  */
95
109
  AutoRenewFlag?: number
96
110
  /**
97
- * 是否自动选择代金券,可选值为:1 - 是;0 - 否; 默认为0
111
+ * 是否自动选择代金券。
112
+ - 1:是。
113
+ - 0:否。默认为0。
98
114
  */
99
115
  AutoVoucher?: number
100
116
  /**
101
- * 1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例
117
+ * 实例类型。
118
+ - 1:正式实例。
119
+ - 3:只读实例。
120
+ - 4:灾备实例。
102
121
  */
103
122
  Clone?: number
104
123
  /**
105
- * 若是只读,灾备实例或克隆实例,Father必须填写,即主实例ID
124
+ * 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
106
125
  */
107
126
  Father?: string
108
127
  /**
109
- * 安全组
128
+ * 安全组。
110
129
  */
111
130
  SecurityGroup?: Array<string>
112
131
  /**
113
- * 克隆实例回档时间。若是克隆实例,则必须填写,格式:2021-08-13 16:30:00。注:只能回档7天内的时间点
132
+ * 克隆实例回档时间。
133
+ - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
134
+ - 回档时间范围:仅能回档7天内时间点的数据。
114
135
  */
115
136
  RestoreTime?: string
116
137
  /**
117
- * 实例名称。注:名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
138
+ * 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
118
139
  */
119
140
  InstanceName?: string
120
141
  /**
121
- * 多可用区部署的节点列表,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:1、多可用区部署节点只能部署在3个不同可用区;2、为了保障跨可用区切换,不支持将集群的大多数节点部署在同一个可用区(如3节点集群不支持2个节点部署在同一个区);3、不支持4.2及以上版本;4、不支持只读灾备实例;5、不能选择基础网络
142
+ * 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
143
+ - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
144
+ - 不支持4.2及以上版本。
145
+ - 不支持只读灾备实例。
146
+ - 不能选择基础网络。
122
147
  */
123
148
  AvailabilityZoneList?: Array<string>
124
149
  /**
125
- * mongos cpu数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
150
+ * Mongos CPU 核数,购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
126
151
  */
127
152
  MongosCpu?: number
128
153
  /**
129
- * mongos 内存大小,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
154
+ * Mongos 内存大小。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
130
155
  */
131
156
  MongosMemory?: number
132
157
  /**
133
- * mongos 数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:为了保障高可用,最低需要购买3个mongos,上限为32
158
+ * Mongos 数量。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。为了保障高可用,取值范围为[3,32]。
134
159
  */
135
160
  MongosNodeNum?: number
136
161
  /**
137
- * 只读节点数量,最大不超过7个
162
+ * 只读节点数量,取值范围[0,5]。
138
163
  */
139
164
  ReadonlyNodeNum?: number
140
165
  /**
141
- * 只读节点部署可用区
166
+ * 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
142
167
  */
143
168
  ReadonlyNodeAvailabilityZoneList?: Array<string>
144
169
  /**
145
- * Hidden节点所在的可用区,跨可用区实例必传
170
+ * Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
146
171
  */
147
172
  HiddenZone?: string
148
173
  }
@@ -203,7 +228,7 @@ export interface DBInstancePrice {
203
228
  */
204
229
  OriginalPrice: number
205
230
  /**
206
- * 折扣加
231
+ * 折扣价
207
232
  */
208
233
  DiscountPrice: number
209
234
  }
@@ -1083,11 +1108,11 @@ export interface CreateDBInstanceResponse {
1083
1108
  /**
1084
1109
  * 订单ID
1085
1110
  */
1086
- DealId: string
1111
+ DealId?: string
1087
1112
  /**
1088
1113
  * 创建的实例ID列表
1089
1114
  */
1090
- InstanceIds: Array<string>
1115
+ InstanceIds?: Array<string>
1091
1116
  /**
1092
1117
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1093
1118
  */
@@ -2070,21 +2095,20 @@ export interface CreateDBInstanceHourRequest {
2070
2095
  */
2071
2096
  AvailabilityZoneList?: Array<string>
2072
2097
  /**
2073
- * Mongos CPU 核数。
2074
- - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
2075
- - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2098
+ * Mongos CPU 核数。购买分片集群时,必须填写。
2099
+
2076
2100
  */
2077
2101
  MongosCpu?: number
2078
2102
  /**
2079
- * Mongos 内存大小。
2080
- - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
2081
- - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2103
+ * Mongos 内存大小。购买分片集群时,必须填写。
2104
+
2105
+
2082
2106
  */
2083
2107
  MongosMemory?: number
2084
2108
  /**
2085
- * Mongos 数量。
2086
- - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
2087
- - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2109
+ * Mongos 数量。购买分片集群时,必须填写。
2110
+
2111
+
2088
2112
  */
2089
2113
  MongosNodeNum?: number
2090
2114
  /**
@@ -814,7 +814,7 @@ export class Client extends AbstractClient {
814
814
  }
815
815
 
816
816
  /**
817
- * 本接口(IsolateDBInstances)用于隔离实例
817
+ * 本接口(IsolateDBInstances)用于隔离实例。
818
818
  */
819
819
  async IsolateDBInstances(
820
820
  req: IsolateDBInstancesRequest,
@@ -945,11 +945,16 @@ export interface ModifyDBInstanceDeploymentRequest {
945
945
  */
946
946
  DBInstanceId: string
947
947
  /**
948
- * 实例节点信息。
948
+ * 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
949
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
949
950
  */
950
951
  DBNodeSet: Array<DBNode>
951
952
  /**
952
- * 切换时间。默认为 立即切换,入参为 0 :立即切换 。1:指定时间切换。2:维护时间窗口内切换
953
+ * 指定实例配置完成变更后的切换时间。
954
+ <li>0:立即切换
955
+ <li>1:指定时间切换
956
+ <li>2:维护时间窗口内切换
957
+ 默认值:0
953
958
  */
954
959
  SwitchTag: number
955
960
  /**
@@ -1756,7 +1761,10 @@ export interface ModifyDBInstanceSpecRequest {
1756
1761
  */
1757
1762
  Storage: number
1758
1763
  /**
1759
- * 是否自动使用代金券,1是,0否,默认不使用。
1764
+ * 是否自动使用代金券:
1765
+ <li>0:否
1766
+ <li>1:是
1767
+ 默认值:0
1760
1768
  */
1761
1769
  AutoVoucher?: number
1762
1770
  /**
@@ -1768,7 +1776,11 @@ export interface ModifyDBInstanceSpecRequest {
1768
1776
  */
1769
1777
  ActivityId?: number
1770
1778
  /**
1771
- * 指定实例配置完成变更后的切换时间,默认为 立即切换,入参为 0 :立即切换 。1:指定时间切换。2:维护时间窗口内切换。
1779
+ * 指定实例配置完成变更后的切换时间。
1780
+ <li>0:立即切换
1781
+ <li>1:指定时间切换
1782
+ <li>2:维护时间窗口内切换
1783
+ 默认值:0
1772
1784
  */
1773
1785
  SwitchTag?: number
1774
1786
  /**
@@ -2790,7 +2802,9 @@ export interface DescribeParamsEventResponse {
2790
2802
  */
2791
2803
  export interface ModifyDBInstanceSecurityGroupsRequest {
2792
2804
  /**
2793
- * 实例或只读组要绑定的安全组列表
2805
+ * 实例或只读组要绑定的安全组列表。
2806
+ 安全组信息可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来查询。
2807
+
2794
2808
  */
2795
2809
  SecurityGroupIdSet: Array<string>
2796
2810
  /**
@@ -3117,7 +3131,8 @@ export interface ModifyDBInstanceNameRequest {
3117
3131
  */
3118
3132
  DBInstanceId: string
3119
3133
  /**
3120
- * 新的数据库实例名字
3134
+ * 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。
3135
+
3121
3136
  */
3122
3137
  InstanceName: string
3123
3138
  }
@@ -4511,19 +4526,24 @@ export interface RegionInfo {
4511
4526
  */
4512
4527
  export interface DisIsolateDBInstancesRequest {
4513
4528
  /**
4514
- * 资源ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
4529
+ * 实例ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
4515
4530
  */
4516
4531
  DBInstanceIdSet: Array<string>
4517
4532
  /**
4518
- * 包年包月实例解隔离时购买时常 以月为单位
4533
+ * 购买时长,单位:月。
4534
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
4535
+ <li>后付费:只支持1
4519
4536
  */
4520
4537
  Period?: number
4521
4538
  /**
4522
- * 是否使用代金券:true-使用,false-不使用,默认不使用
4539
+ * 是否使用代金券:
4540
+ <li>true:使用
4541
+ <li>false:不使用
4542
+ 默认值:false
4523
4543
  */
4524
4544
  AutoVoucher?: boolean
4525
4545
  /**
4526
- * 代金券id列表
4546
+ * 代金券id列表。
4527
4547
  */
4528
4548
  VoucherIds?: Array<string>
4529
4549
  }
@@ -4734,19 +4754,30 @@ export interface ModifyDBInstanceChargeTypeRequest {
4734
4754
  */
4735
4755
  DBInstanceId: string
4736
4756
  /**
4737
- * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。默认值:PREPAID。
4757
+ * 实例计费类型,目前支持:
4758
+ <li>PREPAID:预付费,即包年包月
4759
+ <li>POSTPAID_BY_HOUR:后付费,即按量计费
4760
+ 默认值:PREPAID
4738
4761
  */
4739
4762
  InstanceChargeType: string
4740
4763
  /**
4741
- * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
4764
+ * 购买时长,单位:月。
4765
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
4766
+ <li>后付费:只支持1
4742
4767
  */
4743
4768
  Period: number
4744
4769
  /**
4745
- * 续费标记:0-正常续费(默认);1-自动续费。
4770
+ * 续费标记:
4771
+ <li>0:手动续费
4772
+ <li>1:自动续费
4773
+ 默认值:0
4746
4774
  */
4747
4775
  AutoRenewFlag?: number
4748
4776
  /**
4749
- * 是否自动使用代金券,1是,0否,默认不使用
4777
+ * 是否自动使用代金券:
4778
+ <li>0:否
4779
+ <li>1:是
4780
+ 默认值:0
4750
4781
  */
4751
4782
  AutoVoucher?: number
4752
4783
  }
@@ -5004,18 +5035,20 @@ export interface DescribeDBXlogsResponse {
5004
5035
  */
5005
5036
  export interface UpgradeDBInstanceKernelVersionRequest {
5006
5037
  /**
5007
- * 实例ID
5038
+ * 实例ID
5008
5039
  */
5009
5040
  DBInstanceId: string
5010
5041
  /**
5011
- * 升级的目标内核版本号。可以通过接口DescribeDBVersions的返回字段AvailableUpgradeTarget获取。
5042
+ * 升级的目标内核版本号。可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)的返回字段AvailableUpgradeTarget获取。
5043
+
5012
5044
  */
5013
5045
  TargetDBKernelVersion: string
5014
5046
  /**
5015
- * 指定实例升级内核版本号完成后的切换时间。可选值,
5016
- 0:立即切换(默认值)。
5017
- 1:指定时间切换。
5018
- 2:维护时间窗口内切换。
5047
+ * 指定实例升级内核版本号完成后的切换时间。可选值:
5048
+ <li>0:立即切换
5049
+ <li>1:指定时间切换
5050
+ <li>2:维护时间窗口内切换
5051
+ 默认值:0
5019
5052
  */
5020
5053
  SwitchTag?: number
5021
5054
  /**
@@ -5027,9 +5060,10 @@ export interface UpgradeDBInstanceKernelVersionRequest {
5027
5060
  */
5028
5061
  SwitchEndTime?: string
5029
5062
  /**
5030
- * 是否对本次升级实例内核版本号操作执行预检查。可选值,
5031
- true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
5032
- false:发送正常请求(默认值),通过检查后直接升级内核版本号。
5063
+ * 是否对本次升级实例内核版本号操作执行预检查。
5064
+ <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
5065
+ <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。
5066
+ 默认值:false
5033
5067
  */
5034
5068
  DryRun?: boolean
5035
5069
  }
@@ -190,15 +190,15 @@ export interface ModifyRecordsStatusResponse {
190
190
  /**
191
191
  * 私有域ID
192
192
  */
193
- ZoneId: string
193
+ ZoneId?: string
194
194
  /**
195
195
  * 解析记录ID列表
196
196
  */
197
- RecordIds: Array<number>
197
+ RecordIds?: Array<number>
198
198
  /**
199
199
  * enabled:生效,disabled:失效
200
200
  */
201
- Status: string
201
+ Status?: string
202
202
  /**
203
203
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
204
204
  */
@@ -665,7 +665,7 @@ export interface CreatePrivateZoneRecordResponse {
665
665
  /**
666
666
  * 记录Id
667
667
  */
668
- RecordId: string
668
+ RecordId?: string
669
669
  /**
670
670
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
671
671
  */