tencentcloud-sdk-nodejs 4.1.6 → 4.1.8

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 (81) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/ccc/v20200210/ccc_client.js +12 -0
  3. package/es/services/gs/v20191118/gs_client.js +3 -0
  4. package/es/services/iss/v20230517/iss_client.js +166 -160
  5. package/es/services/ocr/v20181119/ocr_client.js +4 -13
  6. package/es/services/partners/v20180321/partners_client.js +34 -31
  7. package/es/services/tdmq/v20200217/tdmq_client.js +0 -3
  8. package/es/services/tione/v20211111/tione_client.js +16 -4
  9. package/package.json +1 -1
  10. package/tencentcloud/common/sdk_version.d.ts +1 -1
  11. package/tencentcloud/common/sdk_version.js +1 -1
  12. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +0 -59
  13. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +0 -4
  14. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +2 -0
  15. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +17 -1
  16. package/tencentcloud/services/ccc/v20200210/ccc_client.js +24 -0
  17. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +269 -84
  18. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +24 -24
  19. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1 -1
  20. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +3 -3
  21. package/tencentcloud/services/cme/v20191029/cme_client.d.ts +1 -3
  22. package/tencentcloud/services/cme/v20191029/cme_client.js +1 -3
  23. package/tencentcloud/services/cme/v20191029/cme_models.d.ts +174 -176
  24. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +1 -1
  25. package/tencentcloud/services/cvm/v20170312/cvm_client.js +1 -1
  26. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +16 -0
  27. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +8 -45
  28. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +36 -59
  29. package/tencentcloud/services/domain/v20180808/domain_models.d.ts +7 -3
  30. package/tencentcloud/services/dts/v20180330/dts_models.d.ts +0 -1
  31. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -7
  32. package/tencentcloud/services/ecdn/v20191012/ecdn_client.d.ts +6 -2
  33. package/tencentcloud/services/ecdn/v20191012/ecdn_client.js +6 -2
  34. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +2 -2
  35. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +5 -3
  36. package/tencentcloud/services/ess/v20201111/ess_client.js +5 -3
  37. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +20 -7
  38. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +2 -2
  39. package/tencentcloud/services/gs/v20191118/gs_client.d.ts +5 -1
  40. package/tencentcloud/services/gs/v20191118/gs_client.js +6 -0
  41. package/tencentcloud/services/gs/v20191118/gs_models.d.ts +26 -0
  42. package/tencentcloud/services/iotcloud/v20210408/iotcloud_models.d.ts +14 -14
  43. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +10 -0
  44. package/tencentcloud/services/iotvideo/v20201215/iotvideo_models.d.ts +1 -1
  45. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +14 -4
  46. package/tencentcloud/services/iss/v20230517/iss_client.d.ts +177 -169
  47. package/tencentcloud/services/iss/v20230517/iss_client.js +262 -250
  48. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +129 -20
  49. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +5 -2
  50. package/tencentcloud/services/live/v20180801/live_models.d.ts +14 -2
  51. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +15 -1
  52. package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +4 -0
  53. package/tencentcloud/services/mmps/v20200710/mmps_models.d.ts +4 -6
  54. package/tencentcloud/services/mqtt/v20240516/mqtt_client.d.ts +2 -2
  55. package/tencentcloud/services/mqtt/v20240516/mqtt_client.js +2 -2
  56. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +85 -34
  57. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +72 -89
  58. package/tencentcloud/services/ocr/v20181119/ocr_client.js +73 -96
  59. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +68 -194
  60. package/tencentcloud/services/partners/v20180321/partners_client.d.ts +39 -35
  61. package/tencentcloud/services/partners/v20180321/partners_client.js +57 -51
  62. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +42 -0
  63. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +0 -4
  64. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +16 -0
  65. package/tencentcloud/services/tag/v20180813/tag_models.d.ts +9 -9
  66. package/tencentcloud/services/tdid/v20210519/tdid_models.d.ts +0 -5
  67. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +10 -10
  68. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +9 -11
  69. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +36 -62
  70. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +4 -0
  71. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +21 -5
  72. package/tencentcloud/services/tione/v20211111/tione_client.js +30 -6
  73. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +245 -71
  74. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +0 -2
  75. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +14 -32
  76. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +2 -1
  77. package/tencentcloud/services/vod/v20180717/vod_client.js +2 -1
  78. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +122 -175
  79. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +8 -5
  80. package/tencentcloud/services/vpc/v20170312/vpc_client.js +8 -5
  81. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +77 -50
