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
@@ -448,7 +448,8 @@ export interface CreateIntegrationEmployeesRequest {
448
448
  Operator: UserInfo;
449
449
  /**
450
450
  * 待创建员工的信息,不超过20个。
451
- Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
451
+ 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
452
+ 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
452
453
  */
453
454
  Employees: Array<Staff>;
454
455
  /**
@@ -1709,6 +1710,18 @@ export interface CreateFlowSignReviewRequest {
1709
1710
  * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1710
1711
  */
1711
1712
  Agent?: Agent;
1713
+ /**
1714
+ * 审核签署节点使用 非必填 如果填写则审核该签署节点。给个人审核时必填。
1715
+ */
1716
+ RecipientId?: string;
1717
+ /**
1718
+ * 操作类型:
1719
+ 操作类型,默认:SignReview;SignReview:签署审核
1720
+ 注:接口通过该字段区分操作类型
1721
+ 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
1722
+ 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
1723
+ */
1724
+ OperateType?: string;
1712
1725
  }
1713
1726
  /**
1714
1727
  * UnbindEmployeeUserIdWithClientOpenId请求参数结构体
@@ -2045,6 +2058,7 @@ export interface CreateFlowApproversRequest {
2045
2058
  export interface Staff {
2046
2059
  /**
2047
2060
  * 用户在电子签平台的id
2061
+ 注:创建和更新场景无需填写
2048
2062
  */
2049
2063
  UserId?: string;
2050
2064
  /**
@@ -2067,6 +2081,7 @@ export interface Staff {
2067
2081
  OpenId?: string;
2068
2082
  /**
2069
2083
  * 员工角色
2084
+ 注:创建和更新场景无需填写
2070
2085
  注意:此字段可能返回 null,表示取不到有效值。
2071
2086
  */
2072
2087
  Roles?: Array<StaffRole>;
@@ -2077,30 +2092,42 @@ export interface Staff {
2077
2092
  Department?: Department;
2078
2093
  /**
2079
2094
  * 员工是否实名
2095
+ 注:创建和更新场景无需填写
2080
2096
  */
2081
2097
  Verified?: boolean;
2082
2098
  /**
2083
2099
  * 员工创建时间戳,单位秒
2100
+ 注:创建和更新场景无需填写
2084
2101
  */
2085
2102
  CreatedOn?: number;
2086
2103
  /**
2087
2104
  * 员工实名时间戳,单位秒
2105
+ 注:创建和更新场景无需填写
2088
2106
  注意:此字段可能返回 null,表示取不到有效值。
2089
2107
  */
2090
2108
  VerifiedOn?: number;
2091
2109
  /**
2092
2110
  * 员工是否离职:0-未离职,1-离职
2111
+ 注:创建和更新场景无需填写
2093
2112
  注意:此字段可能返回 null,表示取不到有效值。
2094
2113
  */
2095
2114
  QuiteJob?: number;
2096
2115
  /**
2097
2116
  * 员工离职交接人用户id
2117
+ 注:创建和更新场景无需填写
2098
2118
  */
2099
2119
  ReceiveUserId?: string;
2100
2120
  /**
2101
2121
  * 员工离职交接人用户OpenId
2122
+ 注:创建和更新场景无需填写
2102
2123
  */
2103
2124
  ReceiveOpenId?: string;
2125
+ /**
2126
+ * 企业微信用户账号ID
2127
+ 注:仅企微类型的企业创建员工接口支持该字段
2128
+ 注意:此字段可能返回 null,表示取不到有效值。
2129
+ */
2130
+ WeworkOpenId?: string;
2104
2131
  }
2105
2132
  /**
2106
2133
  * CreateFlowEvidenceReport返回参数结构体
@@ -2668,20 +2695,24 @@ export interface SuccessCreateStaffData {
2668
2695
  /**
2669
2696
  * 员工名
2670
2697
  */
2671
- DisplayName: string;
2698
+ DisplayName?: string;
2672
2699
  /**
2673
2700
  * 员工手机号
2674
2701
  */
2675
- Mobile: string;
2702
+ Mobile?: string;
2676
2703
  /**
2677
2704
  * 员工在电子签平台的id
2678
2705
  */
