tencentcloud-sdk-nodejs 4.1.328 → 4.1.330

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 (56) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/cynosdb/v20190107/cynosdb_client.js +13 -7
  3. package/es/services/fwm/v20250611/fwm_client.js +28 -4
  4. package/es/services/ioa/v20220601/ioa_client.js +25 -4
  5. package/es/services/iotexplorer/v20190423/iotexplorer_client.js +14 -2
  6. package/es/services/organization/v20210331/organization_client.js +14 -2
  7. package/es/services/tcb/v20180608/tcb_client.js +3 -0
  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/ai3d/v20250513/ai3d_client.d.ts +6 -2
  12. package/tencentcloud/services/ai3d/v20250513/ai3d_client.js +6 -2
  13. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +78 -140
  14. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +14 -6
  15. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +1 -1
  16. package/tencentcloud/services/clb/v20180317/clb_client.js +1 -1
  17. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +8 -0
  18. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  19. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +107 -38
  20. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +17 -9
  21. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +24 -12
  22. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +88 -23
  23. package/tencentcloud/services/databuddy/v20260715/databuddy_models.d.ts +16 -8
  24. package/tencentcloud/services/dc/v20180410/dc_models.d.ts +53 -34
  25. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +4 -0
  26. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +12 -53
  27. package/tencentcloud/services/fwm/v20250611/fwm_client.d.ts +37 -5
  28. package/tencentcloud/services/fwm/v20250611/fwm_client.js +54 -6
  29. package/tencentcloud/services/fwm/v20250611/fwm_models.d.ts +406 -91
  30. package/tencentcloud/services/ga2/v20250115/ga2_models.d.ts +1 -1
  31. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +6 -2
  32. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +5 -20
  33. package/tencentcloud/services/ioa/v20220601/ioa_client.d.ts +33 -5
  34. package/tencentcloud/services/ioa/v20220601/ioa_client.js +48 -6
  35. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +456 -114
  36. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +19 -3
  37. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +27 -3
  38. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +254 -21
  39. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +36 -24
  40. package/tencentcloud/services/kms/v20190118/kms_models.d.ts +8 -0
  41. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +7 -7
  42. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +19 -3
  43. package/tencentcloud/services/organization/v20210331/organization_client.js +27 -3
  44. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +434 -196
  45. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +5 -1
  46. package/tencentcloud/services/tcb/v20180608/tcb_client.js +6 -0
  47. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +65 -22
  48. package/tencentcloud/services/tds/v20220801/tds_models.d.ts +2 -2
  49. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +15 -7
  50. package/tencentcloud/services/teo/v20220901/teo_client.js +15 -7
  51. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +53 -18
  52. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +4 -0
  53. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +11 -1
  54. package/tencentcloud/services/waf/v20180125/waf_client.js +11 -1
  55. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +591 -58
  56. package/tencentcloud/services/workbuddyenterprise/v20260709/workbuddyenterprise_models.d.ts +5 -1
@@ -1199,6 +1199,15 @@ export interface DescribeClusterDetailRequest {
1199
1199
  */
1200
1200
  ClusterId: string;
1201
1201
  }
1202
+ /**
1203
+ * RestartLibraDBInstance请求参数结构体
1204
+ */
1205
+ export interface RestartLibraDBInstanceRequest {
1206
+ /**
1207
+ * 只读分析引擎实例 ID
1208
+ */
1209
+ InstanceId: string;
1210
+ }
1202
1211
  /**
1203
1212
  * CopyBackupToVault返回参数结构体
1204
1213
  */