@@ -299,6 +299,27 @@ export interface ControlRecordTimelineRequest {
299
299
  */
300
300
  End: number;
301
301
  }
302
+ /**
303
+ * 修改录像上云模板数据结构
304
+ */
305
+ export interface UpdateRecordBackupTemplateModify {
306
+ /**
307
+ * 模板名称(不修改名称时,不需要带该字段)
308
+ */
309
+ TemplateName?: string;
310
+ /**
311
+ * 上云时间段(按周进行设置,支持一天设置多个时间段,每个时间段不小于10分钟)
312
+ */
313
+ TimeSections?: Array<RecordTemplateTimeSections>;
314
+ /**
315
+ * 录像时间段(按周进行设置,支持一天设置多个时间段,每个时间段不小于10分钟)
316
+ */
317
+ DevTimeSections?: Array<RecordTemplateTimeSections>;
318
+ /**
319
+ * 上云倍速(支持1,2,4倍速)
320
+ */
321
+ Scale?: number;
322
+ }
302
323
  /**
303
324
  * DeleteOrganization请求参数结构体
304
325
  */
@@ -988,6 +1009,15 @@ export interface DescribeRecordRetrieveTaskRequest {
988
1009
  */
989
1010
  TaskId: string;
990
1011
  }
1012
+ /**
1013
+ * ControlDeviceSnapshot返回参数结构体
1014
+ */
1015
+ export interface ControlDeviceSnapshotResponse {
1016
+ /**
1017
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1018
+ */
1019
+ RequestId?: string;
1020
+ }
991
1021
  /**
992
1022
  * DescribeAITask请求参数结构体
993
1023
  */
@@ -1628,6 +1658,35 @@ export interface ListAITasksRequest {
1628
1658
  */
1629
1659
  PageSize?: number;
1630
1660
  }
1661
+ /**
1662
+ * ListDeviceSnapshots请求参数结构体
1663
+ */
1664
+ export interface ListDeviceSnapshotsRequest {
1665
+ /**
1666
+ * 通道ID
1667
+ */
1668
+ ChannelId: string;
1669
+ /**
1670
+ * 设备ID(该字段暂不生效)
1671
+ */
1672
+ DeviceId?: string;
1673
+ /**
1674
+ * 查询开始时间,默认查询当天
1675
+ */
1676
+ Start?: number;
1677
+ /**
1678
+ * 查询结束时间,默认查询当天
1679
+ */
1680
+ End?: number;
1681
+ /**
1682
+ * 分页页码,默认1
1683
+ */
1684
+ PageNumber?: number;
1685
+ /**
1686
+ * 分页大小,默认200,最大2000
1687
+ */
1688
+ PageSize?: number;
1689
+ }
1631
1690
  /**
1632
1691
  * UpdateRecordPlan请求参数结构体
1633
1692
  */
@@ -2265,6 +2324,39 @@ export interface DeleteGatewayRequest {
2265
2324
  */
2266
2325
  GatewayId: string;
2267
2326
  }