2679
- UserId: string;
2706
+ UserId?: string;
2680
2707
  /**
2681
2708
  * 提示,当创建已存在未实名用户时,该字段有值
2682
2709
  注意:此字段可能返回 null,表示取不到有效值。
2683
2710
  */
2684
2711
  Note?: string;
2712
+ /**
2713
+ * 传入的企微账号id
2714
+ */
2715
+ WeworkOpenId?: string;
2685
2716
  }
2686
2717
  /**
2687
2718
  * 签署参与者信息
@@ -3012,15 +3043,19 @@ export interface FailedCreateStaffData {
3012
3043
  /**
3013
3044
  * 员工名
3014
3045
  */
3015
- DisplayName: string;
3046
+ DisplayName?: string;
3016
3047
  /**
3017
3048
  * 员工手机号
3018
3049
  */
3019
- Mobile: string;
3050
+ Mobile?: string;
3051
+ /**
3052
+ * 传入的企微账号id
3053
+ */
3054
+ WeworkOpenId?: string;
3020
3055
  /**
3021
3056
  * 失败原因
3022
3057
  */
3023
- Reason: string;
3058
+ Reason?: string;
3024
3059
  }
3025
3060
  /**
3026
3061
  * 指定签署人限制项
@@ -123,7 +123,7 @@ export interface ChannelCreateFlowSignReviewRequest {
123
123
  */
124
124
  ReviewMessage?: string;
125
125
  /**
126
- * 签署节点审核时需要指定
126
+ * 签署节点审核时需要指定,给个人审核时必填。
127
127
  */
128
128
  RecipientId?: string;
129
129
  /**
@@ -131,6 +131,7 @@ export interface ChannelCreateFlowSignReviewRequest {
131
131
  注:接口通过该字段区分操作类型
132
132
  该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
133
133
  若想使用发起审核,请指定该字段为:CreateReview
134
+ 若发起个人审核,则指定该字段为:SignReview(注意,给个人审核时,需联系客户经理开白使用)
134
135
  */
135
136
  OperateType?: string;
136
137
  }
@@ -517,6 +517,11 @@ export interface DiagnoseResult {
517
517
  注意:此字段可能返回 null,表示取不到有效值。
518
518
  */
519
519
  LowFrameRateResults?: Array<string>;
520
+ /**
521
+ * 流格式诊断信息
522
+ 注意:此字段可能返回 null,表示取不到有效值。
523
+ */
524
+ StreamFormatResults?: Array<string>;
520
525
  }
521
526
  /**
522
527
  * StopRecordTask请求参数结构体
@@ -1982,6 +1987,10 @@ export interface CreateLiveStreamMonitorRequest {
1982
1987
  * 是否存储监播事件到监播报告,以及是否允许查询监播报告。
1983
1988
  */
1984
1989
  AllowMonitorReport?: number;
1990
+ /**
1991
+ * 是否开启格式诊断。
1992
+ */
1993
+ AiFormatDiagnose?: number;
1985
1994
  }
1986
1995
  /**
1987
1996
  * DescribeScreenShotSheetNumList请求参数结构体
@@ -5177,6 +5186,10 @@ export interface ModifyLiveStreamMonitorRequest {
5177
5186
  * 是否存储监播事件到监播报告,以及是否允许查询监播报告。
5178
5187
  */
5179
5188
  AllowMonitorReport?: number;
5189
+ /**
5190
+ * 是否开启格式诊断。
5191
+ */
5192
+ AiFormatDiagnose?: number;
5180
5193
  }
5181
5194
  /**
5182
5195
  * ModifyLiveSnapshotTemplate返回参数结构体
@@ -8281,6 +8294,11 @@ export interface LiveStreamMonitorInfo {
8281
8294
  注意:此字段可能返回 null,表示取不到有效值。
8282
8295
  */
8283
8296
  AllowMonitorReport?: number;
8297
+ /**
8298
+ * 是否开启格式诊断
8299
+ 注意:此字段可能返回 null,表示取不到有效值。
8300
+ */
8301
+ AiFormatDiagnose?: number;
8284
8302
  }
8285
8303
  /**
8286
8304
  * 直播拉流当前正在拉的文件信息。
@@ -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
  /**
@@ -236,7 +236,7 @@ export declare class Client extends AbstractClient {
236
236
  */