@@ -4384,7 +4393,7 @@ export interface ModifyProxyRwSplitRequest {
4384
4393
  */
4385
4394
  ConsistencyType?: string;
4386
4395
  /**
4387
- * <p>一致性超时时间。<br>取值范围:0~1000000(微秒),设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待。</p>
4396
+ * <p>一致性超时时间。取值范围:0~1000000(毫秒),设置0则表示若只读实例出现延迟, 导致一致性策略不满足, 请求将一直等待。</p>
4388
4397
  */
4389
4398
  ConsistencyTimeOut?: string;
4390
4399
  /**
@@ -5903,13 +5912,34 @@ export interface DescribeInstanceDetailResponse {
5903
5912
  RequestId?: string;
5904
5913
  }
5905
5914
  /**
5906
- * RestartLibraDBInstance请求参数结构体
5915
+ * 数据库代理规格
5907
5916
  */
5908
- export interface RestartLibraDBInstanceRequest {
5917
+ export interface ProxyZoneStockInfo {
5909
5918
  /**
5910
- * 只读分析引擎实例 ID
5919
+ * <p>地域</p>
5911
5920
  */
5912
- InstanceId: string;
5921
+ Region?: string;
5922
+ /**
5923
+ * <p>可用区</p>
5924
+ */
5925
+ Zone?: string;
5926
+ /**
5927
+ * <p>CPU库存</p><p>该字段不作为发货是否有资源的判断标准,资源请参考CheckProxyStockInfos</p>
5928
+ */
5929
+ CpuStock?: number;
5930
+ /**
5931
+ * <p>内存库存</p><p>该字段不作为发货是否有资源的判断标准,资源请参考CheckProxyStockInfos</p>
5932
+ */
5933
+ MemStock?: number;
5934
+ }
5935
+ /**
5936
+ * GrantAccountPrivileges返回参数结构体
5937
+ */
5938
+ export interface GrantAccountPrivilegesResponse {
5939
+ /**
5940
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5941
+ */
5942
+ RequestId?: string;
5913
5943
  }
5914
5944
  /**
5915
5945
  * DeleteAccounts返回参数结构体
@@ -6492,6 +6522,15 @@ export interface InstanceAuditStatus {
6492
6522
  */
6493
6523
  DeliverSummary?: Array<DeliverSummary>;
6494
6524
  }
6525
+ /**
6526
+ * CancelTask请求参数结构体
6527
+ */
6528
+ export interface CancelTaskRequest {
6529
+ /**
6530
+ * <p>任务ID</p>
6531
+ */
6532
+ TaskId: number;
6533
+ }
6495
6534
  /**
6496
6535
  * CopyClusterPasswordComplexity请求参数结构体
6497
6536
  */
@@ -6956,9 +6995,22 @@ export interface DescribeLibraDBClusterDetailResponse {
6956
6995
  RequestId?: string;
6957
6996
  }
6958
6997
  /**
6959
- * GrantAccountPrivileges返回参数结构体
6998
+ * CancelTask返回参数结构体
6960
6999
  */
6961
- export interface GrantAccountPrivilegesResponse {
7000
+ export interface CancelTaskResponse {
7001
+ /**
7002
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7003
+ */
7004
+ RequestId?: string;
7005
+ }
7006
+ /**
7007
+ * DescribeProxyZoneStocks返回参数结构体
7008
+ */
7009
+ export interface DescribeProxyZoneStocksResponse {
7010
+ /**
7011
+ * <p>数据库代理地域库存列表</p>
7012
+ */
7013
+ ProxyZoneStockInfos?: Array<ProxyZoneStockInfo>;
6962
7014
  /**
6963
7015
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6964
7016
  */
@@ -12999,6 +13051,15 @@ export interface ModifyLibraDBClusterAccountPrivilegeRequest {
12999
13051
  */
13000
13052
  TablePrivileges?: Array<TablePrivileges>;
13001
13053
  }
13054
+ /**
13055
+ * DescribeProxyZoneStocks请求参数结构体
13056
+ */
13057
+ export interface DescribeProxyZoneStocksRequest {
13058
+ /**
13059
+ * <p>可用区</p>
13060
+ */
13061
+ Zone: string;
13062
+ }
13002
13063
  /**
13003
13064
  * DescribeDBSecurityGroups返回参数结构体
13004
13065
  */
@@ -13123,23 +13184,33 @@ export interface ClusterInstanceDetail {
13123
13184
  * <p>引擎类型</p>
13124
13185
  */
13125
13186
  InstanceType?: string;
13187
+ /**
13188
+ * <p>实例状态</p><p>枚举值:</p><ul><li>creating: 创建中</li><li>running: 运行中</li><li>isolating: 隔离中</li><li>isolated: 已隔离</li><li>activating: 恢复中</li><li>offlining: 下线中</li><li>offlined: 已下线</li></ul>
13189
+ */
13190
+ Status?: string;
13126
13191
  /**
13127
13192
  * <p>实例状态</p>
13193
+ * @deprecated
13128
13194
  */
13129
13195
  InstanceStatus?: string;
13130
13196
  /**
13131
- * <p>实例状态描述</p>
13197
+ * <p>实例状态中文描述</p>
13132
13198
  */
13133
- InstanceStatusDesc?: string;
13199
+ StatusDesc?: string;
13134
13200
  /**
13135
- * <p>cpu核数</p>
13201
+ * <p>实例状态描述</p>
13136
13202
  * @deprecated
13137
13203
  */
13138
- InstanceCpu?: number;
13204
+ InstanceStatusDesc?: string;
13139
13205
  /**
13140
13206
  * <p>Cpu</p><p>单位:核</p>
13141
13207
  */
13142
13208
  Cpu?: number;
13209
+ /**
13210
+ * <p>cpu核数</p>
13211
+ * @deprecated
13212
+ */
13213
+ InstanceCpu?: number;
13143
13214
  /**
13144
13215
  * <p>serverless实例cpu下限</p><p>单位:核</p>
13145
13216
  */
@@ -13154,6 +13225,7 @@ export interface ClusterInstanceDetail {
13154
13225
  Memory?: number;
13155
13226
  /**
13156
13227
  * <p>内存</p>
13228
+ * @deprecated
13157
13229
  */
13158
13230
  InstanceMemory?: number;
13159
13231
  /**
@@ -13180,8 +13252,13 @@ export interface ClusterInstanceDetail {
13180
13252
  * <p>实例任务信息</p>
13181
13253
  */
13182
13254
  InstanceTasks?: Array<ObjectTask>;
13255
+ /**
13256
+ * <p>实例机器类型</p><p>枚举值:</p><ul><li>common: 通用型</li><li>exclusive: 独享型</li></ul>
13257
+ */
13258
+ DeviceType?: string;
13183
13259
  /**
13184
13260
  * <p>实例机器类型</p><ol><li>common,通用型。</li><li>exclusive,独享型。</li></ol>
13261
+ * @deprecated
13185
13262
  */
13186
13263
  InstanceDeviceType?: string;
13187
13264
  /**
@@ -13220,14 +13297,6 @@ export interface ClusterInstanceDetail {
13220
13297
  * <p>实例所在的物理可用区</p>
13221
13298
  */
13222
13299
  PhysicalZone?: string;
13223
- /**
13224
- * <p>实例状态</p><p>枚举值:</p><ul><li>creating: 创建中</li><li>running: 运行中</li><li>isolating: 隔离中</li><li>isolated: 已隔离</li><li>activating: 恢复中</li><li>offlining: 下线中</li><li>offlined: 已下线</li></ul>
13225
- */
13226
- Status?: string;
13227
- /**
13228
- * <p>实例状态中文描述</p>
13229
- */
13230
- StatusDesc?: string;
13231
13300
  /**
13232
13301
  * <p>数据库类型</p>
13233
13302
  */
@@ -13341,10 +13410,6 @@ export interface ClusterInstanceDetail {
13341
13410
  * <p>当前实例支持的能力</p>
13342
13411
  */
13343
13412
  InstanceAbility?: InstanceAbility;
13344
- /**
13345
- * <p>实例机器类型</p><p>枚举值:</p><ul><li>common: 通用型</li><li>exclusive: 独享型</li></ul>
13346
- */
13347
- DeviceType?: string;
13348
13413
  /**
13349
13414
  * <p>全球数据库唯一标识</p>
13350
13415
  */
@@ -3424,14 +3424,18 @@ export interface ListTablesResponse {
3424
3424
  * StopCompute请求参数结构体
3425
3425
  */
3426
3426
  export interface StopComputeRequest {
3427
- /**
3428
- * 计算资源 ID
3429
- */
3430
- ResourceId: string;
3431
3427
  /**
3432
3428
  * 工作空间 ID
3433
3429
  */
3434
3430
  WorkspaceId: string;
3431
+ /**
3432
+ * 计算资源 ID,可通过 ListComputes 接口获取(返回字段 Items[].BasicInfo.ResourceId)。替代已废弃的 ResourceId;过渡期 ComputeResourceId 与 ResourceId 至少传一个,同时传时必须一致
3433
+ */
3434
+ ComputeResourceId?: string;
3435
+ /**
3436
+ * [已废弃,请使用 ComputeResourceId] 计算资源 ID,可通过 ListComputes 接口获取(返回字段 Items[].BasicInfo.ResourceId)
3437
+ */
3438
+ ResourceId?: string;
3435
3439
  }
3436
3440
  /**
3437
3441
  * KillWorkflowRun请求参数结构体
@@ -6320,14 +6324,18 @@ export interface DeleteTableRsp {
6320
6324
  * StartCompute请求参数结构体
6321
6325
  */
6322
6326
  export interface StartComputeRequest {
6323
- /**
6324
- * 计算资源 ID
6325
- */
6326
- ResourceId: string;
6327
6327
  /**
6328
6328
  * 工作空间 ID
6329
6329
  */
6330
6330
  WorkspaceId: string;
6331
+ /**
6332
+ * 计算资源 ID,可通过 ListComputes 接口获取(返回字段 Items[].BasicInfo.ResourceId)。替代已废弃的 ResourceId;过渡期 ComputeResourceId 与 ResourceId 至少传一个,同时传时必须一致
6333
+ */
6334
+ ComputeResourceId?: string;
6335
+ /**
6336
+ * [已废弃,请使用 ComputeResourceId] 计算资源 ID,可通过 ListComputes 接口获取(返回字段 Items[].BasicInfo.ResourceId)
6337
+ */
6338
+ ResourceId?: string;
6331
6339
  }
6332
6340
  /**
6333
6341
  * UpdateConsoleUsers请求参数结构体
@@ -1399,114 +1399,129 @@ export interface DescribeDirectConnectTunnelsResponse {
1399
1399
  */
1400
1400
  export interface CloudAttachInfo {
1401
1401
  /**
1402
- * 敏捷上云实例id
1402
+ * <p>敏捷上云实例id</p>
1403
1403
  */
1404
1404
  InstanceId?: string;
1405
1405
  /**
1406
- * 敏捷上云名称
1406
+ * <p>敏捷上云名称</p>
1407
1407
  */
1408
1408
  Name?: string;
1409
1409
  /**
1410
- * 合作伙伴的AppId
1410
+ * <p>合作伙伴的AppId</p>
1411
1411
  */
1412
1412
  IapId?: string;
1413
1413
  /**
1414
- * 需要接入敏捷上云的IDC的地址
1414
+ * <p>需要接入敏捷上云的IDC的地址</p>
1415
1415
  */
1416
1416
  IdcAddress?: string;
1417
1417
  /**
1418
- * 需要接入敏捷上云的IDC的互联网服务提供商类型
1418
+ * <p>需要接入敏捷上云的IDC的互联网服务提供商类型</p>
1419
1419
  */
1420
1420
  IdcType?: string;
1421
1421
  /**
1422
- * 敏捷上云的带宽,单位为MB
1422
+ * <p>敏捷上云的带宽,单位为MB</p>
1423
1423
  */
1424
1424
  Bandwidth?: number;
1425
1425
  /**
1426
- * 联系电话
1426
+ * <p>联系电话</p>
1427
1427
  */
1428
1428
  Telephone?: string;
1429
1429
  /**
1430
- * 敏捷上云的状态
1431
- available:就绪状态
1432
- applying:申请,待审核状态
1433
- pendingpay:代付款状态
1434
- building:建设中状态
1435
- confirming:待确认状态
1436
- isolate: 隔离状态
1437
- stoped:终止状态
1430
+ * <p>敏捷上云的状态<br>available:就绪状态<br>applying:申请,待审核状态<br>pendingpay:代付款状态<br>building:建设中状态<br>confirming:待确认状态<br>isolate: 隔离状态<br>stoped:终止状态</p>
1438
1431
  */
1439
1432
  Status?: string;
1440
1433
  /**
1441
- * 敏捷上云申请的时间
1434
+ * <p>敏捷上云申请的时间</p>
1442
1435
  */
1443
1436
  ApplyTime?: string;
1444
1437
  /**
1445
- * 敏捷上云建设完成的时间
1438
+ * <p>敏捷上云建设完成的时间</p>
1446
1439
  */
1447
1440
  ReadyTime?: string;
1448
1441
  /**
1449
- * 敏捷上云过期时间
1442
+ * <p>敏捷上云过期时间</p>
1450
1443
  */
1451
1444
  ExpireTime?: string;
1452
1445
  /**
1453
- * 备注信息
1446
+ * <p>备注信息</p>
1454
1447
  */
1455
1448
  Remarks?: string;
1456
1449
  /**
1457
- * 敏捷上云的地域状态。
1458
- same-region:同地域
1459
- cross-region:跨地域
1450
+ * <p>敏捷上云的地域状态。<br>same-region:同地域<br>cross-region:跨地域</p>
1460
1451
  */
1461
1452
  RegionStatus?: string;
1462
1453
  /**
1463
- * 用户的AppId
1454
+ * <p>用户的AppId</p>
1464
1455
  */
1465
1456
  AppId?: string;
1466
1457
  /**
1467
- * 用户的Uin
1458
+ * <p>用户的Uin</p>
1468
1459
  */
1469
1460
  Uin?: string;
1470
1461
  /**
1471
- * 用户注册名称
1462
+ * <p>用户注册名称</p>
1472
1463
  */
1473
1464
  CustomerAuthName?: string;
1474
1465
  /**
1475
- * 物理专线实例ID
1466
+ * <p>物理专线实例ID</p>
1476
1467
  */
1477
1468
  DirectConnectId?: string;
1478
1469
  /**
1479
- * 敏捷上云是否支持创建高速上云专线网关
1470
+ * <p>敏捷上云是否支持创建高速上云专线网关</p>
1480
1471
  */
1481
1472
  CloudAttachServiceGatewaysSupport?: boolean;
1482
1473
  /**
1483
- * 敏捷上云服务是否处于升降配中
1474
+ * <p>敏捷上云服务是否处于升降配中</p>
1484
1475
  */
1485
1476
  BUpdateBandwidth?: boolean;
1486
1477
  /**
1487
- * 接入地域
1478
+ * <p>接入地域</p>
1488
1479
  */
1489
1480
  ArRegion?: string;
1490
1481
  /**
1491
- * 运营商代码
1482
+ * <p>运营商代码</p>
1492
1483
  */
1493
1484
  IapCode?: string;
1494
1485
  /**
1495
- * IDC侧类型。枚举值:CLOUD-云,ISP-运营商,OTHER-第三方
1486
+ * <p>IDC侧类型。枚举值:CLOUD-云,ISP-运营商,OTHER-第三方</p>
1496
1487
  */
1497
1488
  IdcPointType?: string;
1498
1489
  /**
1499
- * 运营商链路是否有保护
1490
+ * <p>运营商链路是否有保护</p>
1500
1491
  */
1501
1492
  BIapLinkProtected?: boolean;
1502
1493
  /**
1503
- * 服务类型:SHARE-共享型,EXCLUSIVE-独占型
1494
+ * <p>服务类型:SHARE-共享型,EXCLUSIVE-独占型</p>
1504
1495
  */
1505
1496
  ServiceType?: string;
1506
1497
  /**
1507
- * VLAN范围
1498
+ * <p>VLAN范围</p>
1508
1499
  */
1509
1500
  VlanRange?: string;
1501
+ /**
1502
+ * <p>裁撤状态</p><p>枚举值:</p><ul><li>APPLYING: 申请裁撤</li><li>EXECUTING: 裁撤执行中</li><li>FAILED: 裁撤失败</li></ul>
1503
+ */
1504
+ RepealStatus?: string;
1505
+ /**
1506
+ * <p>计划裁撤时间</p>
1507
+ */
1508
+ PlanRepealTime?: string;
1509
+ /**
1510
+ * <p>续费标记</p><p>枚举值:</p><ul><li>MANUAL_RENEW: 手动续费</li><li>AUTO_RENEW: 自动续费</li><li>NO_RENEW: 到期不续</li></ul>
1511
+ */
1512
+ RenewFlag?: string;
1513
+ /**
1514
+ * <p>接入点ID</p>
1515
+ */
1516
+ AccessPointId?: string;
1517
+ /**
1518
+ * <p>接入点名称</p>
1519
+ */
1520
+ AccessPointName?: string;
1521
+ /**
1522
+ * <p>计费阶梯带宽(Mbps)</p>
1523
+ */
1524
+ BillStairBandwidth?: number;
1510
1525
  }
1511
1526
  /**
1512
1527
  * 用户侧网段地址
@@ -1675,6 +1690,10 @@ export interface CreateCasInput {
1675
1690
  * <p>服务类型,SHARE-共享型,EXCLUSIVE-独占型</p>
1676
1691
  */
1677
1692
  ServiceType?: string;
1693
+ /**
1694
+ * <p>接入点ID</p>
1695
+ */
1696
+ AccessPointId?: string;
1678
1697
  }
1679
1698
  /**
1680
1699
  * 专用通道信息列表
@@ -11449,6 +11449,10 @@ export interface CreateCloudInstanceRequest {
11449
11449
  * <p>airflow源凭证</p>
11450
11450
  */
11451
11451
  AirflowGitCredential?: AirflowGitCredentialInput;
11452
+ /**
11453
+ * <p>多安全组绑定</p>
11454
+ */
11455
+ SgIds?: Array<string>;
11452
11456
  }
11453
11457
  /**
11454
11458
  * 资源详情
@@ -6921,60 +6921,39 @@ export interface RiskIdentificationRoleInfo {
6921
6921
  */
6922
6922
  export interface CreateUserVerifyUrlRequest {
6923
6923
  /**
6924
- * 操作人信息
6924
+ * <p>操作人信息</p>
6925
6925
  */
6926
6926
  Operator: UserInfo;
6927
6927
  /**
6928
- * 要实名的姓名
6928
+ * <p>要实名的姓名</p>
6929
6929
  */
6930
6930
  Name?: string;
6931
6931
  /**
6932
- * 要实名的身份证号码,
6933
- 身份证号码如果有x的话,统一传大写X
6932
+ * <p>要实名的身份证号码,<br>身份证号码如果有x的话,统一传大写X</p>
6934
6933
  */
6935
6934
  IdCardNumber?: string;
6936
6935
  /**
6937
- * 证件类型,目前只支持身份证类型:ID_CARD
6936
+ * <p>证件类型,支持以下类型,样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a></p><ul><li>ID_CARD 中国大陆居民身份证 (默认值)</li><li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li><li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li></ul><p>注: 港澳居民来往内地通行证 和 港澳台居民居住证 类型的签署人<b>至少要过一次大陆的海关</b>才能使用。</p>
6938
6937
  */
6939
6938
  IdCardType?: string;
6940
6939
  /**
6941
- * 要实名的手机号,兼容带+86的格式
6940
+ * <p>要实名的手机号,兼容带+86的格式</p>
6942
6941
  */
6943
6942
  Mobile?: string;
6944
6943
  /**
6945
- * 实名完之后的跳转链接,最大长度1000个字符。
6946
- 链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。
6947
-
6948
- 注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递
6949
-
6944
+ * <p>实名完之后的跳转链接,最大长度1000个字符。<br>链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>。</p><p>注:此参数仅支持 Endpoint 为 <font color="red">H5 或 H5_SHORT_URL </font>的时候传递</p>
6950
6945
  */
6951
6946
  JumpUrl?: string;
6952
6947
  /**
6953
- * 要跳转的链接类型
6954
-
6955
- <ul>
6956
- <li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
6957
- <li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
6958
- <li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li>
6959
- <li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li>
6960
- <li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li>
6961
- </ul>
6962
-
6963
- 注:如果不传递,默认值是 <font color="red"> APP </font>
6948
+ * <p>要跳转的链接类型</p><ul><li><strong>HTTP</strong>:适用于短信通知或H5跳转的电子签小程序HTTP长链接</li><li><strong>HTTP_SHORT_URL</strong>:适用于短信通知或H5跳转的电子签小程序HTTP短链接</li><li><strong>APP</strong>:(默认类型)适用于第三方APP或小程序跳转的电子签小程序路径</li><li><strong>H5</strong>:适用于跳转至电子签H5实名页面的长链接</li><li><strong>H5_SHORT_URL</strong>:适用于跳转至电子签H5实名页面的短链接</li></ul><p>注:如果不传递,默认值是 <font color="red"> APP </font></p>
6964
6949
  */
6965
6950
  Endpoint?: string;
6966
6951
  /**
6967
- * 签署完成后是否自动回跳
6968
- <ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul>
6969
-
6970
- 注:
6971
- 1. 该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效
6972
- 2. <font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考[这个](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object)
6973
- 3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
6952
+ * <p>签署完成后是否自动回跳</p><ul><li>false:否, 实名完成不会自动跳转回来(默认)</li><li>true:是, 实名完成会自动跳转回来</li></ul><p>注: </p><ol><li>该参数<font color="red">只针对APP类型(第三方APP或小程序跳转电子签小程序)场景</font> 的实名链接有效</li><li><font color="red">手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑</font>, 微信小程序的文档可以参考<a href="https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onShow-Object-object">这个</a></li><li><font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font></li></ol>
6974
6953
  */
6975
6954
  AutoJumpBack?: boolean;
6976
6955
  /**
6977
- * 在用户完成实名认证后,其自定义数据将通过[企业引导个人实名认证后回调](https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83)返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。
6956
+ * <p>在用户完成实名认证后,其自定义数据将通过<a href="https://qian.tencent.com/developers/company/callback_types_staffs/#%E5%8D%81%E4%BA%8C-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81%E5%90%8E%E5%9B%9E%E8%B0%83">企业引导个人实名认证后回调</a>返回,以便用户确认其个人数据信息。请注意,自定义数据的字符长度上限为1000,且必须采用base64编码格式。</p>
6978
6957
  */
6979
6958
  UserData?: string;
6980
6959
  }
@@ -9099,35 +9078,15 @@ export interface CreateEmployeeQualificationSealQrCodeResponse {
9099
9078
  */
9100
9079
  export interface CreateUserVerifyUrlResponse {
9101
9080
  /**
9102
- * 腾讯电子签小程序的实名认证链接。
9103
- 如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。
9104
-
9105
- <strong>1.如果EndPoint是APP</strong>:
9106
- 得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
9107
-
9108
- <strong>2.如果EndPoint是HTTP</strong>:
9109
- 得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署
9110
-
9111
- <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:
9112
- 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署
9113
-
9114
- <strong>4.如果EndPoint是H5</strong>:
9115
- 得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU****VJhsS5q&CodeType=xxx&shortKey=yD*****frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署
9116
-
9117
- <strong>5.如果EndPoint是H5_SHORT_URL</strong>:
9118
- 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署
9119
-
9120
-
9121
- `注:` <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font>
9122
- 示例值:https://essurl.cn/2n**42Nd
9081
+ * <p>腾讯电子签小程序的实名认证链接。<br>如果没有传递,默认值是 HTTP。 链接的有效期均是 7 天。</p><p><strong>1.如果EndPoint是APP</strong>:<br>得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&amp;shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的&quot;跳转到小程序的实现&quot;</p><p><strong>2.如果EndPoint是HTTP</strong>:<br>得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&amp;shortKey=yDCZHUyOcChrfpaswT0d</a>,点击后会跳转到腾讯电子签小程序进行签署</p><p><strong>3.如果EndPoint是HTTP_SHORT_URL</strong>:<br>得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签小程序进行签署</p><p><strong>4.如果EndPoint是H5</strong>:<br>得到的链接类似于 <a href="">https://quick.test.qian.tencent.cn/guide?Code=yDU<strong><strong>VJhsS5q&amp;CodeType=xxx&amp;shortKey=yD*</strong></strong>frcb</a>,点击后会跳转到腾讯电子签H5页面进行签署</p><p><strong>5.如果EndPoint是H5_SHORT_URL</strong>:<br>得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>,点击后会跳转到腾讯电子签H5页面进行签署</p><p><code>注:</code> <font color="red">生成的链路后面不能再增加参数,防止出错重复参数覆盖原有的参数</font><br>示例值:https://essurl.cn/2n**42Nd</p>
9123
9082
  */
9124
9083
  UserVerifyUrl?: string;
9125
9084
  /**
9126
- * 链接过期时间,为Unix时间戳(单位为秒)。
9085
+ * <p>链接过期时间,为Unix时间戳(单位为秒)。</p>
9127
9086
  */
9128
9087
  ExpireTime?: number;
9129
9088
  /**
9130
- * 小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回
9089
+ * <p>小程序appid,用于半屏拉起电子签小程序, 仅在 Endpoint 设置为 APP 的时候返回</p>
9131
9090
  */
9132
9091
  MiniAppId?: string;
9133
9092
  /**