2327
+ /**
2328
+ * 抓拍结果信息
2329
+ */
2330
+ export interface GBDeviceSnapInfo {
2331
+ /**
2332
+ * 文件名称
2333
+ */
2334
+ FileName?: string;
2335
+ /**
2336
+ * 下载地址,空值表示存储图片过期
2337
+ */
2338
+ DownloadUrl?: string;
2339
+ /**
2340
+ * 图片大小,单位B
2341
+ */
2342
+ ImageSize?: number;
2343
+ /**
2344
+ * 文件的创建时间
2345
+ */
2346
+ CreatedTime?: string;
2347
+ /**
2348
+ * 图片的接收时间
2349
+ */
2350
+ ReceivedTime?: string;
2351
+ /**
2352
+ * 预览地址,空值表示存储图片过期
2353
+ */
2354
+ PreviewUrl?: string;
2355
+ /**
2356
+ * 国标信令会话ID,同时对应控制设备抓拍 ( ControlDeviceSnapshot )接口返回的request_id
2357
+ */
2358
+ SessionId?: string;
2359
+ }
2268
2360
  /**
2269
2361
  * 获取设备列表的响应
2270
2362
  */
@@ -3042,6 +3134,27 @@ export interface ListAITaskData {
3042
3134
  */
3043
3135
  List?: Array<AITaskInfo>;
3044
3136
  }
3137
+ /**
3138
+ * ControlDeviceSnapshot请求参数结构体
3139
+ */
3140
+ export interface ControlDeviceSnapshotRequest {
3141
+ /**
3142
+ * 通道ID
3143
+ */
3144
+ ChannelId: string;
3145
+ /**
3146
+ * 连拍张数,可选值范围1~10
3147
+ */
3148
+ SnapNum: number;
3149
+ /**
3150
+ * 抓拍间隔时间,可选值范围1~1800
3151
+ */
3152
+ Interval: number;
3153
+ /**
3154
+ * 图片存储时间,默认 7 天,仅支持(7, 15, 30, 60, 90, 180, 365)天
3155
+ */
3156
+ Expire?: number;
3157
+ }
3045
3158
  /**
3046
3159
  * 修改实时上云模板的请求数据结构
3047
3160
  */
@@ -3445,25 +3558,17 @@ export interface PlayRecordRequest {
3445
3558
  IsInternal?: boolean;
3446
3559
  }
3447
3560
  /**
3448
- * 修改录像上云模板数据结构
3561
+ * 录像切片信息
3449
3562
  */