237
237
  DeleteLogBackup(req: DeleteLogBackupRequest, cb?: (error: string, rep: DeleteLogBackupResponse) => void): Promise<DeleteLogBackupResponse>;
238
238
  /**
239
- * 本接口(IsolateDBInstances)用于隔离实例
239
+ * 本接口(IsolateDBInstances)用于隔离实例。
240
240
  */
241
241
  IsolateDBInstances(req: IsolateDBInstancesRequest, cb?: (error: string, rep: IsolateDBInstancesResponse) => void): Promise<IsolateDBInstancesResponse>;
242
242
  /**
@@ -370,7 +370,7 @@ class Client extends abstract_client_1.AbstractClient {
370
370
  return this.request("DeleteLogBackup", req, cb);
371
371
  }
372
372
  /**
373
- * 本接口(IsolateDBInstances)用于隔离实例
373
+ * 本接口(IsolateDBInstances)用于隔离实例。
374
374
  */
375
375
  async IsolateDBInstances(req, cb) {
376
376
  return this.request("IsolateDBInstances", req, cb);
@@ -892,11 +892,16 @@ export interface ModifyDBInstanceDeploymentRequest {
892
892
  */
893
893
  DBInstanceId: string;
894
894
  /**
895
- * 实例节点信息。
895
+ * 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
896
+ 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
896
897
  */
897
898
  DBNodeSet: Array<DBNode>;
898
899
  /**
899
- * 切换时间。默认为 立即切换,入参为 0 :立即切换 。1:指定时间切换。2:维护时间窗口内切换
900
+ * 指定实例配置完成变更后的切换时间。
901
+ <li>0:立即切换
902
+ <li>1:指定时间切换
903
+ <li>2:维护时间窗口内切换
904
+ 默认值:0
900
905
  */
901
906
  SwitchTag: number;
902
907
  /**
@@ -1670,7 +1675,10 @@ export interface ModifyDBInstanceSpecRequest {
1670
1675
  */
1671
1676
  Storage: number;
1672
1677
  /**
1673
- * 是否自动使用代金券,1是,0否,默认不使用。
1678
+ * 是否自动使用代金券:
1679
+ <li>0:否
1680
+ <li>1:是
1681
+ 默认值:0
1674
1682
  */
1675
1683
  AutoVoucher?: number;
1676
1684
  /**
@@ -1682,7 +1690,11 @@ export interface ModifyDBInstanceSpecRequest {
1682
1690
  */
1683
1691
  ActivityId?: number;
1684
1692
  /**
1685
- * 指定实例配置完成变更后的切换时间,默认为 立即切换,入参为 0 :立即切换 。1:指定时间切换。2:维护时间窗口内切换。
1693
+ * 指定实例配置完成变更后的切换时间。
1694
+ <li>0:立即切换
1695
+ <li>1:指定时间切换
1696
+ <li>2:维护时间窗口内切换
1697
+ 默认值:0
1686
1698
  */
1687
1699
  SwitchTag?: number;
1688
1700
  /**
@@ -2668,7 +2680,9 @@ export interface DescribeParamsEventResponse {
2668
2680
  */
2669
2681
  export interface ModifyDBInstanceSecurityGroupsRequest {
2670
2682
  /**
2671
- * 实例或只读组要绑定的安全组列表
2683
+ * 实例或只读组要绑定的安全组列表。
2684
+ 安全组信息可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来查询。
2685
+
2672
2686
  */
2673
2687
  SecurityGroupIdSet: Array<string>;
2674
2688
  /**
@@ -2981,7 +2995,8 @@ export interface ModifyDBInstanceNameRequest {
2981
2995
  */
2982
2996
  DBInstanceId: string;
2983
2997
  /**
2984
- * 新的数据库实例名字
2998
+ * 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。
2999
+
2985
3000
  */
2986
3001
  InstanceName: string;
2987
3002
  }
@@ -4313,19 +4328,24 @@ export interface RegionInfo {
4313
4328
  */
4314
4329
  export interface DisIsolateDBInstancesRequest {
4315
4330
  /**
4316
- * 资源ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
4331
+ * 实例ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
4317
4332
  */
4318
4333
  DBInstanceIdSet: Array<string>;
4319
4334
  /**
4320
- * 包年包月实例解隔离时购买时常 以月为单位
4335
+ * 购买时长,单位:月。
4336
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
4337
+ <li>后付费:只支持1
4321
4338
  */
4322
4339
  Period?: number;
4323
4340
  /**
4324
- * 是否使用代金券:true-使用,false-不使用,默认不使用
4341
+ * 是否使用代金券:
4342
+ <li>true:使用
4343
+ <li>false:不使用
4344
+ 默认值:false
4325
4345
  */
4326
4346
  AutoVoucher?: boolean;
4327
4347
  /**
4328
- * 代金券id列表
4348
+ * 代金券id列表。
4329
4349
  */
4330
4350
  VoucherIds?: Array<string>;
4331
4351
  }
@@ -4523,19 +4543,30 @@ export interface ModifyDBInstanceChargeTypeRequest {
4523
4543
  */
4524
4544
  DBInstanceId: string;
4525
4545
  /**
4526
- * 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。默认值:PREPAID。
4546
+ * 实例计费类型,目前支持:
4547
+ <li>PREPAID:预付费,即包年包月
4548
+ <li>POSTPAID_BY_HOUR:后付费,即按量计费
4549
+ 默认值:PREPAID
4527
4550
  */
4528
4551
  InstanceChargeType: string;
4529
4552
  /**
4530
- * 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。
4553
+ * 购买时长,单位:月。
4554
+ <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
4555
+ <li>后付费:只支持1
4531
4556
  */
4532
4557
  Period: number;
4533
4558
  /**
4534
- * 续费标记:0-正常续费(默认);1-自动续费。
4559
+ * 续费标记:
4560
+ <li>0:手动续费
4561
+ <li>1:自动续费
4562
+ 默认值:0
4535
4563
  */
4536
4564
  AutoRenewFlag?: number;
4537
4565
  /**
4538
- * 是否自动使用代金券,1是,0否,默认不使用
4566
+ * 是否自动使用代金券:
4567
+ <li>0:否
4568
+ <li>1:是
4569
+ 默认值:0
4539
4570
  */
4540
4571
  AutoVoucher?: number;
4541
4572
  }
@@ -4779,18 +4810,20 @@ export interface DescribeDBXlogsResponse {
4779
4810
  */
4780
4811
  export interface UpgradeDBInstanceKernelVersionRequest {
4781
4812
  /**
4782
- * 实例ID
4813
+ * 实例ID
4783
4814
  */
4784
4815
  DBInstanceId: string;
4785
4816
  /**
4786
- * 升级的目标内核版本号。可以通过接口DescribeDBVersions的返回字段AvailableUpgradeTarget获取。
4817
+ * 升级的目标内核版本号。可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)的返回字段AvailableUpgradeTarget获取。
4818
+
4787
4819
  */
4788
4820
  TargetDBKernelVersion: string;
4789
4821
  /**
4790
- * 指定实例升级内核版本号完成后的切换时间。可选值,
4791
- 0:立即切换(默认值)。
4792
- 1:指定时间切换。
4793
- 2:维护时间窗口内切换。
4822
+ * 指定实例升级内核版本号完成后的切换时间。可选值:
4823
+ <li>0:立即切换
4824
+ <li>1:指定时间切换
4825
+ <li>2:维护时间窗口内切换
4826
+ 默认值:0
4794
4827
  */
4795
4828
  SwitchTag?: number;
4796
4829
  /**
@@ -4802,9 +4835,10 @@ export interface UpgradeDBInstanceKernelVersionRequest {
4802
4835
  */
4803
4836
  SwitchEndTime?: string;
4804
4837
  /**
4805
- * 是否对本次升级实例内核版本号操作执行预检查。可选值,
4806
- true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
4807
- false:发送正常请求(默认值),通过检查后直接升级内核版本号。
4838
+ * 是否对本次升级实例内核版本号操作执行预检查。
4839
+ <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
4840
+ <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。
4841
+ 默认值:false
4808
4842
  */
4809
4843
  DryRun?: boolean;
4810
4844
  }
@@ -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
  */
@@ -613,7 +613,7 @@ export interface CreatePrivateZoneRecordResponse {
613
613
  /**
614
614
  * 记录Id
615
615
  */
616
- RecordId: string;
616
+ RecordId?: string;
617
617
  /**
618
618
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
619
619
  */