tencentcloud-sdk-nodejs 4.1.308 → 4.1.309

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 (54) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/cls/v20201016/cls_client.js +75 -18
  3. package/es/services/faceid/v20180301/faceid_client.js +2 -5
  4. package/es/services/oceanus/v20190422/oceanus_client.js +3 -0
  5. package/es/services/postgres/v20170312/postgres_client.js +22 -4
  6. package/es/services/tcb/v20180608/tcb_client.js +15 -24
  7. package/es/services/thpc/v20230321/thpc_client.js +17 -8
  8. package/package.json +1 -1
  9. package/tencentcloud/common/sdk_version.d.ts +1 -1
  10. package/tencentcloud/common/sdk_version.js +1 -1
  11. package/tencentcloud/services/ags/v20250920/ags_client.d.ts +1 -1
  12. package/tencentcloud/services/ags/v20250920/ags_models.d.ts +17 -4
  13. package/tencentcloud/services/ai3d/v20250513/ai3d_models.d.ts +4 -8
  14. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +1 -1
  15. package/tencentcloud/services/ams/v20201229/ams_client.js +1 -1
  16. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +102 -26
  17. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +1 -1
  18. package/tencentcloud/services/bh/v20230418/bh_models.d.ts +12 -14
  19. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +5 -5
  20. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +10 -10
  21. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +4 -0
  22. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +95 -19
  23. package/tencentcloud/services/cls/v20201016/cls_client.js +141 -27
  24. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1188 -336
  25. package/tencentcloud/services/config/v20220802/config_client.d.ts +1 -1
  26. package/tencentcloud/services/config/v20220802/config_models.d.ts +6 -1
  27. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +13 -14
  28. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +27 -7
  29. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +4 -0
  30. package/tencentcloud/services/es/v20180416/es_models.d.ts +4 -0
  31. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +8 -27
  32. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +8 -31
  33. package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +3 -7
  34. package/tencentcloud/services/faceid/v20180301/faceid_client.js +3 -9
  35. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +0 -46
  36. package/tencentcloud/services/ga2/v20250115/ga2_models.d.ts +6 -6
  37. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +102 -132
  38. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +5 -1
  39. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +6 -0
  40. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +87 -57
  41. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +2 -2
  42. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +29 -5
  43. package/tencentcloud/services/postgres/v20170312/postgres_client.js +42 -6
  44. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +283 -64
  45. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +22 -35
  46. package/tencentcloud/services/tcb/v20180608/tcb_client.js +30 -49
  47. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +514 -637
  48. package/tencentcloud/services/thpc/v20230321/thpc_client.d.ts +21 -9
  49. package/tencentcloud/services/thpc/v20230321/thpc_client.js +30 -12
  50. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +101 -35
  51. package/tencentcloud/services/vm/v20210922/vm_client.d.ts +1 -1
  52. package/tencentcloud/services/vm/v20210922/vm_client.js +1 -1
  53. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +164 -45
  54. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +4 -4