3450
- export interface UpdateRecordBackupTemplateModify {
3451
- /**
3452
- * 模板名称(不修改名称时,不需要带该字段)
3453
- */
3454
- TemplateName?: string;
3455
- /**
3456
- * 上云时间段(按周进行设置,支持一天设置多个时间段,每个时间段不小于10分钟)
3457
- */
3458
- TimeSections?: Array<RecordTemplateTimeSections>;
3563
+ export interface RecordSliceInfo {
3459
3564
  /**
3460
- * 录像时间段(按周进行设置,支持一天设置多个时间段,每个时间段不小于10分钟)
3565
+ * 计划ID
3461
3566
  */
3462
- DevTimeSections?: Array<RecordTemplateTimeSections>;
3567
+ PlanId?: string;
3463
3568
  /**
3464
- * 上云倍速(支持1,2,4倍速)
3569
+ * 录像切片开始和结束时间列表
3465
3570
  */
3466
- Scale?: number;
3571
+ List?: Array<RecordTimeLine>;
3467
3572
  }
3468
3573
  /**
3469
3574
  * QueryForbidPlayChannelList请求参数结构体
@@ -4641,17 +4746,21 @@ export interface ControlDeviceStreamData {
4641
4746
  Rtmp?: string;
4642
4747
  }
4643
4748
  /**
4644
- * 录像切片信息
4749
+ * ListDeviceSnapshots返回参数结构体
4645
4750
  */
4646
- export interface RecordSliceInfo {
4751
+ export interface ListDeviceSnapshotsResponse {
4647
4752
  /**
4648
- * 计划ID
4753
+ * 抓拍结果信息列表
4649
4754
  */
4650
- PlanId?: string;
4755
+ Data?: Array<GBDeviceSnapInfo>;
4651
4756
  /**
4652
- * 录像切片开始和结束时间列表
4757
+ * 抓拍结果总数
4653
4758
  */
4654
- List?: Array<RecordTimeLine>;
4759
+ TotalCount?: number;
4760
+ /**
4761
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4762
+ */
4763
+ RequestId?: string;
4655
4764
  }
4656
4765
  /**
4657
4766
  * 实时上云模板信息数据
@@ -3821,10 +3821,13 @@ export interface TrafficPackage {
3821
3821
  export interface FirewallRule {
3822
3822
  /**
3823
3823
  * 协议,取值:TCP,UDP,ICMP,ALL,ICMPv6。
3824
+
3825
+ - 使用ICMP协议时,只支持CidrBlock,不支持使用Port、Ipv6CidrBlock参数;
3826
+ - 使用ICMPv6协议时,只支持Ipv6CidrBlock,不支持使用Port、Ipv6CidrBlock参数;
3824
3827
  */
3825
3828
  Protocol: string;
3826
3829
  /**
3827
- * 端口,取值:ALL,单独的端口,逗号分隔的离散端口,减号分隔的端口范围。
3830
+ * 端口,取值:ALL,单独的端口,逗号分隔的离散端口,减号分隔的端口范围。注意:单独的端口与离散端口不能同时存在。
3828
3831
  */
3829
3832
  Port?: string;
3830
3833
  /**
@@ -3842,7 +3845,7 @@ export interface FirewallRule {
3842
3845
  */
3843
3846
  Ipv6CidrBlock?: string;
3844
3847
  /**
3845
- * 取值:ACCEPTDROP。默认为 ACCEPT。
3848
+ * 取值:ACCEPT(允许),DROP(拒绝)。默认为 ACCEPT。
3846
3849
  */
3847
3850
  Action?: string;
3848
3851
  /**
@@ -2095,11 +2095,15 @@ export interface TaskDurationInfo {
2095
2095
  /**
2096
2096
  * 拉流转推任务的时间点
2097
2097
  */
2098
- Time: string;
2098
+ Time?: string;
2099
2099
  /**
2100
2100
  * 拉流转推任务的时长,单位为分钟
2101
2101
  */
2102
- Duration: number;
2102
+ Duration?: number;
2103
+ /**
2104
+ * 拉流转推任务的时长,单位为秒
2105
+ */
2106
+ DurationSecond?: number;
2103
2107
  }
2104
2108
  /**
2105
2109
  * 规则信息
@@ -5439,6 +5443,10 @@ export interface DescribePullTransformPushInfoRequest {
5439
5443
  默认:查询国内+国外的数据。
5440
5444
  */
5441
5445
  MainlandOrOversea?: string;
5446
+ /**
5447
+ * 可选值: PullLivePushLive:拉流源类型为直播 PullVodPushLive:拉流源类型为点播 PullPicPushLive:拉流源类型为图片 默认:查询全部拉流源类型
5448
+ */
5449
+ SourceType?: string;
5442
5450
  }
5443
5451
  /**
5444
5452
  * DescribeBillBandwidthAndFluxList请求参数结构体
@@ -7618,6 +7626,10 @@ export interface DescribePullTransformPushInfoResponse {
7618
7626
  * 拉流转推得总时长
7619
7627
  */
7620
7628
  TotalDuration?: number;
7629
+ /**
7630
+ * 拉流转推得总时长(秒)
7631
+ */
7632
+ TotalDurationSecond?: number;
7621
7633
  /**
7622
7634
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7623
7635
  */
