tencentcloud-sdk-nodejs 4.1.49 → 4.1.50

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.
@@ -1 +1 @@
1
- export const sdkVersion = "4.1.49";
1
+ export const sdkVersion = "4.1.50";
@@ -3,6 +3,9 @@ export class Client extends AbstractClient {
3
3
  constructor(clientConfig) {
4
4
  super("mqtt.tencentcloudapi.com", "2024-05-16", clientConfig);
5
5
  }
6
+ async PublishMessage(req, cb) {
7
+ return this.request("PublishMessage", req, cb);
8
+ }
6
9
  async DescribeUserList(req, cb) {
7
10
  return this.request("DescribeUserList", req, cb);
8
11
  }
@@ -33,8 +36,8 @@ export class Client extends AbstractClient {
33
36
  async DeleteInstance(req, cb) {
34
37
  return this.request("DeleteInstance", req, cb);
35
38
  }
36
- async PublishMessage(req, cb) {
37
- return this.request("PublishMessage", req, cb);
39
+ async DescribeMessageByTopic(req, cb) {
40
+ return this.request("DescribeMessageByTopic", req, cb);
38
41
  }
39
42
  async ModifyJWTAuthenticator(req, cb) {
40
43
  return this.request("ModifyJWTAuthenticator", req, cb);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs",
3
- "version": "4.1.49",
3
+ "version": "4.1.50",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.1.49";
1
+ export declare const sdkVersion = "4.1.50";
@@ -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.1.49";
4
+ exports.sdkVersion = "4.1.50";
@@ -2386,7 +2386,7 @@ export interface DataDisk {
2386
2386
  */
2387
2387
  DiskType?: string;
2388
2388
  /**
2389
- * 数据盘大小,单位:GB。不同数据盘类型取值范围不同,具体限制详见:[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0,表示不购买数据盘。更多限制详见产品文档。
2389
+ * 数据盘大小,单位:GB。不同数据盘类型取值范围不同,具体限制详见:[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0,表示不购买数据盘。更多限制详见[产品文档](https://cloud.tencent.com/document/product/362/5145)。
2390
2390
  */
2391
2391
  DiskSize?: number;
2392
2392
  /**
@@ -57,7 +57,7 @@ export declare class Client extends AbstractClient {
57
57
  */
58
58
  DescribeCfsServiceStatus(req?: DescribeCfsServiceStatusRequest, cb?: (error: string, rep: DescribeCfsServiceStatusResponse) => void): Promise<DescribeCfsServiceStatusResponse>;
59
59
  /**
60
- * 用于终止迁移任务。
60
+ * 用于终止迁移任务,非运行中状态不支持终止。
61
61
  此接口需提交工单,开启白名单之后才能使用。
62
62
  */
63
63
  StopMigrationTask(req: StopMigrationTaskRequest, cb?: (error: string, rep: StopMigrationTaskResponse) => void): Promise<StopMigrationTaskResponse>;
@@ -112,7 +112,7 @@ export declare class Client extends AbstractClient {
112
112
  */
113
113
  DescribeUserQuota(req: DescribeUserQuotaRequest, cb?: (error: string, rep: DescribeUserQuotaResponse) => void): Promise<DescribeUserQuotaResponse>;
114
114
  /**
115
- * 用来设置文件系统扩容策略,,该接口只支持turbo文件系统
115
+ * 用来设置文件系统扩容策略,该接口只支持turbo文件系统
116
116
  */
117
117
  ModifyFileSystemAutoScaleUpRule(req: ModifyFileSystemAutoScaleUpRuleRequest, cb?: (error: string, rep: ModifyFileSystemAutoScaleUpRuleResponse) => void): Promise<ModifyFileSystemAutoScaleUpRuleResponse>;
118
118
  /**
@@ -101,7 +101,7 @@ class Client extends abstract_client_1.AbstractClient {
101
101
  return this.request("DescribeCfsServiceStatus", req, cb);
102
102
  }
103
103
  /**
104
- * 用于终止迁移任务。
104
+ * 用于终止迁移任务,非运行中状态不支持终止。
105
105
  此接口需提交工单,开启白名单之后才能使用。
106
106
  */
107
107
  async StopMigrationTask(req, cb) {
@@ -182,7 +182,7 @@ class Client extends abstract_client_1.AbstractClient {
182
182
  return this.request("DescribeUserQuota", req, cb);
183
183
  }
184
184
  /**
185
- * 用来设置文件系统扩容策略,,该接口只支持turbo文件系统
185
+ * 用来设置文件系统扩容策略,该接口只支持turbo文件系统
186
186
  */
187
187
  async ModifyFileSystemAutoScaleUpRule(req, cb) {
188
188
  return this.request("ModifyFileSystemAutoScaleUpRule", req, cb);
@@ -136,15 +136,15 @@ export interface DescribeMountTargetsResponse {
136
136
  */
137
137
  export interface DescribeSnapshotOperationLogsRequest {
138
138
  /**
139
- * 文件系统快照ID,通过快照创建接口获得
139
+ * 快照ID,可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
140
140
  */
141
141
  SnapshotId: string;
142
142
  /**
143
- * 起始时间
143
+ * 起始时间,格式“YYYY-MM-DD hh:mm:ss”
144
144
  */
145
145
  StartTime: string;
146
146
  /**
147
- * 结束时间
147
+ * 结束时间,格式“YYYY-MM-DD hh:mm:ss”
148
148
  */
149
149
  EndTime: string;
150
150
  }
@@ -274,7 +274,7 @@ export interface FileSystemClient {
274
274
  */
275
275
  VpcId?: string;
276
276
  /**
277
- * 可用区名称,例如ap-beijing-1,请参考 概览文档中的地域与可用区列表
277
+ * 可用区名称,例如ap-beijing-1,参考[简介](https://cloud.tencent.com/document/api/582/38144)文档中的地域与可用区列表
278
278
  */
279
279
  Zone?: string;
280
280
  /**
@@ -480,7 +480,7 @@ export interface BindAutoSnapshotPolicyRequest {
480
480
  */
481
481
  export interface ModifyFileSystemAutoScaleUpRuleRequest {
482
482
  /**
483
- * 文件系统id,通过查询文件系统列表获取该参数
483
+ * 文件系统ID,通过查询文件系统列表获取;[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
484
484
  */
485
485
  FileSystemId: string;
486
486
  /**
@@ -527,7 +527,7 @@ export interface CreateCfsPGroupRequest {
527
527
  */
528
528
  export interface DescribeMigrationTasksResponse {
529
529
  /**
530
- * 迁移任务的数量
530
+ * 迁移任务的总数量
531
531
  */
532
532
  TotalCount?: number;
533
533
  /**
@@ -577,7 +577,7 @@ export declare type DescribeAvailableZoneInfoRequest = null;
577
577
  */
578
578
  export interface DescribeMountTargetsRequest {
579
579
  /**
580
- * 文件系统 ID,查询文件系统列表可以获得id
580
+ * 文件系统 ID,[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)可以获得id
581
581
  */
582
582
  FileSystemId: string;
583
583
  }
@@ -687,7 +687,7 @@ export interface AutoSnapshotPolicyInfo {
687
687
  */
688
688
  export interface DescribeCfsRulesRequest {
689
689
  /**
690
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
690
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
691
691
  */
692
692
  PGroupId: string;
693
693
  }
@@ -696,11 +696,11 @@ export interface DescribeCfsRulesRequest {
696
696
  */
697
697
  export interface UpdateCfsFileSystemNameRequest {
698
698
  /**
699
- * 文件系统 ID
699
+ * 文件系统 ID,通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取
700
700
  */
701
701
  FileSystemId: string;
702
702
  /**
703
- * 用户自定义文件系统名称
703
+ * 用户自定义文件系统名称,64字节内的中文字母数字或者 _,-,与CreationToken 至少填一个
704
704
  */
705
705
  FsName?: string;
706
706
  }
@@ -709,7 +709,7 @@ export interface UpdateCfsFileSystemNameRequest {
709
709
  */
710
710
  export interface DeleteCfsPGroupRequest {
711
711
  /**
712
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
712
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
713
713
  */
714
714
  PGroupId: string;
715
715
  }
@@ -772,7 +772,7 @@ export interface SnapshotOperateLog {
772
772
  */
773
773
  export interface DeleteAutoSnapshotPolicyRequest {
774
774
  /**
775
- * 快照策略ID,查询快照策略接口获取
775
+ * 快照策略ID,查询快照策略接口获取,[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208)
776
776
  */
777
777
  AutoSnapshotPolicyId: string;
778
778
  }
@@ -790,11 +790,11 @@ export interface DeleteCfsFileSystemResponse {
790
790
  */
791
791
  export interface UpdateCfsRuleRequest {
792
792
  /**
793
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
793
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
794
794
  */
795
795
  PGroupId: string;
796
796
  /**
797
- * 规则 ID,通过查询权限组规则接口获取
797
+ * 规则 ID,可通过[DescribeCfsRules](https://cloud.tencent.com/document/api/582/38156)接口获取
798
798
  */
799
799
  RuleId: string;
800
800
  /**
@@ -824,7 +824,7 @@ export interface UpdateCfsRuleRequest {
824
824
  */
825
825
  export interface DeleteUserQuotaRequest {
826
826
  /**
827
- * 文件系统 ID,通过查询文件系统接口获取
827
+ * 文件系统ID,通过查询文件系统列表获取;[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
828
828
  */
829
829
  FileSystemId: string;
830
830
  /**
@@ -897,11 +897,11 @@ export interface DeleteMountTargetResponse {
897
897
  */
898
898
  export interface CreateCfsSnapshotRequest {
899
899
  /**
900
- * 文件系统 ID,通过查询文件系统接口获取
900
+ * 文件系统ID,通过查询文件系统列表获取;[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
901
901
  */
902
902
  FileSystemId: string;
903
903
  /**
904
- * 快照名称,不超过64字符
904
+ * 快照名称,支持不超过64字符长度,支持中文、数字、_、-
905
905
  */
906
906
  SnapshotName?: string;
907
907
  /**
@@ -932,11 +932,11 @@ export interface DescribeBucketListRequest {
932
932
  */
933
933
  export interface DeleteCfsRuleRequest {
934
934
  /**
935
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
935
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
936
936
  */
937
937
  PGroupId: string;
938
938
  /**
939
- * 规则 ID,通过查询权限组规则接口获取
939
+ * 规则 ID,可通过[DescribeCfsRules](https://cloud.tencent.com/document/api/582/38156)接口获取
940
940
  */
941
941
  RuleId: string;
942
942
  }
@@ -1013,7 +1013,7 @@ export interface DescribeSnapshotOperationLogsResponse {
1013
1013
  */
1014
1014
  export interface DeleteCfsFileSystemRequest {
1015
1015
  /**
1016
- * 文件系统 ID。说明,进行删除文件系统操作前需要先调用 DeleteMountTarget 接口删除该文件系统的挂载点,否则会删除失败。
1016
+ * 文件系统 ID,通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取。说明,进行删除文件系统操作前需要先调用 DeleteMountTarget 接口删除该文件系统的挂载点,否则会删除失败。
1017
1017
  */
1018
1018
  FileSystemId: string;
1019
1019
  }
@@ -1022,7 +1022,7 @@ export interface DeleteCfsFileSystemRequest {
1022
1022
  */
1023
1023
  export interface UpdateFileSystemBandwidthLimitRequest {
1024
1024
  /**
1025
- * 文件系统 ID,通过查询文件系统列表获取
1025
+ * 文件系统 ID,可通过[DescribeCfsFileSystems](https://cloud.tencent.com/document/api/582/38170)接口获取
1026
1026
  */
1027
1027
  FileSystemId: string;
1028
1028
  /**
@@ -1099,7 +1099,7 @@ export interface PGroup {
1099
1099
  */
1100
1100
  export interface SetUserQuotaRequest {
1101
1101
  /**
1102
- * 文件系统 ID,通过查询文件系统列表获取
1102
+ * 文件系统 ID,通过[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)获取
1103
1103
  */
1104
1104
  FileSystemId: string;
1105
1105
  /**
@@ -1251,7 +1251,7 @@ export interface DeleteMountTargetRequest {
1251
1251
  */
1252
1252
  export interface CreateCfsRuleRequest {
1253
1253
  /**
1254
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
1254
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
1255
1255
  */
1256
1256
  PGroupId: string;
1257
1257
  /**
@@ -1267,7 +1267,7 @@ export interface CreateCfsRuleRequest {
1267
1267
  */
1268
1268
  RWPermission?: string;
1269
1269
  /**
1270
- * 用户权限,值为 all_squash、no_all_squash、root_squash、no_root_squash
1270
+ * 用户权限,值为 all_squash、no_all_squash、root_squash、no_root_squash。默认值为root_squash
1271
1271
  all_squash:所有访问用户(含 root 用户)都会被映射为匿名用户或用户组。
1272
1272
  no_all_squash:所有访问用户(含 root 用户)均保持原有的 UID/GID 信息。
1273
1273
  root_squash:将来访的 root 用户映射为匿名用户或用户组,非 root 用户保持原有的 UID/GID 信息。
@@ -1304,7 +1304,7 @@ export interface CreateAccessCertRequest {
1304
1304
  */
1305
1305
  export interface DescribeUserQuotaRequest {
1306
1306
  /**
1307
- * 文件系统 ID,通过查询文件系统列表获取
1307
+ * 文件系统 ID,通过[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)获取
1308
1308
  */
1309
1309
  FileSystemId: string;
1310
1310
  /**
@@ -1395,11 +1395,12 @@ export interface AutoScaleUpRule {
1395
1395
  */
1396
1396
  export interface DeleteCfsSnapshotRequest {
1397
1397
  /**
1398
- * 文件系统快照id,可通过查询快照列表接口获取
1398
+ * 快照ID,可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
1399
1399
  */
1400
1400
  SnapshotId?: string;
1401
1401
  /**
1402
1402
  * 需要删除的文件系统快照ID 列表,快照ID,跟ID列表至少填一项
1403
+ 快照ID,可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
1403
1404
  */
1404
1405
  SnapshotIds?: Array<string>;
1405
1406
  }
@@ -1408,7 +1409,7 @@ export interface DeleteCfsSnapshotRequest {
1408
1409
  */
1409
1410
  export interface DescribeCfsFileSystemClientsRequest {
1410
1411
  /**
1411
- * 文件系统 ID,通过查询文件系统接口获取
1412
+ * 文件系统 ID,通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取
1412
1413
  */
1413
1414
  FileSystemId: string;
1414
1415
  /**
@@ -1610,21 +1611,7 @@ export interface DescribeMigrationTasksRequest {
1610
1611
  */
1611
1612
  Limit?: number;
1612
1613
  /**
1613
- * <br><li> taskId
1614
-
1615
- 按照【迁移任务id】进行过滤。
1616
- 类型:String
1617
-
1618
- 必选:否
1619
-
1620
- <br><li> taskName
1621
-
1622
- 按照【迁移任务名字】进行模糊搜索过滤。
1623
- 类型:String
1624
-
1625
- 必选:否
1626
-
1627
- 每次请求的Filters的上限为10,Filter.Values的上限为100。
1614
+ * <br><li> taskId按照【迁移任务id】进行过滤。类型:String必选:否<br></li><br><li> taskName按照【迁移任务名字】进行模糊搜索过滤。类型:String必选:否每次请求的Filters的上限为10,Filter.Values的上限为100。</li>
1628
1615
  */
1629
1616
  Filters?: Array<Filter>;
1630
1617
  }
@@ -1646,11 +1633,11 @@ export interface Filter {
1646
1633
  */
1647
1634
  export interface UnbindAutoSnapshotPolicyRequest {
1648
1635
  /**
1649
- * 需要解绑的文件系统ID列表,用"," 分割,文件系统id 通创建文件系统接口获得
1636
+ * 需要解绑的文件系统ID列表,用"," 分割,文件系统ID,通过查询文件系统列表获取;[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)
1650
1637
  */
1651
1638
  FileSystemIds: string;
1652
1639
  /**
1653
- * 解绑的快照ID,通过创建快照策略接口获得
1640
+ * 解绑的快照策略ID,可以通过[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208) 查询获取
1654
1641
  */
1655
1642
  AutoSnapshotPolicyId: string;
1656
1643
  }
@@ -1742,7 +1729,7 @@ export interface DescribeCfsSnapshotsRequest {
1742
1729
  */
1743
1730
  Filters?: Array<Filter>;
1744
1731
  /**
1745
- * 按创建时间排序取值CreationTime
1732
+ * 按创建时间排序取值
1746
1733
  */
1747
1734
  OrderField?: string;
1748
1735
  /**
@@ -1764,7 +1751,7 @@ export interface UpdateCfsFileSystemSizeLimitResponse {
1764
1751
  */
1765
1752
  export interface UpdateAutoSnapshotPolicyRequest {
1766
1753
  /**
1767
- * 快照策略ID,查询快照策略列表获取
1754
+ * 解绑的快照策略ID,可以通过[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208) 查询获取
1768
1755
  */
1769
1756
  AutoSnapshotPolicyId: string;
1770
1757
  /**
@@ -2012,11 +1999,11 @@ export interface MountInfo {
2012
1999
  */
2013
2000
  export interface UpdateCfsFileSystemPGroupRequest {
2014
2001
  /**
2015
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
2002
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
2016
2003
  */
2017
2004
  PGroupId: string;
2018
2005
  /**
2019
- * 文件系统 ID,通过查询文件系统接口获取
2006
+ * 文件系统 ID,通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取
2020
2007
  */
2021
2008
  FileSystemId: string;
2022
2009
  }
@@ -2081,7 +2068,7 @@ export interface UpdateCfsSnapshotAttributeResponse {
2081
2068
  */
2082
2069
  export interface UpdateCfsPGroupRequest {
2083
2070
  /**
2084
- * 权限组 ID,通过创建权限组接口或者创建权限组规则接口获取
2071
+ * 权限组 ID,可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取
2085
2072
  */
2086
2073
  PGroupId: string;
2087
2074
  /**
@@ -2158,11 +2145,11 @@ export interface DeleteCfsPGroupResponse {
2158
2145
  */
2159
2146
  export interface UpdateCfsSnapshotAttributeRequest {
2160
2147
  /**
2161
- * 文件系统快照ID,查询文件系统快照列表获取
2148
+ * 快照ID,可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取
2162
2149
  */
2163
2150
  SnapshotId: string;
2164
2151
  /**
2165
- * 文件系统快照名称,与AliveDays 必须填一个
2152
+ * 文件系统快照名称,与AliveDays 必须填一个,快照名称,支持不超过64字符长度,支持中文、数字、_、-
2166
2153
  */
2167
2154
  SnapshotName?: string;
2168
2155
  /**
@@ -5945,14 +5945,14 @@ export interface DescribeClusterPasswordComplexityRequest {
5945
5945
  * 查询过滤器
5946
5946
  */
5947
5947
  export interface QueryFilter {
5948
- /**
5949
- * 搜索字段,目前支持:"InstanceId", "ProjectId", "InstanceName", "Vip"
5950
- */
5951
- Names: Array<string>;
5952
5948
  /**
5953
5949
  * 搜索字符串
5954
5950
  */
5955
5951
  Values: Array<string>;
5952
+ /**
5953
+ * 搜索字段,目前支持:"InstanceId", "ProjectId", "InstanceName", "Vip"
5954
+ */
5955
+ Names: Array<string>;
5956
5956
  /**
5957
5957
  * 是否精确匹配
5958
5958
  */
@@ -9012,7 +9012,7 @@ export interface DescribeTasksRequest {
9012
9012
  */
9013
9013
  StartTimeEnd?: string;
9014
9014
  /**
9015
- * 过滤条件
9015
+ * 过滤条件,支持的搜索字段:"ClusterId"、"ClusterName"、"InstanceId"、"InstanceName"、"Status"、"TaskId"、"TaskType"
9016
9016
  */
9017
9017
  Filters?: Array<QueryFilter>;
9018
9018
  /**
@@ -8737,6 +8737,7 @@ export interface Component {
8737
8737
  <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
8738
8738
  <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
8739
8739
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
8740
+ <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
8740
8741
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
8741
8742
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
8742
8743
  <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
@@ -8747,6 +8748,7 @@ export interface Component {
8747
8748
  * 个人方
8748
8749
  <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
8749
8750
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
8751
+ <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;</li>
8750
8752
  <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
8751
8753
  <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
8752
8754
  <li> <b>SIGN_SELECTOR</b> : 选择器,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作审批意见的选择</li>
@@ -8861,7 +8863,7 @@ export interface Component {
8861
8863
  <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
8862
8864
  <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
8863
8865
 
8864
- <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式
8866
+ <font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以通过**ComponentTypeLimit**参数控制签名方式
8865
8867
  <ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
8866
8868
  <li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
8867
8869
  <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
@@ -88,6 +88,7 @@ export interface Component {
88
88
  <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
89
89
  <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
90
90
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
91
+ <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
91
92
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
92
93
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
93
94
  <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
@@ -99,6 +100,7 @@ export interface Component {
99
100
  * 个人方
100
101
  <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
101
102
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
103
+ <li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件;</li>
102
104
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
103
105
  <li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件(SIGN_SIGNATURE,SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR),本身不填充任何文字内容</li>
104
106
  <li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本,<font color="red">仅可用在签批控件内部作为组合控件,单独无法使用</font>,常用作批注附言</li>
@@ -186,7 +188,7 @@ export interface Component {
186
188
  <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
187
189
  <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
188
190
 
189
- <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
191
+ <font color="red">ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
190
192
  <ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>
191
193
  <li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名, 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>
192
194
  <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
@@ -2074,7 +2074,7 @@ export interface CreateStudioProductRequest {
2074
2074
  */
2075
2075
  ProductType: number;
2076
2076
  /**
2077
- * 加密类型 ,1表示证书认证,2表示秘钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式
2077
+ * 加密类型 ,1表示证书认证,2表示密钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式
2078
2078
  */
2079
2079
  EncryptionType: string;
2080
2080
  /**
@@ -1,12 +1,16 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { UpdateAuthorizationPolicyPriorityResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, DescribeMessageListRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DescribeSharedSubscriptionLagResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DeleteAuthenticatorRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, RegisterCaCertificateResponse, DeleteInstanceRequest, ModifyInstanceRequest, RegisterDeviceCertificateResponse, DescribeClientListResponse, DescribeMessageListResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyInstanceResponse, CreateHttpAuthenticatorResponse, ModifyInsPublicEndpointResponse, ModifyJWKSAuthenticatorResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeInsPublicEndpointsRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, ModifyHttpAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DescribeUserListResponse, ModifyTopicResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, DescribeClientListRequest, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, CreateTopicResponse, RevokedDeviceCertificateRequest, CreateAuthorizationPolicyResponse, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateInstanceRequest, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, DescribeDeviceCertificatesResponse, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeUserListRequest, DescribeCaCertificateRequest, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeAuthorizationPoliciesRequest, RevokedDeviceCertificateResponse, CreateHttpAuthenticatorRequest, DescribeProductSKUListRequest, DescribeTopicListResponse, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyAuthorizationPolicyRequest, DescribeSharedSubscriptionLagRequest, DeleteTopicResponse, ModifyInstanceCertBindingRequest, ModifyHttpAuthenticatorRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse } from "./mqtt_models";
3
+ import { UpdateAuthorizationPolicyPriorityResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, DescribeMessageListRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DescribeSharedSubscriptionLagResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DeleteAuthenticatorRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, RegisterCaCertificateResponse, DeleteInstanceRequest, ModifyInstanceRequest, RegisterDeviceCertificateResponse, DescribeClientListResponse, DescribeMessageListResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyInstanceResponse, CreateHttpAuthenticatorResponse, ModifyJWKSAuthenticatorResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeMessageByTopicRequest, DescribeInsPublicEndpointsRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DescribeMessageByTopicResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, ModifyHttpAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DescribeUserListResponse, ModifyTopicResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, DescribeClientListRequest, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, CreateTopicResponse, RevokedDeviceCertificateRequest, ModifyInsPublicEndpointResponse, CreateAuthorizationPolicyResponse, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateInstanceRequest, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, DescribeDeviceCertificatesResponse, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeUserListRequest, DescribeCaCertificateRequest, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeAuthorizationPoliciesRequest, RevokedDeviceCertificateResponse, CreateHttpAuthenticatorRequest, DescribeProductSKUListRequest, DescribeTopicListResponse, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyAuthorizationPolicyRequest, DescribeSharedSubscriptionLagRequest, DeleteTopicResponse, ModifyInstanceCertBindingRequest, ModifyHttpAuthenticatorRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse } from "./mqtt_models";
4
4
  /**
5
5
  * mqtt client
6
6
  * @class
7
7
  */
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
+ /**
11
+ * 发布 MQTT 消息到消息主题或客户端
12
+ */
13
+ PublishMessage(req: PublishMessageRequest, cb?: (error: string, rep: PublishMessageResponse) => void): Promise<PublishMessageResponse>;
10
14
  /**
11
15
  * 查询用户列表,Filter参数使用说明如下:
12
16
 
@@ -14,7 +18,7 @@ export declare class Client extends AbstractClient {
14
18
  */
15
19
  DescribeUserList(req: DescribeUserListRequest, cb?: (error: string, rep: DescribeUserListResponse) => void): Promise<DescribeUserListResponse>;
16
20
  /**
17
- * 为MQTT实例创建公网接入点
21
+ * 为MQTT实例创建公网接入点,未开启公网的集群可调用。
18
22
  */
19
23
  CreateInsPublicEndpoint(req: CreateInsPublicEndpointRequest, cb?: (error: string, rep: CreateInsPublicEndpointResponse) => void): Promise<CreateInsPublicEndpointResponse>;
20
24
  /**
@@ -50,15 +54,15 @@ export declare class Client extends AbstractClient {
50
54
  */
51
55
  DeleteInstance(req: DeleteInstanceRequest, cb?: (error: string, rep: DeleteInstanceResponse) => void): Promise<DeleteInstanceResponse>;
52
56
  /**
53
- * 发布 MQTT 消息到消息主题或客户端
57
+ * 根据订阅查询消息
54
58
  */
55
- PublishMessage(req: PublishMessageRequest, cb?: (error: string, rep: PublishMessageResponse) => void): Promise<PublishMessageResponse>;
59
+ DescribeMessageByTopic(req: DescribeMessageByTopicRequest, cb?: (error: string, rep: DescribeMessageByTopicResponse) => void): Promise<DescribeMessageByTopicResponse>;
56
60
  /**
57
61
  * 修改MQTT JWKS 认证器
58
62
  */
59
63
  ModifyJWTAuthenticator(req: ModifyJWTAuthenticatorRequest, cb?: (error: string, rep: ModifyJWTAuthenticatorResponse) => void): Promise<ModifyJWTAuthenticatorResponse>;
60
64
  /**
61
- * 修改MQTT JWKS 认证器
65
+ * 修改MQTT JWKS 认证器,全量配置修改,需要提交完整的修改后配置。
62
66
  */
63
67
  ModifyJWKSAuthenticator(req: ModifyJWKSAuthenticatorRequest, cb?: (error: string, rep: ModifyJWKSAuthenticatorResponse) => void): Promise<ModifyJWKSAuthenticatorResponse>;
64
68
  /**
@@ -171,7 +175,7 @@ export declare class Client extends AbstractClient {
171
175
  */
172
176
  DeleteUser(req: DeleteUserRequest, cb?: (error: string, rep: DeleteUserResponse) => void): Promise<DeleteUserResponse>;
173
177
  /**
174
- * 修改策略规则
178
+ * 修改策略规则,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)
175
179
  */
176
180
  ModifyAuthorizationPolicy(req: ModifyAuthorizationPolicyRequest, cb?: (error: string, rep: ModifyAuthorizationPolicyResponse) => void): Promise<ModifyAuthorizationPolicyResponse>;
177
181
  /**
@@ -27,6 +27,12 @@ class Client extends abstract_client_1.AbstractClient {
27
27
  constructor(clientConfig) {
28
28
  super("mqtt.tencentcloudapi.com", "2024-05-16", clientConfig);
29
29
  }
30
+ /**
31
+ * 发布 MQTT 消息到消息主题或客户端
32
+ */
33
+ async PublishMessage(req, cb) {
34
+ return this.request("PublishMessage", req, cb);
35
+ }
30
36
  /**
31
37
  * 查询用户列表,Filter参数使用说明如下:
32
38
 
@@ -36,7 +42,7 @@ class Client extends abstract_client_1.AbstractClient {
36
42
  return this.request("DescribeUserList", req, cb);
37
43
  }
38
44
  /**
39
- * 为MQTT实例创建公网接入点
45
+ * 为MQTT实例创建公网接入点,未开启公网的集群可调用。
40
46
  */
41
47
  async CreateInsPublicEndpoint(req, cb) {
42
48
  return this.request("CreateInsPublicEndpoint", req, cb);
@@ -90,10 +96,10 @@ class Client extends abstract_client_1.AbstractClient {
90
96
  return this.request("DeleteInstance", req, cb);
91
97
  }
92
98
  /**
93
- * 发布 MQTT 消息到消息主题或客户端
99
+ * 根据订阅查询消息
94
100
  */
95
- async PublishMessage(req, cb) {
96
- return this.request("PublishMessage", req, cb);
101
+ async DescribeMessageByTopic(req, cb) {
102
+ return this.request("DescribeMessageByTopic", req, cb);
97
103
  }
98
104
  /**
99
105
  * 修改MQTT JWKS 认证器
@@ -102,7 +108,7 @@ class Client extends abstract_client_1.AbstractClient {
102
108
  return this.request("ModifyJWTAuthenticator", req, cb);
103
109
  }
104
110
  /**
105
- * 修改MQTT JWKS 认证器
111
+ * 修改MQTT JWKS 认证器,全量配置修改,需要提交完整的修改后配置。
106
112
  */
107
113
  async ModifyJWKSAuthenticator(req, cb) {
108
114
  return this.request("ModifyJWKSAuthenticator", req, cb);
@@ -267,7 +273,7 @@ class Client extends abstract_client_1.AbstractClient {
267
273
  return this.request("DeleteUser", req, cb);
268
274
  }
269
275
  /**
270
- * 修改策略规则
276
+ * 修改策略规则,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)
271
277
  */
272
278
  async ModifyAuthorizationPolicy(req, cb) {
273
279
  return this.request("ModifyAuthorizationPolicy", req, cb);
@@ -196,35 +196,40 @@ export interface DescribeMessageListRequest {
196
196
  */
197
197
  export interface ModifyJWTAuthenticatorRequest {
198
198
  /**
199
- * 实例ID
199
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
200
200
  */
201
201
  InstanceId: string;
202
202
  /**
203
- * 算法:hmac-based,public-key
203
+ * 签名方式:hmac-based,public-key
204
204
  */
205
205
  Algorithm?: string;
206
206
  /**
207
- * 设备连接时传递jwt的key;
208
- username-使用用户名字段传递;
209
- password-使用密码字段传递
207
+ * 认证字段
208
+ password:对应 MQTT CONNECT Packet 中 password 字段,
209
+ username:对应 MQTT CONNECT Packet 中 username 字段
210
210
  */
211
211
  From?: string;
212
212
  /**
213
- * 密码
213
+ * 密钥,Algorithm为hmac-based需要传递该字段。
214
214
  */
215
215
  Secret?: string;
216
216
  /**
217
- * 公钥
217
+ * 公钥,Algorithm为public-key时需要传递该字段。
218
218
  */
219
219
  PublicKey?: string;
220
220
  /**
221
- * JSKS文本
221
+ * 认证器是否开启:open-启用;close-关闭
222
222
  */
223
- Text?: string;
223
+ Status?: string;
224
224
  /**
225
- * 说明
225
+ * 说明,不能超过 128 个字符
226
226
  */
227
227
  Remark?: string;
228
+ /**
229
+ * JSKS文本
230
+ * @deprecated
231
+ */
232
+ Text?: string;
228
233
  }
229
234
  /**
230
235
  * 策略规则优先级
@@ -429,13 +434,13 @@ export interface PublicAccessRule {
429
434
  /**
430
435
  * ip网段信息
431
436
  */
432
- IpRule: string;
437
+ IpRule?: string;
433
438
  /**
434
- * 允许或者拒绝
439
+ * 当前仅支持允许,默认允许(allow)
435
440
  */
436
- Allow: boolean;
441
+ Allow?: boolean;
437
442
  /**
438
- * 备注信息
443
+ * 备注信息,最多64个字符。
439
444
  */
440
445
  Remark?: string;
441
446
  }
@@ -512,31 +517,33 @@ export interface ProductSkuItem {
512
517
  */
513
518
  export interface ModifyJWKSAuthenticatorRequest {
514
519
  /**
515
- * 实例ID
520
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
516
521
  */
517
522
  InstanceId: string;
518
523
  /**
519
- * 端点
524
+ * JWKS服务器地址,(Text字段和Endpoint字段必须选择一个填写)
520
525
  */
521
526
  Endpoint?: string;
522
527
  /**
523
- * 认证器状态:open-启用;close-关闭
528
+ * 认证器状态:open-启用(默认);close-关闭
524
529
  */
525
530
  Status?: string;
526
531
  /**
527
- * 刷新时间
532
+ * 认证文本刷新间隔时间,单位:秒,最小值60,默认值60,最大值1000。填写认证服务器地址时生效。
528
533
  */
529
534
  RefreshInterval?: number;
530
535
  /**
531
- * JSKS文本
536
+ * JWKS文本,认证服务器地址为空时生效。(Text字段和Endpoint字段必须选择一个填写)
532
537
  */
533
538
  Text?: string;
534
539
  /**
535
- * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
540
+ * 认证字段;
541
+ username-对应 MQTT CONNECT Packet 中 username 字段,
542
+ password-对应 MQTT CONNECT Packet 中 password 字段。默认username
536
543
  */
537
544
  From?: string;
538
545
  /**
539
- * 说明
546
+ * 说明,不能超过 128 个字符
540
547
  */
541
548
  Remark?: string;
542
549
  }
@@ -579,7 +586,7 @@ export interface ModifyInstanceRequest {
579
586
  */
580
587
  Name?: string;
581
588
  /**
582
- * 要修改的备注信息,最多64个字符。
589
+ * 要修改的备注信息,最多128个字符。
583
590
  */
584
591
  Remark?: string;
585
592
  /**
@@ -591,10 +598,12 @@ export interface ModifyInstanceRequest {
591
598
  * 客户端证书注册方式:
592
599
  JITP:自动注册
593
600
  API:手动通过API注册
601
+ * @deprecated
594
602
  */
595
603
  DeviceCertificateProvisionType?: string;
596
604
  /**
597
605
  * 自动注册证书是否自动激活
606
+ * @deprecated
598
607
  */
599
608
  AutomaticActivation?: boolean;
600
609
  /**
@@ -771,7 +780,6 @@ export interface MQTTInstanceItem {
771
780
  MAINTAINING,维护中
772
781
  ABNORMAL,异常
773
782
  OVERDUE,欠费
774
- DESTROYED,已删除
775
783
  CREATING,创建中
776
784
  MODIFYING,变配中
777
785
  CREATE_FAILURE,创建失败
@@ -895,13 +903,29 @@ export interface CreateHttpAuthenticatorResponse {
895
903
  RequestId?: string;
896
904
  }
897
905
  /**
898
- * ModifyInsPublicEndpoint返回参数结构体
906
+ * MQTT消息
899
907
  */
900
- export interface ModifyInsPublicEndpointResponse {
908
+ export interface MQTTMessage {
901
909
  /**
902
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
910
+ * 消息id
903
911
  */
904
- RequestId?: string;
912
+ MessageId?: string;
913
+ /**
914
+ * 消息发送的客户端Id
915
+ */
916
+ ClientId?: string;
917
+ /**
918
+ * 消息服务质量等级
919
+ */
920
+ Qos?: string;
921
+ /**
922
+ * 消息在服务端的存储时间,毫秒级时间戳
923
+ */
924
+ StoreTimestamp?: number;
925
+ /**
926
+ * 源topic
927
+ */
928
+ OriginTopic?: string;
905
929
  }
906
930
  /**
907
931
  * 消息记录
@@ -929,14 +953,17 @@ export interface MQTTMessageItem {
929
953
  ProduceTime?: string;
930
954
  /**
931
955
  * 死信重发次数
956
+ * @deprecated
932
957
  */
933
958
  DeadLetterResendTimes?: number;
934
959
  /**
935
960
  * 死信重发成功次数
961
+ * @deprecated
936
962
  */
937
963
  DeadLetterResendSuccessTimes?: number;
938
964
  /**
939
965
  * 子topic
966
+ * @deprecated
940
967
  */
941
968
  SubTopic?: string;
942
969
  /**
@@ -991,24 +1018,25 @@ export interface CreateAuthorizationPolicyRequest {
991
1018
  */
992
1019
  PolicyVersion: number;
993
1020
  /**
994
- * 策略优先级,越小越优先,不能重复
1021
+ * 策略优先级,越小越优先,不能重复,优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
995
1022
  */
996
1023
  Priority: number;
997
1024
  /**
998
1025
  * 决策:
999
- allow 允许
1000
- deny 拒绝
1026
+ allow:允许符合该策略的设备的访问请求。
1027
+ deny:拒绝覆盖该策略的设备的访问请求。
1028
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1001
1029
  */
1002
1030
  Effect: string;
1003
1031
  /**
1004
- * 操作
1032
+ * 操作,支持多选,多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1005
1033
  connect:连接
1006
1034
  pub:发布
1007
1035
  sub:订阅
1008
1036
  */
1009
1037
  Actions: string;
1010
1038
  /**
1011
- * 条件-保留消息
1039
+ * 条件-保留消息,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1012
1040
  1,匹配保留消息;
1013
1041
  2,匹配非保留消息,
1014
1042
  3.匹配保留和非保留消息
@@ -1019,10 +1047,12 @@ export interface CreateAuthorizationPolicyRequest {
1019
1047
  0:最多一次
1020
1048
  1:最少一次
1021
1049
  2:精确一次
1050
+ 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1022
1051
  */
1023
1052
  Qos: string;
1024
1053
  /**
1025
- * 资源,需要匹配的订阅
1054
+ * 资源,需要匹配的订阅,支持配置多条匹配规则,多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1055
+
1026
1056
  */
1027
1057
  Resources?: string;
1028
1058
  /**
@@ -1034,7 +1064,7 @@ export interface CreateAuthorizationPolicyRequest {
1034
1064
  */
1035
1065
  ClientId?: string;
1036
1066
  /**
1037
- * 条件:客户端IP地址,支持IP或者CIDR
1067
+ * 条件:客户端IP地址,支持IP或者CIDR,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
1038
1068
  */
1039
1069
  Ip?: string;
1040
1070
  /**
@@ -1099,6 +1129,27 @@ export interface DeleteDeviceCertificateRequest {
1099
1129
  */
1100
1130
  DeviceCertificateSn: string;
1101
1131
  }
1132
+ /**
1133
+ * DescribeMessageByTopic请求参数结构体
1134
+ */
1135
+ export interface DescribeMessageByTopicRequest {
1136
+ /**
1137
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1138
+ */
1139
+ InstanceId: string;
1140
+ /**
1141
+ * home/room
1142
+ */
1143
+ Topic: string;
1144
+ /**
1145
+ * 开始时间,毫秒级时间戳 。
1146
+ */
1147
+ StartTime: number;
1148
+ /**
1149
+ * 查询消息条数,最大1024,默认100.
1150
+ */
1151
+ MaxNumber?: number;
1152
+ }
1102
1153
  /**
1103
1154
  * DescribeInsPublicEndpoints请求参数结构体
1104
1155
  */
@@ -1135,6 +1186,19 @@ export interface DeleteDeviceCertificateResponse {
1135
1186
  */
1136
1187
  RequestId?: string;
1137
1188
  }
1189
+ /**
1190
+ * DescribeMessageByTopic返回参数结构体
1191
+ */
1192
+ export interface DescribeMessageByTopicResponse {
1193
+ /**
1194
+ * 消息列表
1195
+ */
1196
+ Data?: Array<MQTTMessage>;
1197
+ /**
1198
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1199
+ */
1200
+ RequestId?: string;
1201
+ }
1138
1202
  /**
1139
1203
  * DeleteInstance返回参数结构体
1140
1204
  */
@@ -1166,33 +1230,35 @@ export interface DescribeProductSKUListResponse {
1166
1230
  */
1167
1231
  export interface CreateJWKSAuthenticatorRequest {
1168
1232
  /**
1169
- * 实例ID
1233
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1170
1234
  */
1171
1235
  InstanceId: string;
1172
1236
  /**
1173
- * jwks端点
1237
+ * JWKS服务地址,(Text字段和Endpoint字段必须选择一个填写)
1174
1238
  */
1175
1239
  Endpoint?: string;
1176
1240
  /**
1177
- * jwks刷新间隔,单位:秒
1241
+ * 认证文本刷新间隔时间,单位:秒,最小值60,默认值60,最大值1000。填写认证服务器地址(Endpoint)时生效。
1178
1242
  */
1179
1243
  RefreshInterval?: number;
1180
1244
  /**
1181
- * jwks文本
1245
+ * jwks文本,(Text字段和Endpoint字段必须选择一个填写)
1182
1246
  */
1183
1247
  Text?: string;
1184
1248
  /**
1185
- * 认证器是否开启:open-启用;close-关闭
1249
+ * 认证器是否开启:open-启用;close-关闭,默认open-启用
1186
1250
  */
1187
1251
  Status?: string;
1188
1252
  /**
1189
- * 说明
1253
+ * 说明,不能超过 128 个字符
1190
1254
  */
1191
1255
  Remark?: string;
1192
1256
  /**
1193
- * 设备连接时传递jwt的key;
1194
- username-使用用户名字段传递;
1195
- password-使用密码字段传递
1257
+ * 认证字段;
1258
+ username-对应 MQTT CONNECT Packet 中 username 字段,
1259
+ password-对应 MQTT CONNECT Packet 中 password 字段。
1260
+
1261
+ 默认username
1196
1262
  */
1197
1263
  From?: string;
1198
1264
  }
@@ -1634,6 +1700,15 @@ export interface RevokedDeviceCertificateRequest {
1634
1700
  */
1635
1701
  DeviceCertificateSn: string;
1636
1702
  }
1703
+ /**
1704
+ * ModifyInsPublicEndpoint返回参数结构体
1705
+ */
1706
+ export interface ModifyInsPublicEndpointResponse {
1707
+ /**
1708
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1709
+ */
1710
+ RequestId?: string;
1711
+ }
1637
1712
  /**
1638
1713
  * CreateAuthorizationPolicy返回参数结构体
1639
1714
  */
@@ -1699,21 +1774,23 @@ export interface RegisterCaCertificateRequest {
1699
1774
  */
1700
1775
  export interface CreateInstanceRequest {
1701
1776
  /**
1702
- * 实例类型,
1777
+ * 实例类型,需要和SkuCode保持对应关系,可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。
1703
1778
  BASIC 基础版
1704
1779
  PRO 专业版
1780
+ PLATINUM 铂金版
1781
+
1705
1782
  */
1706
1783
  InstanceType: string;
1707
1784
  /**
1708
- * 实例名称
1785
+ * 集群名称不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
1709
1786
  */
1710
1787
  Name: string;
1711
1788
  /**
1712
- * 商品规格,可用规格可通过接口DescribeProductSKUList查询
1789
+ * 商品规格,需要和InstanceType保持对应关系,可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。
1713
1790
  */
1714
1791
  SkuCode: string;
1715
1792
  /**
1716
- * 备注信息
1793
+ * 备注信息,最长 128 字符
1717
1794
  */
1718
1795
  Remark?: string;
1719
1796
  /**
@@ -1721,31 +1798,31 @@ export interface CreateInstanceRequest {
1721
1798
  */
1722
1799
  TagList?: Array<Tag>;
1723
1800
  /**
1724
- * 实例绑定的VPC信息
1801
+ * 实例绑定的VPC信息,需要传当前用户下可用的VPC和SUBNET
1725
1802
  */
1726
1803
  VpcList?: Array<VpcInfo>;
1727
1804
  /**
1728
- * 是否开启公网
1805
+ * 是否开启公网,默认false(关闭)
1729
1806
  */
1730
1807
  EnablePublic?: boolean;
1731
1808
  /**
1732
- * 公网带宽(单位:兆)
1809
+ * 公网带宽(单位:Mbps),EnablePublic 为True时,该字段必须填写且大于0.
1733
1810
  */
1734
1811
  Bandwidth?: number;
1735
1812
  /**
1736
- * 公网访问白名单
1813
+ * 公网访问白名单,不传表示拒绝所有IP网络访问。
1737
1814
  */
1738
1815
  IpRules?: Array<IpRule>;
1739
1816
  /**
1740
- * 是否自动续费(0: 不自动续费;1: 自动续费)
1817
+ * 是否自动续费(0: 不自动续费;1: 自动续费),仅购买预付费集群时生效。默认1:自动续费
1741
1818
  */
1742
1819
  RenewFlag?: number;
1743
1820
  /**
1744
- * 购买时长(单位:月)
1821
+ * 购买时长(单位:月),购买预付费集群时生效,默认1m(月)。可选范围:1~12、24、36、48、60;
1745
1822
  */
1746
1823
  TimeSpan?: number;
1747
1824
  /**
1748
- * 付费模式(0: 后付费;1: 预付费)
1825
+ * 付费模式(0: 后付费;1: 预付费),默认0(后付费)。
1749
1826
  */
1750
1827
  PayMode?: number;
1751
1828
  }
@@ -1754,7 +1831,7 @@ export interface CreateInstanceRequest {
1754
1831
  */
1755
1832
  export interface CreateInsPublicEndpointRequest {
1756
1833
  /**
1757
- * 实例ID
1834
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1758
1835
  */
1759
1836
  InstanceId: string;
1760
1837
  /**
@@ -1794,8 +1871,6 @@ export interface RegisterDeviceCertificateRequest {
1794
1871
  * 客户端证书状态,默认激活状态(ACTIVE)
1795
1872
  ACTIVE:激活
1796
1873
  INACTIVE:未激活
1797
- REVOKED:吊销
1798
- PENDING_ACTIVATION:注册待激活
1799
1874
  */
1800
1875
  Status?: string;
1801
1876
  }
@@ -2030,7 +2105,7 @@ export interface DescribeDeviceCertificateRequest {
2030
2105
  */
2031
2106
  export interface ModifyInsPublicEndpointRequest {
2032
2107
  /**
2033
- * 实例ID
2108
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2034
2109
  */
2035
2110
  InstanceId: string;
2036
2111
  /**
@@ -2144,27 +2219,27 @@ export interface RevokedDeviceCertificateResponse {
2144
2219
  */
2145
2220
  export interface CreateHttpAuthenticatorRequest {
2146
2221
  /**
2147
- * 实例ID
2222
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2148
2223
  */
2149
2224
  InstanceId: string;
2150
2225
  /**
2151
- * jwks端点
2226
+ * jwks服务地址
2152
2227
  */
2153
2228
  Endpoint: string;
2154
2229
  /**
2155
- * 最大并发连接数,默认8,范围:1-20
2230
+ * 最大并发连接数,默认8,范围:1-10
2156
2231
  */
2157
2232
  Concurrency?: number;
2158
2233
  /**
2159
- * 网络请求方法 GetPost,默认post
2234
+ * 网络请求方法 GETPOST,默认POST
2160
2235
  */
2161
2236
  Method?: string;
2162
2237
  /**
2163
- * 认证器是否开启:open-启用;close-关闭
2238
+ * 认证器是否开启:open-启用;close-关闭,默认open-启用
2164
2239
  */
2165
2240
  Status?: string;
2166
2241
  /**
2167
- * 说明
2242
+ * 说明,最多支持128个字符。
2168
2243
  */
2169
2244
  Remark?: string;
2170
2245
  /**
@@ -2289,6 +2364,7 @@ export interface DescribeInstanceListRequest {
2289
2364
  InstanceName:集群名模糊搜索
2290
2365
  InstanceId:集群id精确搜索
2291
2366
  InstanceStatus:集群状态搜索(RUNNING-运行中,CREATING-创建中,MODIFYING-变配中,DELETING-删除中)
2367
+ 注意:配置TagFilters时该查询条件不生效。
2292
2368
  */
2293
2369
  Filters?: Array<Filter>;
2294
2370
  /**
@@ -2322,31 +2398,35 @@ export interface DeactivateCaCertificateRequest {
2322
2398
  */
2323
2399
  export interface CreateJWTAuthenticatorRequest {
2324
2400
  /**
2325
- * 实例ID
2401
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2326
2402
  */
2327
2403
  InstanceId: string;
2328
2404
  /**
2329
- * 算法:hmac-based,public-key
2405
+ * 签名方式:hmac-based,public-key
2330
2406
  */
2331
2407
  Algorithm: string;
2332
2408
  /**
2333
- * 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
2409
+ * 认证字段
2410
+ password:对应 MQTT CONNECT Packet 中 password 字段,
2411
+ username:对应 MQTT CONNECT Packet 中 username 字段
2412
+ 默认username
2413
+
2334
2414
  */
2335
2415
  From: string;
2336
2416
  /**
2337
- * 密码
2417
+ * 密钥,Algorithm为hmac-based需要传递该字段。
2338
2418
  */
2339
2419
  Secret?: string;
2340
2420
  /**
2341
- * 公钥
2421
+ * 公钥,Algorithm为public-key时需要传递该字段。
2342
2422
  */
2343
2423
  PublicKey?: string;
2344
2424
  /**
2345
- * 认证器是否开启:open-启用;close-关闭
2425
+ * 认证器是否开启:open-启用;close-关闭,默认:open-启用
2346
2426
  */
2347
2427
  Status?: string;
2348
2428
  /**
2349
- * 说明
2429
+ * 说明,不能超过 128 个字符。
2350
2430
  */
2351
2431
  Remark?: string;
2352
2432
  }
@@ -2518,59 +2598,72 @@ export interface PriceTag {
2518
2598
  */
2519
2599
  export interface ModifyAuthorizationPolicyRequest {
2520
2600
  /**
2521
- * 策略
2601
+ * 授权策略ID,从 [查询授权策略](https://cloud.tencent.com/document/product/1778/111074) 接口获取
2522
2602
  */
2523
2603
  Id: number;
2524
2604
  /**
2525
- * 实例ID
2605
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2606
+
2526
2607
  */
2527
2608
  InstanceId: string;
2528
2609
  /**
2529
- * 策略名称
2610
+ * 策略名称,不能为空,3-64个字符,支持中文、字母、数字、“-”及“_”。
2530
2611
  */
2531
2612
  PolicyName?: string;
2532
2613
  /**
2533
- * 策略版本
2614
+ * 策略版本,默认为1,当前仅支持1
2534
2615
  */
2535
2616
  PolicyVersion?: number;
2536
2617
  /**
2537
- * 策略优先级,越小越优先
2618
+ * 策略优先级,越小越优先,不能重复
2538
2619
  */
2539
2620
  Priority?: number;
2540
2621
  /**
2541
- * allow、deny
2622
+ * 决策:
2623
+ allow 允许
2624
+ deny 拒绝
2542
2625
  */
2543
2626
  Effect?: string;
2544
2627
  /**
2545
- * connect、pub、sub
2628
+ * 操作,支持多选,多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
2629
+ connect:连接
2630
+ pub:发布
2631
+ sub:订阅
2546
2632
  */
2547
2633
  Actions?: string;
2548
2634
  /**
2549
- * 资源
2635
+ * 资源,需要匹配的订阅,支持配置多条匹配规则,多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
2636
+
2550
2637
  */
2551
2638
  Resources?: string;
2552
2639
  /**
2553
- * 用户名
2640
+ * 条件-用户名
2554
2641
  */
2555
2642
  Username?: string;
2556
2643
  /**
2557
- * 1.匹配保留消息;2.匹配非保留消息;3.匹配所有消息
2644
+ * 条件-保留消息
2645
+ 1,匹配保留消息;
2646
+ 2,匹配非保留消息,
2647
+ 3.匹配保留和非保留消息
2558
2648
  */
2559
2649
  Retain?: number;
2560
2650
  /**
2561
- * 客户端
2651
+ * 条件:客户端ID,支持正则
2562
2652
  */
2563
2653
  ClientId?: string;
2564
2654
  /**
2565
- * IP
2655
+ * 条件:客户端IP地址,支持IP或者CIDR
2566
2656
  */
2567
2657
  Ip?: string;
2568
2658
  /**
2569
- * 0、1、2
2659
+ * 条件:服务质量
2660
+ 0:最多一次
2661
+ 1:最少一次
2662
+ 2:精确一次
2570
2663
  */
2571
2664
  Qos?: string;
2572
2665
  /**
2573
- * 备注信息
2666
+ * 备注信息,最长 128 字符
2574
2667
  */
2575
2668
  Remark?: string;
2576
2669
  }
@@ -2601,17 +2694,9 @@ export interface DeleteTopicResponse {
2601
2694
  */
2602
2695
  export interface ModifyInstanceCertBindingRequest {
2603
2696
  /**
2604
- * 实例ID
2697
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2605
2698
  */
2606
2699
  InstanceId: string;
2607
- /**
2608
- * 服务端证书id
2609
- */
2610
- SSLServerCertId: string;
2611
- /**
2612
- * CA证书id
2613
- */
2614
- SSLCaCertId: string;
2615
2700
  /**
2616
2701
  * 加密通信方式
2617
2702
  TLS:单向证书认证
@@ -2619,10 +2704,19 @@ export interface ModifyInstanceCertBindingRequest {
2619
2704
  BYOC:一设备一证书认证
2620
2705
  */
2621
2706
  X509Mode: string;
2707
+ /**
2708
+ * 服务端证书id,从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS或BYOC时为必填。
2709
+ */
2710
+ SSLServerCertId?: string;
2711
+ /**
2712
+ * CA证书id,从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS时为必填
2713
+ */
2714
+ SSLCaCertId?: string;
2622
2715
  /**
2623
2716
  * 设备证书注册类型:
2624
- JITP,自动注册;
2625
- MANUAL 手动注册
2717
+ JITP:自动注册;
2718
+ API:手动注册
2719
+ 默认值:API
2626
2720
  */
2627
2721
  DeviceCertificateProvisionType?: string;
2628
2722
  /**
@@ -2635,11 +2729,11 @@ export interface ModifyInstanceCertBindingRequest {
2635
2729
  */
2636
2730
  export interface ModifyHttpAuthenticatorRequest {
2637
2731
  /**
2638
- * 实例ID
2732
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2639
2733
  */
2640
2734
  InstanceId: string;
2641
2735
  /**
2642
- * 端点
2736
+ * 服务地址
2643
2737
  */
2644
2738
  Endpoint?: string;
2645
2739
  /**
@@ -2647,7 +2741,7 @@ export interface ModifyHttpAuthenticatorRequest {
2647
2741
  */
2648
2742
  Status?: string;
2649
2743
  /**
2650
- * 最大并发连接数,默认8,范围:1-20
2744
+ * 最大并发连接数,默认8,范围:1-10
2651
2745
  */
2652
2746
  Concurrency?: number;
2653
2747
  /**
@@ -2659,7 +2753,7 @@ export interface ModifyHttpAuthenticatorRequest {
2659
2753
  */
2660
2754
  ReadTimeout?: number;
2661
2755
  /**
2662
- * 说明
2756
+ * 说明,最多支持128个字符。
2663
2757
  */
2664
2758
  Remark?: string;
2665
2759
  /**
@@ -2732,7 +2826,7 @@ export interface IpRule {
2732
2826
  */
2733
2827
  Ip: string;
2734
2828
  /**
2735
- * 是否允许放行
2829
+ * 当前仅支持允许,默认允许。
2736
2830
  */
2737
2831
  Allow: boolean;
2738
2832
  /**