@@ -46,7 +46,7 @@ export declare class Client extends AbstractClient {
46
46
  /**
47
47
  * 资源监控管理-开启监控
48
48
  */
49
- OpenConfigRecorder(req?: OpenConfigRecorderRequest, cb?: (error: string, rep: OpenConfigRecorderResponse) => void): Promise<OpenConfigRecorderResponse>;
49
+ OpenConfigRecorder(req: OpenConfigRecorderRequest, cb?: (error: string, rep: OpenConfigRecorderResponse) => void): Promise<OpenConfigRecorderResponse>;
50
50
  /**
51
51
  * 查询配置规则资源评估结果列表
52
52
  */
@@ -3331,7 +3331,12 @@ export interface UpdateAggregateConfigRuleRequest {
3331
3331
  /**
3332
3332
  * OpenConfigRecorder请求参数结构体
3333
3333
  */
3334
- export type OpenConfigRecorderRequest = null;
3334
+ export interface OpenConfigRecorderRequest {
3335
+ /**
3336
+ * <p>1:从控制中心调用</p>
3337
+ */
3338
+ FromMode?: number;
3339
+ }
3335
3340
  /**
3336
3341
  * DeleteAlarmPolicy返回参数结构体
3337
3342
  */
@@ -1989,46 +1989,45 @@ export interface DescribeZoneInstanceConfigInfosResponse {
1989
1989
  */
1990
1990
  export interface ModifyInstancesAttributeRequest {
1991
1991
  /**
1992
- * 一个或多个待操作的实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100
1992
+ * <p>一个或多个待操作的实例ID。可通过<a href="https://cloud.tencent.com/document/api/213/15728">DescribeInstances</a> API返回值中的<code>InstanceId</code>获取。每次请求允许操作的实例数量上限是100。</p>
1993
1993
  */
1994
1994
  InstanceIds: Array<string>;
1995
1995
  /**
1996
- * 修改后实例名称。可任意命名,但不得超过60个字符。
1996
+ * <p>修改后实例名称。可任意命名,但不得超过60个字符。</p>
1997
1997
  */
1998
1998
  InstanceName?: string;
1999
1999
  /**
2000
- * 提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16 KB。关于获取此参数的详细介绍,请参阅 [Windows](https://cloud.tencent.com/document/product/213/17526)[Linux](https://cloud.tencent.com/document/product/213/17525) 启动时运行命令。
2000
+ * <p>提供给实例使用的用户数据,需要以 base64 方式编码,支持的最大数据大小为 16 KB。关于获取此参数的详细介绍,请参阅 <a href="https://cloud.tencent.com/document/product/213/17526">Windows</a><a href="https://cloud.tencent.com/document/product/213/17525">Linux</a> 启动时运行命令。</p>
2001
2001
  */
2002
2002
  UserData?: string;
2003
2003
  /**
2004
- * 指定实例的修改后的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。
2004
+ * <p>指定实例的修改后的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。</p>
2005
2005
  */
2006
2006
  SecurityGroups?: Array<string>;
2007
2007
  /**
2008
- * 给实例绑定用户角色,传空值为解绑操作
2008
+ * <p>给实例绑定用户角色,传空值为解绑操作</p>
2009
2009
  */
2010
2010
  CamRoleName?: string;
2011
2011
  /**
2012
- * 修改后实例的主机名。<li>点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。</li><li>Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。</li><li>其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。</li>注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
2012
+ * <p>修改后实例的主机名。<li>点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。</li><li>Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。</li><li>其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。</li>注意点:修改主机名后实例会立即重启,重启后新的主机名生效。</p>
2013
2013
  */
2014
2014
  HostName?: string;
2015
2015
  /**
2016
- * 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:<li>true:表示开启实例保护,不允许通过api接口删除实例</li><li>false:表示关闭实例保护,允许通过api接口删除实例</li>默认取值:false
2016
+ * <p>实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:<li>true:表示开启实例保护,不允许通过api接口删除实例</li><li>false:表示关闭实例保护,允许通过api接口删除实例</li>默认取值:false。</p>
2017
2017
  */
2018
2018
  DisableApiTermination?: boolean;
2019
2019
  /**
2020
- * 角色类别,与CamRoleName搭配使用,该值可从CAM [ DescribeRoleList ](https://cloud.tencent.com/document/product/598/36223)或[ GetRole ](https://cloud.tencent.com/document/product/598/36221)接口返回RoleType字段获取,当前只接受user、system和service_linked三种类别。
2021
- 举例:一般CamRoleName中包含“LinkedRoleIn”(如TKE_QCSLinkedRoleInPrometheusService)时,DescribeRoleList和GetRole返回的RoleType为service_linked,则本参数也需要传递service_linked。
2022
- 该参数默认值为user,若CameRoleName为非service_linked类型,本参数可不传递。
2020
+ * <p>角色类别,与CamRoleName搭配使用,该值可从CAM <a href="https://cloud.tencent.com/document/product/598/36223"> DescribeRoleList </a>或<a href="https://cloud.tencent.com/document/product/598/36221"> GetRole </a>接口返回RoleType字段获取,当前只接受user、system和service_linked三种类别。<br>举例:一般CamRoleName中包含“LinkedRoleIn”(如TKE_QCSLinkedRoleInPrometheusService)时,DescribeRoleList和GetRole返回的RoleType为service_linked,则本参数也需要传递service_linked。<br>该参数默认值为user,若CameRoleName为非service_linked类型,本参数可不传递。</p>
2023
2021
  */
2024
2022
  CamRoleType?: string;
2025
2023
  /**
2026
- * 修改实例主机名是否自动重启实例,不传默认自动重启。
2027
- - true: 修改主机名,并自动重启实例;
2028
- - false: 修改主机名,不自动重启实例,需要手动重启使新主机名生效。
2029
- 注意点:本参数仅对修改主机名生效。
2024
+ * <p>修改实例主机名是否自动重启实例,不传默认自动重启。</p><ul><li>true: 修改主机名,并自动重启实例;</li><li>false: 修改主机名,不自动重启实例,需要手动重启使新主机名生效。<br>注意点:本参数仅对修改主机名生效。</li></ul>
2030
2025
  */
2031
2026
  AutoReboot?: boolean;
2027
+ /**
2028
+ * <p>实例是否开启巨型帧,取值范围:<br></p><ul><li>true:表示实例开启巨型帧,只有支持巨型帧的机型可设置为true。</li><li>false:表示实例关闭巨型帧,只有支持巨型帧的机型可设置为false。<br><br>支持巨型帧的实例规格: <a href="https://cloud.tencent.com/document/product/213/11518">实例规格</a></li></ul>
2029
+ */
2030
+ EnableJumboFrame?: boolean;
2032
2031
  }
2033
2032
  /**
2034
2033
  * RenewHosts请求参数结构体
@@ -2751,6 +2751,14 @@ export interface ModifyMalwareTimingScanSettingsRequest {
2751
2751
  * <p>实时监控 0 关闭 1开启</p>
2752
2752
  */
2753
2753
  RealTimeMonitoring: number;
2754
+ /**
2755
+ * <p>自定义路径列表,仅CheckPattern=2/3时生效:2表示仅检测这些路径,3表示检测时排除这些路径。最少1条,最多200条</p>
2756
+ */
2757
+ CustomPaths?: Array<string>;
2758
+ /**
2759
+ * <p>监控自定义路径列表,仅MonitoringPattern=2/3时生效:2表示仅监控这些路径,3表示监控时排除这些路径。最少1条,最多200条</p>
2760
+ */
2761
+ MonitorCustomPaths?: Array<string>;
2754
2762
  /**
2755
2763
  * <p>自选服务器时必须 主机quuid的string数组</p>
2756
2764
  */
@@ -14050,7 +14058,7 @@ export interface ExportVulDefenceListRequest {
14050
14058
  */
14051
14059
  export interface CreateScanMalwareSettingResponse {
14052
14060
  /**
14053
- * 任务id
14061
+ * <p>任务id</p>
14054
14062
  */
14055
14063
  TaskId?: number;
14056
14064
  /**
@@ -22030,27 +22038,31 @@ export type DescribeBaselineDefaultStrategyListRequest = null;
22030
22038
  */
22031
22039
  export interface CreateScanMalwareSettingRequest {
22032
22040
  /**
22033
- * 扫描模式 0 全盘扫描, 1 快速扫描
22041
+ * <p>扫描模式 0 全盘扫描, 1 快速扫描</p>
22034
22042
  */
22035
22043
  ScanPattern: number;
22036
22044
  /**
22037
- * 服务器分类:1:专业版服务器;2:自选服务器
22045
+ * <p>服务器分类:1:专业版服务器;2:自选服务器</p>
22038
22046
  */
22039
22047
  HostType: number;
22040
22048
  /**
22041
- * 自选服务器时生效,主机quuid的string数组
22049
+ * <p>自定义路径列表,仅ScanPattern=2/3时生效:2表示仅扫描这些路径,3表示扫描时排除这些路径。最少1条,最多200条</p>
22050
+ */
22051
+ CustomPaths?: Array<string>;
22052
+ /**
22053
+ * <p>自选服务器时生效,主机quuid的string数组</p>
22042
22054
  */
22043
22055
  QuuidList?: Array<string>;
22044
22056
  /**
22045
- * 超时时间单位 秒 默认3600
22057
+ * <p>超时时间单位 秒 默认3600 秒</p>
22046
22058
  */
22047
22059
  TimeoutPeriod?: number;
22048
22060
  /**
22049
- * 1标准模式(只报严重、高危)、2增强模式(报严重、高危、中危)、3严格模式(报严重、高、中、低、提示)
22061
+ * <p>1标准模式(只报严重、高危)、2增强模式(报严重、高危、中危)、3严格模式(报严重、高、中、低、提示)</p>
22050
22062
  */
22051
22063
  EngineType?: number;
22052
22064
  /**
22053
- * 是否开启恶意进程查杀[0:未开启,1:开启]
22065
+ * <p>是否开启恶意进程查杀[0:未开启,1:开启]</p>
22054
22066
  */
22055
22067
  EnableMemShellScan?: number;
22056
22068
  }
@@ -22082,6 +22094,10 @@ export interface DescribeMalwareTimingScanSettingResponse {
22082
22094
  * <p>检测模式 0 全盘检测 1快速检测</p>
22083
22095
  */
22084
22096
  CheckPattern?: number;
22097
+ /**
22098
+ * <p>自定义路径列表,CheckPattern=2/3时生效</p>
22099
+ */
22100
+ CustomPaths?: Array<string>;
22085
22101
  /**
22086
22102
  * <p>检测周期 开始时间</p>
22087
22103
  */
@@ -22102,6 +22118,10 @@ export interface DescribeMalwareTimingScanSettingResponse {
22102
22118
  * <p>监控模式 0 标准 1深度</p>
22103
22119
  */
22104
22120
  MonitoringPattern?: number;
22121
+ /**
22122
+ * <p>监控自定义路径列表,MonitoringPattern=2/3时生效</p>
22123
+ */
22124
+ MonitorCustomPaths?: Array<string>;
22105
22125
  /**
22106
22126
  * <p>周期 1每天</p>
22107
22127
  */
@@ -2543,6 +2543,10 @@ export interface DescribeInstanceSpecsRequest {
2543
2543
  * <p>集群级别。例如 P0, P1。若未指定可用区,针对于不支持亲和性的可用区将降级查询非亲和性资源。</p>
2544
2544
  */
2545
2545
  ClusterLevel?: string;
2546
+ /**
2547
+ * <p>可用区</p>
2548
+ */
2549
+ Zone?: string;
2546
2550
  }
2547
2551
  /**
2548
2552
  * ModifyMaintainPeriodConfig返回参数结构体
@@ -4931,6 +4931,10 @@ export interface InstanceInfo {
4931
4931
  * <p>集群待迁移的TCP地址</p>
4932
4932
  */
4933
4933
  OldEsPrivateTcpUrl?: string;
4934
+ /**
4935
+ * <p>是否需要从VIP下线旧节点</p>
4936
+ */
4937
+ NeedOfflineOldNodesNotify?: boolean;
4934
4938
  }
4935
4939
  /**
4936
4940
  * 采集器配置项
@@ -2907,11 +2907,11 @@ export interface ModifyExtendedServiceResponse {
2907
2907
  */
2908
2908
  export interface DescribeBillUsageDetailResponse {
2909
2909
  /**
2910
- * 总数
2910
+ * <p>总数</p>
2911
2911
  */
2912
2912
  Total?: number;
2913
2913
  /**
2914
- * 消耗详情
2914
+ * <p>消耗详情</p>
2915
2915
  */
2916
2916
  Details?: Array<BillUsageDetail>;
2917
2917
  /**
@@ -11158,46 +11158,27 @@ export interface DescribeOrganizationSealsResponse {
11158
11158
  */
11159
11159
  export interface DescribeBillUsageDetailRequest {
11160
11160
  /**
11161
- * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31
11161
+ * <p>查询开始时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<span style="color: red;">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</span></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
11162
11162
  */
11163
11163
  StartTime: string;
11164
11164
  /**
11165
- * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31
11165
+ * <p>查询结束时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<span style="color: red;">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</span></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
11166
11166
  */
11167
11167
  EndTime: string;
11168
11168
  /**
11169
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
11169
+ * <p>指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0</p>
11170
11170
  */
11171
11171
  Offset?: number;
11172
11172
  /**
11173
- * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
11173
+ * <p>指定分页每页返回的数据条数,如果不传默认为 100,单页最大支持 100。</p>
11174
11174
  */
11175
11175
  Limit?: number;
11176
11176
  /**
11177
- * 查询的套餐类型 (选填 )不传则查询所有套餐;
11178
- 目前支持:
11179
- <ul>
11180
- <li>**CloudEnterprise**: 企业版合同</li>
11181
- <li>**SingleSignature**: 单方签章</li>
11182
- <li>**CloudProve**: 签署报告</li>
11183
- <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
11184
- <li>**ChannelWeCard**: 微工卡</li>
11185
- <li>**SignFlow**: 合同套餐</li>
11186
- <li>**SignFace**: 签署意愿(人脸识别)</li>
11187
- <li>**SignPassword**: 签署意愿(密码)</li>
11188
- <li>**SignSMS**: 签署意愿(短信)</li>
11189
- <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
11190
- <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
11191
- <li>**OrgEssAuth**: 签署企业实名</li>
11192
- <li>**FlowNotify**: 短信通知</li>
11193
- <li>**AuthService**: 企业工商信息查询</li>
11194
- <li>**NoAuthSign**: 形式签</li>
11195
- </ul>
11177
+ * <p>查询的套餐类型 (选填 )不传则查询所有套餐;<br>目前支持:</p><ul><li>**CloudEnterprise**: 企业版合同</li><li>**SingleSignature**: 单方签章</li><li>**CloudProve**: 签署报告</li><li>**CloudOnlineSign**: 腾讯会议在线签约</li><li>**ChannelWeCard**: 微工卡</li><li>**SignFlow**: 合同套餐</li><li>**SignFace**: 签署意愿(人脸识别)</li><li>**SignPassword**: 签署意愿(密码)</li><li>**SignSMS**: 签署意愿(短信)</li><li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li><li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li><li>**OrgEssAuth**: 签署企业实名</li><li>**FlowNotify**: 短信通知</li><li>**AuthService**: 企业工商信息查询</li><li>**NoAuthSign**: 形式签</li></ul>
11196
11178
  */
11197
11179
  QuotaType?: string;
11198
11180
  /**
11199
- * 代理企业和员工的信息。
11200
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
11181
+ * <p>代理企业和员工的信息。<br>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。</p>
11201
11182
  */
11202
11183
  Agent?: Agent;
11203
11184
  }
@@ -5361,11 +5361,11 @@ export interface DescribeChannelOrganizationsRequest {
5361
5361
  */
5362
5362
  export interface ChannelDescribeBillUsageDetailResponse {
5363
5363
  /**
5364
- * 返回查询记录总数
5364
+ * <p>返回查询记录总数</p>
5365
5365
  */
5366
5366
  Total?: number;
5367
5367
  /**
5368
- * 消耗记录详情
5368
+ * <p>消耗记录详情</p>
5369
5369
  */
5370
5370
  Details?: Array<ChannelBillUsageDetail>;
5371
5371
  /**
@@ -8916,50 +8916,27 @@ export interface ChannelCreateFlowApproversRequest {
8916
8916
  */
8917
8917
  export interface ChannelDescribeBillUsageDetailRequest {
8918
8918
  /**
8919
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
8920
-
8921
- 此接口下面信息必填。
8922
- <ul>
8923
- <li>渠道应用标识: Agent.AppId</li>
8924
- </ul>
8925
- 第三方平台子客企业必须已经经过实名认证
8919
+ * <p>关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。</p><p>此接口下面信息必填。</p><ul><li>渠道应用标识: Agent.AppId</li></ul>第三方平台子客企业必须已经经过实名认证
8926
8920
  */
8927
8921
  Agent: Agent;
8928
8922
  /**
8929
- * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31
8923
+ * <p>查询开始时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<span style="color: red;">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</span></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
8930
8924
  */
8931
8925
  StartTime: string;
8932
8926
  /**
8933
- * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31
8927
+ * <p>查询结束时间字符串,格式为yyyyMMdd,时间跨度不能大于31天。<span style="color: red;">注意:从 2026年10月10日起,开始日期和结束日期必须在同一个自然月内,不支持跨月查询。</span></p><ul><li><p>正确示例:StartTime=20260901,EndTime=20260930。开始和结束日期都在 2026年9月,可以查询。</p></li><li><p>错误示例:StartTime=20260815,EndTime=20260915。开始日期在8月,结束日期在9月,属于跨月查询,不支持。</p></li></ul><p>参数格式:yyyyMMdd</p>
8934
8928
  */
8935
8929
  EndTime: string;
8936
8930
  /**
8937
- * 查询的套餐类型 (选填 )不传则查询所有套餐;
8938
- 目前支持:
8939
- <ul>
8940
- <li>**CloudEnterprise**: 企业版合同</li>
8941
- <li>**SingleSignature**: 单方签章</li>
8942
- <li>**CloudProve**: 签署报告</li>
8943
- <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
8944
- <li>**ChannelWeCard**: 微工卡</li>
8945
- <li>**SignFlow**: 合同套餐</li>
8946
- <li>**SignFace**: 签署意愿(人脸识别)</li>
8947
- <li>**SignPassword**: 签署意愿(密码)</li>
8948
- <li>**SignSMS**: 签署意愿(短信)</li>
8949
- <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
8950
- <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
8951
- <li>**OrgEssAuth**: 签署企业实名</li>
8952
- <li>**FlowNotify**: 短信通知</li>
8953
- <li>**AuthService**: 企业工商信息查询</li>
8954
- </ul>
8931
+ * <p>查询的套餐类型 (选填 )不传则查询所有套餐;<br>目前支持:</p><ul><li>**CloudEnterprise**: 企业版合同</li><li>**SingleSignature**: 单方签章</li><li>**CloudProve**: 签署报告</li><li>**CloudOnlineSign**: 腾讯会议在线签约</li><li>**ChannelWeCard**: 微工卡</li><li>**SignFlow**: 合同套餐</li><li>**SignFace**: 签署意愿(人脸识别)</li><li>**SignPassword**: 签署意愿(密码)</li><li>**SignSMS**: 签署意愿(短信)</li><li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li><li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li><li>**OrgEssAuth**: 签署企业实名</li><li>**FlowNotify**: 短信通知</li><li>**AuthService**: 企业工商信息查询</li></ul>
8955
8932
  */
8956
8933
  QuotaType?: string;
8957
8934
  /**
8958
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
8935
+ * <p>指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0</p>
8959
8936
  */
8960
8937
  Offset?: number;
8961
8938
  /**
8962
- * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
8939
+ * <p>指定分页每页返回的数据条数,如果不传默认为 100,单页最大支持 100。</p>
8963
8940
  */
8964
8941
  Limit?: number;
8965
8942
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { GetFaceidRiskInfoTokenResponse, CheckIdNameDateResponse, IdCardVerificationRequest, ImageRecognitionV2Response, GetDetectInfoEnhancedResponse, MobileStatusRequest, ParseNfcDataResponse, LivenessRecognitionRequest, CheckEidTokenStatusResponse, DetectAuthRequest, CheckEidTokenStatusRequest, GetFaceIdRiskInfoResponse, LivenessCompareResponse, BankCard2EVerificationResponse, MobileStatusResponse, EncryptedPhoneVerificationRequest, EncryptedPhoneVerificationResponse, DetectAIFakeFacesRequest, CheckBankCardInformationResponse, GetEidTokenRequest, CheckIdNameDateRequest, GetFaceIdTokenResponse, GetWxNFCResultResponse, MinorsVerificationRequest, GetFaceIdResultResponse, DetectAIFakeFacesResponse, LivenessCompareRequest, CheckBankCardInformationRequest, BankCardVerificationRequest, GetWxNFCResultRequest, GetWeChatBillDetailsResponse, CheckIdCardInformationResponse, GetEidResultRequest, DetectAuthResponse, PhoneVerificationResponse, IdCardOCRVerificationRequest, BankCard4EVerificationResponse, MobileNetworkTimeVerificationRequest, PhoneVerificationCMCCResponse, MobileNetworkTimeVerificationResponse, PhoneVerificationCUCCResponse, CheckIdCardInformationRequest, MinorsVerificationResponse, GetWeChatBillDetailsRequest, BankCardVerificationResponse, PhoneVerificationCUCCRequest, PhoneVerificationCMCCRequest, ImageRecognitionResponse, GetDetectInfoResponse, IdCardOCRVerificationResponse, IdCardVerificationResponse, GetActionSequenceRequest, GetDetectInfoEnhancedRequest, LivenessRecognitionResponse, GetLiveCodeRequest, GetEidResultResponse, PhoneVerificationRequest, GetFaceIdResultRequest, CheckPhoneAndNameResponse, GetFaceIdTokenRequest, GetFaceidRiskInfoTokenRequest, BankCard2EVerificationRequest, ImageRecognitionV2Request, PhoneVerificationCTCCResponse, ParseNfcDataRequest, PhoneVerificationCTCCRequest, ImageRecognitionRequest, BankCard4EVerificationRequest, GetNFCTokenResponse, GetActionSequenceResponse, GetNFCTokenRequest, GetFaceIdRiskInfoRequest, GetLiveCodeResponse, GetDetectInfoRequest, CheckPhoneAndNameRequest, GetEidTokenResponse } from "./faceid_models";
3
+ import { GetFaceidRiskInfoTokenResponse, CheckIdNameDateResponse, IdCardVerificationRequest, ImageRecognitionV2Response, GetDetectInfoEnhancedResponse, MobileStatusRequest, ParseNfcDataResponse, LivenessRecognitionRequest, CheckEidTokenStatusResponse, DetectAuthRequest, CheckEidTokenStatusRequest, GetFaceIdRiskInfoResponse, LivenessCompareResponse, BankCard2EVerificationResponse, MobileStatusResponse, EncryptedPhoneVerificationRequest, EncryptedPhoneVerificationResponse, DetectAIFakeFacesRequest, CheckBankCardInformationResponse, GetEidTokenRequest, CheckIdNameDateRequest, GetFaceIdTokenResponse, GetWxNFCResultResponse, MinorsVerificationRequest, GetFaceIdResultResponse, DetectAIFakeFacesResponse, LivenessCompareRequest, CheckBankCardInformationRequest, BankCardVerificationRequest, GetWxNFCResultRequest, GetWeChatBillDetailsResponse, CheckIdCardInformationResponse, GetEidResultRequest, DetectAuthResponse, PhoneVerificationResponse, IdCardOCRVerificationRequest, BankCard4EVerificationResponse, MobileNetworkTimeVerificationRequest, PhoneVerificationCMCCResponse, MobileNetworkTimeVerificationResponse, PhoneVerificationCUCCResponse, CheckIdCardInformationRequest, MinorsVerificationResponse, GetWeChatBillDetailsRequest, BankCardVerificationResponse, PhoneVerificationCUCCRequest, PhoneVerificationCMCCRequest, GetDetectInfoResponse, IdCardOCRVerificationResponse, IdCardVerificationResponse, GetActionSequenceRequest, GetDetectInfoEnhancedRequest, LivenessRecognitionResponse, GetLiveCodeRequest, GetEidResultResponse, PhoneVerificationRequest, GetFaceIdResultRequest, CheckPhoneAndNameResponse, GetFaceIdTokenRequest, GetFaceidRiskInfoTokenRequest, BankCard2EVerificationRequest, ImageRecognitionV2Request, PhoneVerificationCTCCResponse, ParseNfcDataRequest, PhoneVerificationCTCCRequest, BankCard4EVerificationRequest, GetNFCTokenResponse, GetActionSequenceResponse, GetNFCTokenRequest, GetFaceIdRiskInfoRequest, GetLiveCodeResponse, GetDetectInfoRequest, CheckPhoneAndNameRequest, GetEidTokenResponse } from "./faceid_models";
4
4
  /**
5
5
  * faceid client
6
6
  * @class
@@ -80,9 +80,9 @@ export declare class Client extends AbstractClient {
80
80
  */
81
81
  GetFaceIdResult(req: GetFaceIdResultRequest, cb?: (error: string, rep: GetFaceIdResultResponse) => void): Promise<GetFaceIdResultResponse>;
82
82
  /**
83
- * 传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人(该接口已停止接入,新客户请使用<a href="https://cloud.tencent.com/document/product/1007/102203">照片人脸核身(V2.0)</a>接口)。
83
+ * 解析SDK获取到的证件NFC数据,接口传入SDK返回的ReqId,返回证件信息(个别字段为特定证件类型特有)。SDK生成的ReqId五分钟内有效,重复查询仅收一次费。支持身份证类证件(二代身份证、港澳居住证、台湾居住证、外国人永居证)以及旅行类证件(港澳通行证、台湾通行证、台胞证、回乡证)的NFC识别及核验。
84
84
  */
85
- ImageRecognition(req: ImageRecognitionRequest, cb?: (error: string, rep: ImageRecognitionResponse) => void): Promise<ImageRecognitionResponse>;
85
+ ParseNfcData(req: ParseNfcDataRequest, cb?: (error: string, rep: ParseNfcDataResponse) => void): Promise<ParseNfcDataResponse>;
86
86
  /**
87
87
  * 每次调用E证通服务前,需先调用本接口获取EidToken,用来串联E证通流程,在验证完成后,用于获取E证通结果信息。
88
88
  */
@@ -123,10 +123,6 @@ export declare class Client extends AbstractClient {
123
123
  * 传入视频和身份信息,先判断视频中是否为真人,判断为真人后,再判断该视频中的人与权威库的证件照是否属于同一个人。
124
124
  */
125
125
  LivenessRecognition(req: LivenessRecognitionRequest, cb?: (error: string, rep: LivenessRecognitionResponse) => void): Promise<LivenessRecognitionResponse>;
126
- /**
127
- * 解析SDK获取到的证件NFC数据,接口传入SDK返回的ReqId,返回证件信息(个别字段为特定证件类型特有)。SDK生成的ReqId五分钟内有效,重复查询仅收一次费。支持身份证类证件(二代身份证、港澳居住证、台湾居住证、外国人永居证)以及旅行类证件(港澳通行证、台湾通行证、台胞证、回乡证)的NFC识别及核验。
128
- */
129
- ParseNfcData(req: ParseNfcDataRequest, cb?: (error: string, rep: ParseNfcDataResponse) => void): Promise<ParseNfcDataResponse>;
130
126
  /**
131
127
  * 传入姓名和身份证号,校验两者的真实性和一致性。
132
128
  */
@@ -136,10 +136,10 @@ class Client extends abstract_client_1.AbstractClient {
136
136
  return this.request("GetFaceIdResult", req, cb);
137
137
  }
138
138
  /**
139
- * 传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人(该接口已停止接入,新客户请使用<a href="https://cloud.tencent.com/document/product/1007/102203">照片人脸核身(V2.0)</a>接口)。
139
+ * 解析SDK获取到的证件NFC数据,接口传入SDK返回的ReqId,返回证件信息(个别字段为特定证件类型特有)。SDK生成的ReqId五分钟内有效,重复查询仅收一次费。支持身份证类证件(二代身份证、港澳居住证、台湾居住证、外国人永居证)以及旅行类证件(港澳通行证、台湾通行证、台胞证、回乡证)的NFC识别及核验。
140
140
  */
141
- async ImageRecognition(req, cb) {
142
- return this.request("ImageRecognition", req, cb);
141
+ async ParseNfcData(req, cb) {
142
+ return this.request("ParseNfcData", req, cb);
143
143
  }
144
144
  /**
145
145
  * 每次调用E证通服务前,需先调用本接口获取EidToken,用来串联E证通流程,在验证完成后,用于获取E证通结果信息。
@@ -201,12 +201,6 @@ class Client extends abstract_client_1.AbstractClient {
201
201
  async LivenessRecognition(req, cb) {
202
202
  return this.request("LivenessRecognition", req, cb);
203
203
  }
204
- /**
205
- * 解析SDK获取到的证件NFC数据,接口传入SDK返回的ReqId,返回证件信息(个别字段为特定证件类型特有)。SDK生成的ReqId五分钟内有效,重复查询仅收一次费。支持身份证类证件(二代身份证、港澳居住证、台湾居住证、外国人永居证)以及旅行类证件(港澳通行证、台湾通行证、台胞证、回乡证)的NFC识别及核验。
206
- */
207
- async ParseNfcData(req, cb) {
208
- return this.request("ParseNfcData", req, cb);
209
- }
210
204
  /**
211
205
  * 传入姓名和身份证号,校验两者的真实性和一致性。
212
206
  */
@@ -2213,27 +2213,6 @@ export interface DetectInfoText {
2213
2213
  */
2214
2214
  LivenessActionSequence?: string;
2215
2215
  }
2216
- /**
2217
- * ImageRecognition返回参数结构体
2218
- */
2219
- export interface ImageRecognitionResponse {
2220
- /**
2221
- * <p>相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一)</p>
2222
- */
2223
- Sim?: number;
2224
- /**
2225
- * <p>业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分</p>
2226
- */
2227
- Result?: string;
2228
- /**
2229
- * <p>业务结果描述。</p>
2230
- */
2231
- Description?: string;
2232
- /**
2233
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2234
- */
2235
- RequestId?: string;
2236
- }
2237
2216
  /**
2238
2217
  * GetDetectInfo返回参数结构体
2239
2218
  */
@@ -2891,31 +2870,6 @@ export interface PhoneVerificationCTCCRequest {
2891
2870
  */
2892
2871
  Encryption?: Encryption;
2893
2872
  }
2894
- /**
2895
- * ImageRecognition请求参数结构体
2896
- */
2897
- export interface ImageRecognitionRequest {
2898
- /**
2899
- * <p>身份证号</p>
2900
- */
2901
- IdCard: string;
2902
- /**
2903
- * <p>姓名。中文请使用UTF-8编码。</p>
2904
- */
2905
- Name: string;
2906
- /**
2907
- * <p>用于人脸比对的照片,图片的Base64值;<br>Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。<br>请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。</p>
2908
- */
2909
- ImageBase64: string;
2910
- /**
2911
- * <p>本接口不需要传递此参数。</p>
2912
- */
2913
- Optional?: string;
2914
- /**
2915
- * <p>敏感数据加密信息。对传入信息(姓名、身份证号)有加密需求的用户可使用此参数,详情请点击左侧链接。</p>
2916
- */
2917
- Encryption?: Encryption;
2918
- }
2919
2873
  /**
2920
2874
  * BankCard4EVerification请求参数结构体
2921
2875
  */
@@ -663,11 +663,11 @@ export interface ModifyGlobalAcceleratorAccessLogRequest {
663
663
  */
664
664
  export interface DescribeListenersResponse {
665
665
  /**
666
- * 符合条件的监听器实例。
666
+ * <p>符合条件的监听器实例。</p>
667
667
  */
668
668
  ListenerSet?: Array<ListenerSet>;
669
669
  /**
670
- * 符合条件的实例个数。
670
+ * <p>符合条件的实例个数。</p>
671
671
  */
672
672
  TotalCount?: number;
673
673
  /**
@@ -2308,19 +2308,19 @@ export interface CreateGlobalAcceleratorResponse {
2308
2308
  */
2309
2309
  export interface DescribeListenersRequest {
2310
2310
  /**
2311
- * 全球加速实例ID
2311
+ * <p>全球加速实例ID。</p>
2312
2312
  */
2313
2313
  GlobalAcceleratorId: string;
2314
2314
  /**
2315
- * 偏移量,默认为0
2315
+ * <p>偏移量,默认为0。</p>
2316
2316
  */
2317
2317
  Offset?: number;
2318
2318
  /**
2319
- * 返回数量,默认为20,最大值为100。
2319
+ * <p>返回数量。</p><p>取值范围:[1, 200]</p><p>默认值:20</p>
2320
2320
  */
2321
2321
  Limit?: number;
2322
2322
  /**
2323
- * 过滤条件。 listener-id- String -(过滤条件)监听器实例ID
2323
+ * <p>过滤条件。 listener-id- String -(过滤条件)监听器实例ID。</p>
2324
2324
  */
2325
2325
  Filters?: Array<Filter>;
2326
2326
  }