@@ -5215,7 +5215,7 @@ export interface ModelInfo {
5215
5215
  */
5216
5216
  MaxTokens?: ModelParameter;
5217
5217
  /**
5218
- * 模型来源 Hunyuan:腾讯混元大模型,Industry:腾讯云行业大模型,Experience:新模型体验
5218
+ * 模型来源 Hunyuan:腾讯混元大模型,Industry:腾讯云行业大模型,Experience:新模型体验,Custom自定义模型
5219
5219
  */
5220
5220
  Source?: string;
5221
5221
  /**
@@ -5226,6 +5226,20 @@ export interface ModelInfo {
5226
5226
  * 是否免费
5227
5227
  */
5228
5228
  IsFree?: boolean;
5229
+ /**
5230
+ * 模型对话框可输入的上限
5231
+ 注意:此字段可能返回 null,表示取不到有效值。
5232
+ */
5233
+ InputLenLimit?: number;
5234
+ /**
5235
+ * 支持工作流的类型 0:模型不支持; 1: 模型支持工作流; 2: 模型支持效果不佳;
5236
+ 注意:此字段可能返回 null,表示取不到有效值。
5237
+ */
5238
+ SupportWorkflowStatus?: number;
5239
+ /**
5240
+ * 模型类别 generate:生成模型,thought:思考模型
5241
+ */
5242
+ ModelCategory?: string;
5229
5243
  }
5230
5244
  /**
5231
5245
  * DeleteRejectedQuestion请求参数结构体
@@ -765,6 +765,10 @@ export interface Delta {
765
765
  * 内容详情。
766
766
  */
767
767
  Content?: string;
768
+ /**
769
+ * 思维链内容。 ReasoningConent参数仅支持出参,且只有deepseek-r1模型会返回。
770
+ */
771
+ ReasoningContent?: string;
768
772
  }
769
773
  /**
770
774
  * ReconstructDocumentSSE请求参数结构体
@@ -834,21 +834,19 @@ export interface DescribeScanTaskStatusResponse {
834
834
  /**
835
835
  * 返回值, 0:成功, 其他值请查看“返回值”定义
836
836
  */
837
- Result: number;
837
+ Result?: number;
838
838
  /**
839
839
  * 0:默认值(待检测/待咨询), 1.检测中, 4:任务完成/咨询完成, 5:任务失败, 6:咨询中;
840
840
  */
841
- Status: number;
841
+ Status?: number;
842
842
  /**
843
843
  * 诊断失败的错误信息
844
- 注意:此字段可能返回 null,表示取不到有效值。
845
844
  */
846
- ErrMsg: string;
845
+ ErrMsg?: string;
847
846
  /**
848
847
  * 任务流详情
849
- 注意:此字段可能返回 null,表示取不到有效值。
850
848
  */
851
- FlowSteps: Array<TaskFlowStepsInfo>;
849
+ FlowSteps?: Array<TaskFlowStepsInfo>;
852
850
  /**
853
851
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
854
852
  */
@@ -199,7 +199,7 @@ export declare class Client extends AbstractClient {
199
199
  */
200
200
  ActivateCaCertificate(req: ActivateCaCertificateRequest, cb?: (error: string, rep: ActivateCaCertificateResponse) => void): Promise<ActivateCaCertificateResponse>;
201
201
  /**
202
- * 查询消息列表,如查询死信,请设置ConsumerGroup参数
202
+ * 根据一级Topic查询消息列表
203
203
  */
204
204
  DescribeMessageList(req: DescribeMessageListRequest, cb?: (error: string, rep: DescribeMessageListResponse) => void): Promise<DescribeMessageListResponse>;
205
205
  /**
@@ -219,7 +219,7 @@ export declare class Client extends AbstractClient {
219
219
  */
220
220
  CreateAuthorizationPolicy(req: CreateAuthorizationPolicyRequest, cb?: (error: string, rep: CreateAuthorizationPolicyResponse) => void): Promise<CreateAuthorizationPolicyResponse>;
221
221
  /**
222
- * 修改实例属性
222
+ * 修改实例属性,只有运行中的集群可以调用该接口进行变更配置。
223
223
  */
224
224
  ModifyInstance(req: ModifyInstanceRequest, cb?: (error: string, rep: ModifyInstanceResponse) => void): Promise<ModifyInstanceResponse>;
225
225
  /**
@@ -309,7 +309,7 @@ class Client extends abstract_client_1.AbstractClient {
309
309
  return this.request("ActivateCaCertificate", req, cb);
310
310
  }
311
311
  /**
312
- * 查询消息列表,如查询死信,请设置ConsumerGroup参数
312
+ * 根据一级Topic查询消息列表
313
313
  */
314
314
  async DescribeMessageList(req, cb) {
315
315
  return this.request("DescribeMessageList", req, cb);
@@ -339,7 +339,7 @@ class Client extends abstract_client_1.AbstractClient {
339
339
  return this.request("CreateAuthorizationPolicy", req, cb);
340
340
  }
341
341
  /**
342
- * 修改实例属性
342
+ * 修改实例属性,只有运行中的集群可以调用该接口进行变更配置。
343
343
  */
344
344
  async ModifyInstance(req, cb) {
345
345
  return this.request("ModifyInstance", req, cb);
@@ -163,31 +163,31 @@ export interface ApplyRegistrationCodeRequest {
163
163
  */
164
164
  export interface DescribeMessageListRequest {
165
165
  /**
166
- * 实例ID
166
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
167
167
  */
168
168
  InstanceId: string;
169
169
  /**
170
- * 主题
170
+ * 要查询的一级Topic,可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
171
171
  */
172
172
  Topic: string;
173
173
  /**
174
- * 开始时间
174
+ * 开始时间,毫秒级时间戳 。
175
175
  */
176
176
  StartTime: number;
177
177
  /**
178
- * 结束时间
178
+ * 结束时间,毫秒级时间戳 。
179
179
  */
180
180
  EndTime: number;
181
181
  /**
182
- * 请求任务id
182
+ * 请求任务id,用于相同查询参数下查询加速,第一次查询时无需传递,第一次查询会根据本次查询参数生成查询任务ID,保留查询条件,查询下一页消息时可传递第一次查询返回的任务ID。
183
183
  */
184
184
  TaskRequestId: string;
185
185
  /**
186
- * 查询起始位置
186
+ * 查询起始位置,默认0
187
187
  */
188
188
  Offset?: number;
189
189
  /**
190
- * 查询结果限制数量
190
+ * 查询结果限制数量,默认20,最大50
191
191
  */
192
192
  Limit?: number;
193
193
  }
@@ -560,19 +560,20 @@ export interface DeleteInstanceRequest {
560
560
  */
561
561
  export interface ModifyInstanceRequest {
562
562
  /**
563
- * 实例ID
563
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
564
564
  */
565
565
  InstanceId: string;
566
566
  /**
567
- * 要修改实例名称
567
+ * 要修改实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
568
568
  */
569
569
  Name?: string;
570
570
  /**
571
- * 要修改的备注信息
571
+ * 要修改的备注信息,最多64个字符。
572
572
  */
573
573
  Remark?: string;
574
574
  /**
575
- * 要变更的配置规格
575
+ * 需要变更的配置规格
576
+ 基础版和增强版集群不能升配到铂金版规格,铂金版集群不能降配至基础版和增强版规格。
576
577
  */
577
578
  SkuCode?: string;
578
579
  /**
@@ -585,6 +586,10 @@ export interface ModifyInstanceRequest {
585
586
  * 自动注册证书是否自动激活
586
587
  */
587
588
  AutomaticActivation?: boolean;
589
+ /**
590
+ * 授权策略开关
591
+ */
592
+ AuthorizationPolicy?: boolean;
588
593
  }
589
594
  /**
590
595
  * RegisterDeviceCertificate返回参数结构体
@@ -607,16 +612,35 @@ export interface MQTTAuthenticatorItem {
607
612
  */
608
613
  Type?: string;
609
614
  /**
610
- * HTTP认证器
615
+ * JWT认证器字段说明
616
+ from(认证字段)
617
+ password:从password字段获取认证字段
618
+ username:从username字段获取认证字段
619
+ secret(签名方式)
620
+ hmac-based:hmac-based签名方式
621
+ public-key:public-key签名方式
622
+ secret(密钥),hmac-based需要配置密钥
623
+ public-key(公钥),public-key签名方式需要配置
624
+ 样例:{"from":"password","secret":"secret282698","algorithm":"hmac-based"}
625
+
626
+ JWKS认证器字段说明
627
+ endpoint(接入点):公钥获取服务器接入地址
628
+ refreshInterval(认证内容):公钥集合刷新周期
629
+ from(认证字段)
630
+ password:从password字段获取认证字段
631
+ username:从username字段获取认证字段
632
+ text:公钥集合
633
+ 样例:{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"}
634
+
635
+ HTTP认证器
611
636
  headers(请求头):标准请求头和自定义请求头
612
637
  endpoint(接入点):认证服务器接入点
613
638
  method(http请求方法):POST/GET
614
639
  readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
615
640
  connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
616
641
  body(请求体):http请求体
617
- concurrency(并发数):最大并发请求数
642
+ concurrency(并发数):最大并发请求数量
618
643
  样例:{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8}
619
-
620
644
  参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
621
645
  */
622
646
  Config?: string;
@@ -877,7 +901,7 @@ export interface MQTTMessageItem {
877
901
  */
878
902
  ProducerAddr?: string;
879
903
  /**
880
- * 消息发送时间
904
+ * 消息发送时间,格式 日期时间:YYYY-MM-DD hh:mm:ss
881
905
  */
882
906
  ProduceTime?: string;
883
907
  /**
@@ -894,6 +918,9 @@ export interface MQTTMessageItem {
894
918
  SubTopic?: string;
895
919
  /**
896
920
  * 消息质量等级
921
+ 0:至多一次
922
+ 1:至少一次
923
+ 2:精确一次
897
924
  */
898
925
  Qos?: string;
899
926
  }
@@ -929,55 +956,66 @@ export interface CreateUserResponse {
929
956
  */
930
957
  export interface CreateAuthorizationPolicyRequest {
931
958
  /**
932
- * 实例ID
959
+ * 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
933
960
  */
934
961
  InstanceId: string;
935
962
  /**
936
- * 策略名称
963
+ * 策略名称,不能为空,3-64个字符,支持中文、字母、数字、“-”及“_”。
937
964
  */
938
965
  PolicyName: string;
939
966
  /**
940
- * 策略版本
967
+ * 策略版本,默认为1,当前仅支持1
941
968
  */
942
969
  PolicyVersion: number;
943
970
  /**
944
- * 策略优先级,越小越优先
971
+ * 策略优先级,越小越优先,不能重复
945
972
  */
946
973
  Priority: number;
947
974
  /**
948
- * allow、deny
975
+ * 决策:
976
+ allow 允许
977
+ deny 拒绝
949
978
  */
950
979
  Effect: string;
951
980
  /**
952
- * connect、pub、sub
981
+ * 操作
982
+ connect:连接
983
+ pub:发布
984
+ sub:订阅
953
985
  */
954
986
  Actions: string;
955
987
  /**
956
- * 1,匹配保留消息;2,匹配非保留消息,3.匹配所有消息
988
+ * 条件-保留消息
989
+ 1,匹配保留消息;
990
+ 2,匹配非保留消息,
991
+ 3.匹配保留和非保留消息
957
992
  */
958
993
  Retain: number;
959
994
  /**
960
- * 0、1、2
995
+ * 条件:服务质量
996
+ 0:最多一次
997
+ 1:最少一次
998
+ 2:精确一次
961
999
  */
962
1000
  Qos: string;
963
1001
  /**
964
- * 资源
1002
+ * 资源,需要匹配的订阅
965
1003
  */
966
1004
  Resources?: string;
967
1005
  /**
968
- * 用户名
1006
+ * 条件-用户名
969
1007
  */
970
1008
  Username?: string;
971
1009
  /**
972
- * 客户端
1010
+ * 条件:客户端ID,支持正则
973
1011
  */
974
1012
  ClientId?: string;
975
1013
  /**
976
- * IP地址
1014
+ * 条件:客户端IP地址,支持IP或者CIDR
977
1015
  */
978
1016
  Ip?: string;
979
1017
  /**
980
- * 备注信息
1018
+ * 备注信息,最长 128 字符
981
1019
  */
982
1020
  Remark?: string;
983
1021
  }
@@ -1577,6 +1615,14 @@ export interface RevokedDeviceCertificateRequest {
1577
1615
  * CreateAuthorizationPolicy返回参数结构体
1578
1616
  */
1579
1617
  export interface CreateAuthorizationPolicyResponse {
1618
+ /**
1619
+ * 集群Id
1620
+ */
1621
+ InstanceId?: string;
1622
+ /**
1623
+ * 策略id
1624
+ */
1625
+ Id?: number;
1580
1626
  /**
1581
1627
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1582
1628
  */
@@ -1819,6 +1865,7 @@ export interface DescribeInstanceResponse {
1819
1865
  * 实例类型
1820
1866
  BASIC 基础版
1821
1867
  PRO 专业版
1868
+ PLATINUM 铂金版
1822
1869
  */
1823
1870
  InstanceType?: string;
1824
1871
  /**
@@ -1850,7 +1897,7 @@ export interface DescribeInstanceResponse {
1850
1897
  */
1851
1898
  Remark?: string;
1852
1899
  /**
1853
- * 实例状态
1900
+ * 实例状态, RUNNING, 运行中 MAINTAINING,维护中 ABNORMAL,异常 OVERDUE,欠费 DESTROYED,已删除 CREATING,创建中 MODIFYING,变配中 CREATE_FAILURE,创建失败 MODIFY_FAILURE,变配失败 DELETING,删除中
1854
1901
  */
1855
1902
  InstanceStatus?: string;
1856
1903
  /**
@@ -1880,7 +1927,7 @@ export interface DescribeInstanceResponse {
1880
1927
  */
1881
1928
  AutomaticActivation?: boolean;
1882
1929
  /**
1883
- * 是否自动续费
1930
+ * 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
1884
1931
  */
1885
1932
  RenewFlag?: number;
1886
1933
  /**
@@ -1888,11 +1935,11 @@ export interface DescribeInstanceResponse {
1888
1935
  */
1889
1936
  PayMode?: string;
1890
1937
  /**
1891
- * 到期时间,秒为单位
1938
+ * 到期时间,毫秒级时间戳
1892
1939
  */
1893
1940
  ExpiryTime?: number;
1894
1941
  /**
1895
- * 预销毁时间
1942
+ * 预销毁时间,毫秒级时间戳
1896
1943
  */
1897
1944
  DestroyTime?: number;
1898
1945
  /**
@@ -1911,6 +1958,10 @@ export interface DescribeInstanceResponse {
1911
1958
  * 集群最大订阅数
1912
1959
  */
1913
1960
  MaxSubscription?: number;
1961
+ /**
1962
+ * 授权策略开关
1963
+ */
1964
+ AuthorizationPolicy?: boolean;
1914
1965
  /**
1915
1966
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1916
1967
  */
@@ -2372,7 +2423,7 @@ export interface MQTTClientInfo {
2372
2423
  * MQTT 协议版本
2373
2424
  3:表示MQTT 3.1版本
2374
2425
  4:表示 MQTT 3.1.1
2375
- 5: 标识MQTT 5.0协议
2426
+ 5:表示MQTT 5.0协议
2376
2427
  */
2377
2428
  ProtocolVersion?: number;
2378
2429
  /**
@@ -2605,7 +2656,7 @@ export interface ModifyHttpAuthenticatorRequest {
2605
2656
  */
2606
2657
  export interface DescribeInstanceRequest {
2607
2658
  /**
2608
- * 实例ID
2659
+ * 实例ID [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)
2609
2660
  */
2610
2661
  InstanceId: string;
2611
2662
  }