tencentcloud-sdk-nodejs 4.0.760 → 4.0.762

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 (82) hide show
  1. package/CHANGELOG.md +351 -0
  2. package/SERVICE_CHANGELOG.md +330 -192
  3. package/package.json +1 -1
  4. package/products.md +27 -27
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_models.ts +22 -19
  7. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +11 -0
  8. package/src/services/cfw/v20190904/cfw_client.ts +2 -3
  9. package/src/services/cfw/v20190904/cfw_models.ts +32 -4
  10. package/src/services/ckafka/v20190819/ckafka_client.ts +1 -1
  11. package/src/services/ckafka/v20190819/ckafka_models.ts +1 -1
  12. package/src/services/cls/v20201016/cls_models.ts +106 -43
  13. package/src/services/csip/v20221121/csip_models.ts +20 -0
  14. package/src/services/dts/v20211206/dts_models.ts +13 -13
  15. package/src/services/ecm/v20190719/ecm_models.ts +17 -17
  16. package/src/services/emr/v20190103/emr_models.ts +18 -12
  17. package/src/services/ess/v20201111/ess_client.ts +28 -8
  18. package/src/services/ess/v20201111/ess_models.ts +11 -6
  19. package/src/services/essbasic/v20210526/essbasic_client.ts +19 -0
  20. package/src/services/essbasic/v20210526/essbasic_models.ts +23 -14
  21. package/src/services/lighthouse/v20200324/lighthouse_models.ts +18 -12
  22. package/src/services/live/v20180801/live_models.ts +13 -12
  23. package/src/services/monitor/v20180724/monitor_models.ts +5 -0
  24. package/src/services/oceanus/v20190422/oceanus_client.ts +23 -10
  25. package/src/services/oceanus/v20190422/oceanus_models.ts +147 -59
  26. package/src/services/redis/v20180412/redis_models.ts +1 -1
  27. package/src/services/ssl/v20191205/ssl_models.ts +22 -2
  28. package/src/services/tat/v20201028/tat_models.ts +1 -1
  29. package/src/services/tdmq/v20200217/tdmq_models.ts +20 -10
  30. package/src/services/tem/v20210701/tem_client.ts +1 -1
  31. package/src/services/tem/v20210701/tem_models.ts +1 -1
  32. package/src/services/teo/v20220901/teo_models.ts +2 -2
  33. package/src/services/tione/v20211111/tione_client.ts +25 -11
  34. package/src/services/tione/v20211111/tione_models.ts +223 -21
  35. package/src/services/tse/v20201207/tse_models.ts +2 -2
  36. package/src/services/wedata/v20210820/wedata_client.ts +26 -14
  37. package/src/services/wedata/v20210820/wedata_models.ts +64 -4
  38. package/tencentcloud/common/sdk_version.d.ts +1 -1
  39. package/tencentcloud/common/sdk_version.js +1 -1
  40. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +22 -19
  41. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +11 -0
  42. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +0 -1
  43. package/tencentcloud/services/cfw/v20190904/cfw_client.js +0 -1
  44. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +32 -4
  45. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +1 -1
  46. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +1 -1
  47. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +1 -1
  48. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +106 -43
  49. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +20 -0
  50. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +13 -13
  51. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +17 -17
  52. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +18 -12
  53. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +28 -8
  54. package/tencentcloud/services/ess/v20201111/ess_client.js +28 -8
  55. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +11 -6
  56. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +19 -0
  57. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +19 -0
  58. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +23 -14
  59. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +18 -12
  60. package/tencentcloud/services/live/v20180801/live_models.d.ts +13 -12
  61. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +5 -0
  62. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +7 -3
  63. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +9 -3
  64. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +143 -58
  65. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +1 -1
  66. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +22 -2
  67. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +1 -1
  68. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +20 -10
  69. package/tencentcloud/services/tem/v20210701/tem_client.d.ts +1 -1
  70. package/tencentcloud/services/tem/v20210701/tem_client.js +1 -1
  71. package/tencentcloud/services/tem/v20210701/tem_models.d.ts +1 -1
  72. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +2 -2
  73. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +7 -3
  74. package/tencentcloud/services/tione/v20211111/tione_client.js +9 -3
  75. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +219 -21
  76. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
  77. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +10 -6
  78. package/tencentcloud/services/wedata/v20210820/wedata_client.js +13 -7
  79. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +62 -4
  80. package/test/oceanus.v20190422.test.js +12 -2
  81. package/test/tione.v20211111.test.js +12 -2
  82. package/test/wedata.v20210820.test.js +14 -4
@@ -1912,7 +1912,7 @@ export interface ChannelCreateFlowByFilesRequest {
1912
1912
  CcNotifyType?: number;
1913
1913
  /**
1914
1914
  * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
1915
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
1915
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
1916
1916
  注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
1917
1917
  */
1918
1918
  AutoSignScene?: string;
@@ -3054,9 +3054,9 @@ export interface CreateConsoleLoginUrlRequest {
3054
3054
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3055
3055
  <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
3056
3056
  </ul>注:
3057
- `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识, 建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
3058
- `2. 员工认证时, 此时的Agent.ProxyOrganizationOpenId将会是员工认证加入企业后的唯一标识, 建议开发者保存此员工的penId, 后续各项接口调用皆需要此参数。 `
3059
- `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一, 员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)`
3057
+ `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识,建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
3058
+ `2. 员工认证时, 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识,建议开发者保存此员工的OpenId,后续各项接口调用皆需要此参数。 `
3059
+ `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一,员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)`
3060
3060
  */
3061
3061
  Agent: Agent;
3062
3062
  /**
@@ -3622,6 +3622,14 @@ export interface FlowGroupOptions {
3622
3622
  export interface ChannelDescribeOrganizationSealsRequest {
3623
3623
  /**
3624
3624
  * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3625
+
3626
+ 此接口下面信息必填。
3627
+ <ul>
3628
+ <li>渠道应用标识: Agent.AppId</li>
3629
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3630
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3631
+ </ul>
3632
+ 第三方平台子客企业和员工必须已经经过实名认证
3625
3633
  */
3626
3634
  Agent: Agent;
3627
3635
  /**
@@ -3647,11 +3655,12 @@ export interface ChannelDescribeOrganizationSealsRequest {
3647
3655
  */
3648
3656
  SealId?: string;
3649
3657
  /**
3650
- * 印章类型列表,目前支持传入以下类型:
3651
- <ul><li>OFFICIAL-企业公章</li>
3652
- <li>CONTRACT-合同专用章</li>
3653
- <li>ORGANIZATION_SEAL-企业印章(图片上传创建)</li>
3654
- <li>LEGAL_PERSON_SEAL-法定代表人章</li>
3658
+ * 电子印章类型 , 可选类型如下:
3659
+ <ul><li>**OFFICIAL**: (默认)公章</li>
3660
+ <li>**CONTRACT**: 合同专用章;</li>
3661
+ <li>**FINANCE**: 财务专用章;</li>
3662
+ <li>**PERSONNEL**: 人事专用章</li>
3663
+ <li>**INVOICE**: 发票专用章</li>
3655
3664
  </ul>
3656
3665
 
3657
3666
  注: `为空时查询所有类型的印章。`
@@ -3865,7 +3874,7 @@ export interface FlowInfo {
3865
3874
  CcNotifyType?: number;
3866
3875
  /**
3867
3876
  * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
3868
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
3877
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul>
3869
3878
  注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
3870
3879
  */
3871
3880
  AutoSignScene?: string;
@@ -4080,7 +4089,7 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
4080
4089
  */
4081
4090
  ApproverSignTypes?: Array<number | bigint>;
4082
4091
  /**
4083
- * 生成H5签署链接时,你可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4092
+ * 生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4084
4093
  <ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
4085
4094
  <li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
4086
4095
  注:
@@ -4415,7 +4424,7 @@ export interface RegistrationOrganizationInfo {
4415
4424
  /**
4416
4425
  * 组织机构超管姓名。
4417
4426
  在注册流程中,必须是超管本人进行操作。
4418
- 如果法人做为超管管理组织机构,超管姓名就是法人姓名
4427
+ 如果法人作为超管管理组织机构,超管姓名就是法人姓名
4419
4428
  */
4420
4429
  AdminName?: string;
4421
4430
  /**
@@ -4744,7 +4753,7 @@ export interface FlowApproverInfo {
4744
4753
  */
4745
4754
  ApproverRoleName?: string;
4746
4755
  /**
4747
- * 生成H5签署链接时,你可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4756
+ * 生成H5签署链接时,您可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4748
4757
  <ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
4749
4758
  <li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
4750
4759
  注:
@@ -5959,7 +5968,7 @@ export interface ChannelGetTaskResultApiResponse {
5959
5968
  */
5960
5969
  TaskMessage?: string;
5961
5970
  /**
5962
- * 资源Id,也是FileId,用于文件发起时使用
5971
+ * 资源Id(即FileId),用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
5963
5972
  */
5964
5973
  ResourceId?: string;
5965
5974
  /**
@@ -2385,7 +2385,7 @@ export interface LoginSettings {
2385
2385
  /**
2386
2386
  * 密钥 ID 列表。关联密钥后,就可以通过对应的私钥来访问实例。注意:此字段可能返回 [],表示取不到有效值。
2387
2387
  */
2388
- KeyIds: Array<string>;
2388
+ KeyIds?: Array<string>;
2389
2389
  }
2390
2390
  /**
2391
2391
  * DescribeDockerContainerConfiguration返回参数结构体
@@ -3635,7 +3635,10 @@ export interface FirewallRule {
3635
3635
  */
3636
3636
  Port?: string;
3637
3637
  /**
3638
- * 网段或 IP (互斥)。默认为 0.0.0.0/0,表示所有来源。
3638
+ * IPv4网段或 IPv4地址(互斥)
3639
+ 示例值:0.0.0.0/0。
3640
+
3641
+ 和Ipv6CidrBlock互斥,两者都不指定时,如果Protocol不是ICMPv6,则取默认值0.0.0.0/0。
3639
3642
  */
3640
3643
  CidrBlock?: string;
3641
3644
  /**
@@ -3663,27 +3666,30 @@ export interface FirewallRuleInfo {
3663
3666
  /**
3664
3667
  * 应用类型,取值:自定义,HTTP(80),HTTPS(443),Linux登录(22),Windows登录(3389),MySQL(3306),SQL Server(1433),全部TCP,全部UDP,Ping-ICMP,ALL。
3665
3668
  */
3666
- AppType: string;
3669
+ AppType?: string;
3667
3670
  /**
3668
3671
  * 协议,取值:TCP,UDP,ICMP,ALL。
3669
3672
  */
3670
- Protocol: string;
3673
+ Protocol?: string;
3671
3674
  /**
3672
3675
  * 端口,取值:ALL,单独的端口,逗号分隔的离散端口,减号分隔的端口范围。
3673
3676
  */
3674
- Port: string;
3677
+ Port?: string;
3675
3678
  /**
3676
- * 网段或 IP (互斥)。默认为 0.0.0.0/0,表示所有来源。
3679
+ * IPv4网段或 IPv4地址(互斥)
3680
+ 示例值:0.0.0.0/0。
3681
+
3682
+ 和Ipv6CidrBlock互斥,两者都不指定时,如果Protocol不是ICMPv6,则取默认值0.0.0.0/0。
3677
3683
  */
3678
- CidrBlock: string;
3684
+ CidrBlock?: string;
3679
3685
  /**
3680
3686
  * 取值:ACCEPT,DROP。默认为 ACCEPT。
3681
3687
  */
3682
- Action: string;
3688
+ Action?: string;
3683
3689
  /**
3684
3690
  * 防火墙规则描述。
3685
3691
  */
3686
- FirewallRuleDescription: string;
3692
+ FirewallRuleDescription?: string;
3687
3693
  }
3688
3694
  /**
3689
3695
  * CreateFirewallRules返回参数结构体
@@ -4036,16 +4042,16 @@ export interface SystemDisk {
4036
4042
  取值范围:
4037
4043
  <li> LOCAL_BASIC:本地硬盘</li><li> LOCAL_SSD:本地 SSD 硬盘</li><li> CLOUD_BASIC:普通云硬盘</li><li> CLOUD_SSD:SSD 云硬盘</li><li> CLOUD_PREMIUM:高性能云硬盘</li>
4038
4044
  */
4039
- DiskType: string;
4045
+ DiskType?: string;
4040
4046
  /**
4041
4047
  * 系统盘大小,单位:GB。
4042
4048
  */
4043
- DiskSize: number;
4049
+ DiskSize?: number;
4044
4050
  /**
4045
4051
  * 系统盘ID。
4046
4052
  注意:此字段可能返回 null,表示取不到有效值。
4047
4053
  */
4048
- DiskId: string;
4054
+ DiskId?: string;
4049
4055
  }
4050
4056
  /**
4051
4057
  * ApplyFirewallTemplate返回参数结构体
@@ -399,7 +399,7 @@ export interface AddLiveWatermarkRequest {
399
399
  PictureUrl: string;
400
400
  /**
401
401
  * 水印名称。
402
- 最长16字节。
402
+ 最长30字节。
403
403
  */
404
404
  WatermarkName: string;
405
405
  /**
@@ -3602,7 +3602,7 @@ export interface UpdateLiveWatermarkRequest {
3602
3602
  YPosition: number;
3603
3603
  /**
3604
3604
  * 水印名称。
3605
- 最长16字节。
3605
+ 最长30字节。
3606
3606
  */
3607
3607
  WatermarkName?: string;
3608
3608
  /**
@@ -7961,51 +7961,52 @@ export interface TranscodeDetailInfo {
7961
7961
  /**
7962
7962
  * 流名称。
7963
7963
  */
7964
- StreamName: string;
7964
+ StreamName?: string;
7965
7965
  /**
7966
7966
  * 开始时间(北京时间),格式:yyyy-mm-dd HH:MM。
7967
7967
  */
7968
- StartTime: string;
7968
+ StartTime?: string;
7969
7969
  /**
7970
7970
  * 结束时间(北京时间),格式:yyyy-mm-dd HH:MM。
7971
7971
  */
7972
- EndTime: string;
7972
+ EndTime?: string;
7973
7973
  /**
7974
7974
  * 转码时长,单位:分钟。
7975
7975
  注意:因推流过程中可能有中断重推情况,此处时长为真实转码时长累加值,并非结束时间和开始时间的间隔。
7976
7976
  */
7977
- Duration: number;
7977
+ Duration?: number;
7978
7978
  /**
7979
7979
  * 编码方式,带模块,
7980
7980
  示例:
7981
+ liveprocessor_ACC: 音频转码,
7981
7982
  liveprocessor_H264:直播转码-H264,
7982
7983
  liveprocessor_H265: 直播转码-H265,
7983
7984
  topspeed_H264:极速高清-H264,
7984
7985
  topspeed_H265:极速高清-H265。
7985
7986
  */
7986
- ModuleCodec: string;
7987
+ ModuleCodec?: string;
7987
7988
  /**
7988
7989
  * 码率。
7989
7990
  */
7990
- Bitrate: number;
7991
+ Bitrate?: number;
7991
7992
  /**
7992
7993
  * 类型,包含:转码(Transcode),混流(MixStream),水印(WaterMark),快直播(Webrtc)。
7993
7994
  */
7994
- Type: string;
7995
+ Type?: string;
7995
7996
  /**
7996
7997
  * 推流域名。
7997
7998
  */
7998
- PushDomain: string;
7999
+ PushDomain?: string;
7999
8000
  /**
8000
8001
  * 分辨率。
8001
8002
  */
8002
- Resolution: string;
8003
+ Resolution?: string;
8003
8004
  /**
8004
8005
  * 地域:
8005
8006
  Mainland:国内。
8006
8007
  Overseas:海外。
8007
8008
  */
8008
- MainlandOrOversea: string;
8009
+ MainlandOrOversea?: string;
8009
8010
  }
8010
8011
  /**
8011
8012
  * ModifyLiveRecordTemplate返回参数结构体
@@ -8996,6 +8996,11 @@ export interface AlarmHierarchicalNotice {
8996
8996
  注意:此字段可能返回 null,表示取不到有效值。
8997
8997
  */
8998
8998
  Classification?: Array<string>;
8999
+ /**
9000
+ * 模板对应的策略id
9001
+ 注意:此字段可能返回 null,表示取不到有效值。
9002
+ */
9003
+ PolicyId?: string;
8999
9004
  }
9000
9005
  /**
9001
9006
  * 策略绑定实例维度信息
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateResourceRequest, ModifyFolderRequest, DescribeJobSubmissionLogResponse, DeleteJobsRequest, ModifyWorkSpaceRequest, CreateJobConfigResponse, CreateResourceConfigResponse, CreateJobConfigRequest, DescribeTreeJobsResponse, CopyJobsRequest, CopyJobsResponse, TriggerJobSavepointRequest, DescribeJobSavepointRequest, DescribeFolderResponse, DescribeWorkSpacesRequest, DescribeTreeResourcesRequest, DescribeResourceConfigsResponse, DescribeClustersRequest, CreateWorkSpaceResponse, CreateJobResponse, CreateFolderRequest, DeleteJobConfigsResponse, DeleteTableConfigRequest, DeleteResourcesResponse, ModifyJobResponse, FetchSqlGatewayStatementResultResponse, CreateWorkSpaceRequest, DeleteResourceConfigsRequest, DescribeJobSavepointResponse, DeleteFoldersRequest, DeleteWorkSpaceRequest, DescribeWorkSpacesResponse, DescribeJobsRequest, CreateResourceResponse, DescribeSystemResourcesRequest, CreateFolderResponse, DescribeResourcesResponse, DescribeResourceRelatedJobsResponse, DescribeClustersResponse, DescribeSystemResourcesResponse, CheckSavepointRequest, DeleteJobConfigsRequest, StopJobsRequest, RunJobsRequest, DeleteWorkSpaceResponse, TriggerJobSavepointResponse, DeleteJobsResponse, DescribeResourceRelatedJobsRequest, DescribeTreeResourcesResponse, RunJobsResponse, DeleteResourcesRequest, DescribeJobConfigsRequest, ModifyJobRequest, DeleteResourceConfigsResponse, DescribeJobSubmissionLogRequest, DescribeResourceConfigsRequest, ModifyFolderResponse, ModifyWorkSpaceResponse, RunSqlGatewayStatementResponse, CreateJobRequest, DeleteTableConfigResponse, DescribeFolderRequest, DeleteFoldersResponse, CreateResourceConfigRequest, StopJobsResponse, DescribeResourcesRequest, RunSqlGatewayStatementRequest, CheckSavepointResponse, DescribeJobsResponse, DescribeTreeJobsRequest, DescribeJobConfigsResponse, FetchSqlGatewayStatementResultRequest } from "./oceanus_models";
3
+ import { CreateResourceRequest, ModifyFolderRequest, DescribeJobSubmissionLogResponse, DeleteJobsRequest, ModifyWorkSpaceRequest, CreateJobConfigResponse, CreateResourceConfigResponse, CreateJobConfigRequest, DescribeTreeJobsResponse, CopyJobsRequest, CopyJobsResponse, TriggerJobSavepointRequest, DescribeJobSavepointRequest, DescribeClustersResponse, RunSqlGatewayStatementRequest, DescribeFolderResponse, DescribeWorkSpacesRequest, DescribeTreeResourcesRequest, DescribeResourceConfigsResponse, DescribeClustersRequest, CreateWorkSpaceResponse, CreateJobResponse, CreateFolderRequest, DeleteJobConfigsResponse, DeleteTableConfigRequest, DeleteResourcesResponse, ModifyJobResponse, FetchSqlGatewayStatementResultResponse, CreateWorkSpaceRequest, DeleteResourceConfigsRequest, DescribeJobSavepointResponse, DeleteFoldersRequest, DeleteWorkSpaceRequest, DescribeWorkSpacesResponse, CreateResourceResponse, DescribeSystemResourcesRequest, CreateFolderResponse, DescribeResourcesResponse, DescribeResourceRelatedJobsResponse, DescribeSystemResourcesResponse, CheckSavepointRequest, DeleteJobConfigsRequest, StopJobsRequest, RunJobsRequest, DeleteWorkSpaceResponse, TriggerJobSavepointResponse, DeleteJobsResponse, DescribeResourceRelatedJobsRequest, DescribeTreeResourcesResponse, RunJobsResponse, DeleteResourcesRequest, DescribeJobConfigsRequest, ModifyJobRequest, DeleteResourceConfigsResponse, DescribeJobSubmissionLogRequest, DescribeJobsRequest, DescribeResourceConfigsRequest, ModifyFolderResponse, ModifyWorkSpaceResponse, RunSqlGatewayStatementResponse, CreateJobRequest, DeleteTableConfigResponse, DescribeFolderRequest, DeleteFoldersResponse, CreateResourceConfigRequest, StopJobsResponse, DescribeResourcesRequest, DescribeJobEventsRequest, CheckSavepointResponse, DescribeJobsResponse, DescribeTreeJobsRequest, DescribeJobConfigsResponse, FetchSqlGatewayStatementResultRequest, DescribeJobEventsResponse } from "./oceanus_models";
4
4
  /**
5
5
  * oceanus client
6
6
  * @class
@@ -68,9 +68,9 @@ export declare class Client extends AbstractClient {
68
68
  */
69
69
  FetchSqlGatewayStatementResult(req: FetchSqlGatewayStatementResultRequest, cb?: (error: string, rep: FetchSqlGatewayStatementResultResponse) => void): Promise<FetchSqlGatewayStatementResultResponse>;
70
70
  /**
71
- * 查询集群
71
+ * 获取指定作业的事件,包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型
72
72
  */
73
- DescribeClusters(req: DescribeClustersRequest, cb?: (error: string, rep: DescribeClustersResponse) => void): Promise<DescribeClustersResponse>;
73
+ DescribeJobEvents(req: DescribeJobEventsRequest, cb?: (error: string, rep: DescribeJobEventsResponse) => void): Promise<DescribeJobEventsResponse>;
74
74
  /**
75
75
  * 描述资源配置接口
76
76
  */
@@ -111,6 +111,10 @@ export declare class Client extends AbstractClient {
111
111
  * 创建作业配置,一个作业最多有100个配置版本
112
112
  */
113
113
  CreateJobConfig(req: CreateJobConfigRequest, cb?: (error: string, rep: CreateJobConfigResponse) => void): Promise<CreateJobConfigResponse>;
114
+ /**
115
+ * 查询集群
116
+ */
117
+ DescribeClusters(req: DescribeClustersRequest, cb?: (error: string, rep: DescribeClustersResponse) => void): Promise<DescribeClustersResponse>;
114
118
  /**
115
119
  * 删除作业配置
116
120
  */
@@ -118,10 +118,10 @@ class Client extends abstract_client_1.AbstractClient {
118
118
  return this.request("FetchSqlGatewayStatementResult", req, cb);
119
119
  }
120
120
  /**
121
- * 查询集群
121
+ * 获取指定作业的事件,包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型
122
122
  */
123
- async DescribeClusters(req, cb) {
124
- return this.request("DescribeClusters", req, cb);
123
+ async DescribeJobEvents(req, cb) {
124
+ return this.request("DescribeJobEvents", req, cb);
125
125
  }
126
126
  /**
127
127
  * 描述资源配置接口
@@ -183,6 +183,12 @@ class Client extends abstract_client_1.AbstractClient {
183
183
  async CreateJobConfig(req, cb) {
184
184
  return this.request("CreateJobConfig", req, cb);
185
185
  }
186
+ /**
187
+ * 查询集群
188
+ */
189
+ async DescribeClusters(req, cb) {
190
+ return this.request("DescribeClusters", req, cb);
191
+ }
186
192
  /**
187
193
  * 删除作业配置
188
194
  */
@@ -456,6 +456,36 @@ export interface ResourceLocParam {
456
456
  */
457
457
  Region?: string;
458
458
  }
459
+ /**
460
+ * 专家模式 计算节点的配置信息
461
+ */
462
+ export interface NodeConfig {
463
+ /**
464
+ * Node ID
465
+ 注意:此字段可能返回 null,表示取不到有效值。
466
+ */
467
+ Id: number;
468
+ /**
469
+ * Node parallelism
470
+ 注意:此字段可能返回 null,表示取不到有效值。
471
+ */
472
+ Parallelism?: number;
473
+ /**
474
+ * Slot sharing group
475
+ 注意:此字段可能返回 null,表示取不到有效值。
476
+ */
477
+ SlotSharingGroup?: string;
478
+ /**
479
+ * Configuration properties
480
+ 注意:此字段可能返回 null,表示取不到有效值。
481
+ */
482
+ Configuration?: Array<Property>;
483
+ /**
484
+ * 节点的状态ttl配置, 多个用 ; 分割
485
+ 注意:此字段可能返回 null,表示取不到有效值。
486
+ */
487
+ StateTTL?: string;
488
+ }
459
489
  /**
460
490
  * 工作空间详情
461
491
  */
@@ -683,6 +713,40 @@ export interface ResourceItem {
683
713
  */
684
714
  RefJobStatusCountSet?: Array<RefJobStatusCountItem>;
685
715
  }
716
+ /**
717
+ * DescribeClusters返回参数结构体
718
+ */
719
+ export interface DescribeClustersResponse {
720
+ /**
721
+ * 集群总数
722
+ */
723
+ TotalCount?: number;
724
+ /**
725
+ * 集群列表
726
+ */
727
+ ClusterSet?: Array<Cluster>;
728
+ /**
729
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
730
+ */
731
+ RequestId?: string;
732
+ }
733
+ /**
734
+ * RunSqlGatewayStatement请求参数结构体
735
+ */
736
+ export interface RunSqlGatewayStatementRequest {
737
+ /**
738
+ * 集群ID
739
+ */
740
+ ClusterId: string;
741
+ /**
742
+ * 需要执行的sql,该sql会被Sql Gateway执行,当前支持的是paimon修改需求,因此主要是DDL语句
743
+ */
744
+ Sql: string;
745
+ /**
746
+ * Sql Gateway会话ID,可不填,如果不填则会自动创建一个会话ID,每个会话ID都有一个存活时间,测试环境为10分钟,线上默认是30分钟
747
+ */
748
+ SessionId?: string;
749
+ }
686
750
  /**
687
751
  * DescribeFolder返回参数结构体
688
752
  */
@@ -1332,31 +1396,6 @@ export interface GatewayRefItem {
1332
1396
  */
1333
1397
  Type: number;
1334
1398
  }
1335
- /**
1336
- * DescribeJobs请求参数结构体
1337
- */
1338
- export interface DescribeJobsRequest {
1339
- /**
1340
- * 按照一个或者多个作业ID查询。作业ID形如:cql-11112222,每次请求的作业上限为100。参数不支持同时指定JobIds和Filters。
1341
- */
1342
- JobIds?: Array<string>;
1343
- /**
1344
- * 过滤条件,支持的 Filter.Name 为:作业名 Name、作业状态 Status、所属集群 ClusterId、作业id JobId、集群名称 ClusterName。 每次请求的 Filters 个数的上限为 5,Filter.Values 的个数上限为 5。参数不支持同时指定 JobIds 和 Filters。
1345
- */
1346
- Filters?: Array<Filter>;
1347
- /**
1348
- * 偏移量,默认为0
1349
- */
1350
- Offset?: number;
1351
- /**
1352
- * 分页大小,默认为20,最大值为100
1353
- */
1354
- Limit?: number;
1355
- /**
1356
- * 工作空间 SerialId
1357
- */
1358
- WorkSpaceId?: string;
1359
- }
1360
1399
  /**
1361
1400
  * CreateResource返回参数结构体
1362
1401
  */
@@ -1490,21 +1529,36 @@ export interface DescribeResourceRelatedJobsResponse {
1490
1529
  RequestId?: string;
1491
1530
  }
1492
1531
  /**
1493
- * DescribeClusters返回参数结构体
1532
+ * 描述作业发生的一个事件
1494
1533
  */
1495
- export interface DescribeClustersResponse {
1534
+ export interface JobEvent {
1496
1535
  /**
1497
- * 集群总数
1536
+ * 内部定义的事件类型
1498
1537
  */
1499
- TotalCount?: number;
1538
+ Type: string;
1500
1539
  /**
1501
- * 集群列表
1540
+ * 事件类型的说明文字
1502
1541
  */
1503
- ClusterSet?: Array<Cluster>;
1542
+ Description: string;
1504
1543
  /**
1505
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1544
+ * 事件发生的 Unix 时间戳(秒)
1506
1545
  */
1507
- RequestId?: string;
1546
+ Timestamp: number;
1547
+ /**
1548
+ * 事件发生时的运行 ID
1549
+ 注意:此字段可能返回 null,表示取不到有效值。
1550
+ */
1551
+ RunningOrderId: number;
1552
+ /**
1553
+ * 事件的一些可选说明
1554
+ 注意:此字段可能返回 null,表示取不到有效值。
1555
+ */
1556
+ Message: string;
1557
+ /**
1558
+ * 异常事件的排查手册链接
1559
+ 注意:此字段可能返回 null,表示取不到有效值。
1560
+ */
1561
+ SolutionLink: string;
1508
1562
  }
1509
1563
  /**
1510
1564
  * 资源引用参数
@@ -2574,34 +2628,29 @@ export interface DescribeJobSubmissionLogRequest {
2574
2628
  Limit?: number;
2575
2629
  }
2576
2630
  /**
2577
- * 专家模式 计算节点的配置信息
2631
+ * DescribeJobs请求参数结构体
2578
2632
  */
2579
- export interface NodeConfig {
2633
+ export interface DescribeJobsRequest {
2580
2634
  /**
2581
- * Node ID
2582
- 注意:此字段可能返回 null,表示取不到有效值。
2635
+ * 按照一个或者多个作业ID查询。作业ID形如:cql-11112222,每次请求的作业上限为100。参数不支持同时指定JobIds和Filters。
2583
2636
  */
2584
- Id: number;
2637
+ JobIds?: Array<string>;
2585
2638
  /**
2586
- * Node parallelism
2587
- 注意:此字段可能返回 null,表示取不到有效值。
2639
+ * 过滤条件,支持的 Filter.Name 为:作业名 Name、作业状态 Status、所属集群 ClusterId、作业id JobId、集群名称 ClusterName。 每次请求的 Filters 个数的上限为 5,Filter.Values 的个数上限为 5。参数不支持同时指定 JobIds 和 Filters。
2588
2640
  */
2589
- Parallelism?: number;
2641
+ Filters?: Array<Filter>;
2590
2642
  /**
2591
- * Slot sharing group
2592
- 注意:此字段可能返回 null,表示取不到有效值。
2643
+ * 偏移量,默认为0
2593
2644
  */
2594
- SlotSharingGroup?: string;
2645
+ Offset?: number;
2595
2646
  /**
2596
- * Configuration properties
2597
- 注意:此字段可能返回 null,表示取不到有效值。
2647
+ * 分页大小,默认为20,最大值为100
2598
2648
  */
2599
- Configuration?: Array<Property>;
2649
+ Limit?: number;
2600
2650
  /**
2601
- * 节点的状态ttl配置, 多个用 ; 分割
2602
- 注意:此字段可能返回 null,表示取不到有效值。
2651
+ * 工作空间 SerialId
2603
2652
  */
2604
- StateTTL?: string;
2653
+ WorkSpaceId?: string;
2605
2654
  }
2606
2655
  /**
2607
2656
  * Job详细信息
@@ -3284,21 +3333,33 @@ export interface DescribeResourcesRequest {
3284
3333
  WorkSpaceId?: string;
3285
3334
  }
3286
3335
  /**
3287
- * RunSqlGatewayStatement请求参数结构体
3336
+ * DescribeJobEvents请求参数结构体
3288
3337
  */
3289
- export interface RunSqlGatewayStatementRequest {
3338
+ export interface DescribeJobEventsRequest {
3290
3339
  /**
3291
- * 集群ID
3340
+ * 作业的 ID
3292
3341
  */
3293
- ClusterId: string;
3342
+ JobId: string;
3294
3343
  /**
3295
- * 需要执行的sql,该sql会被Sql Gateway执行,当前支持的是paimon修改需求,因此主要是DDL语句
3344
+ * 筛选条件:起始 Unix 时间戳(秒)
3296
3345
  */
3297
- Sql: string;
3346
+ StartTimestamp: number;
3298
3347
  /**
3299
- * Sql Gateway会话ID,可不填,如果不填则会自动创建一个会话ID,每个会话ID都有一个存活时间,测试环境为10分钟,线上默认是30分钟
3348
+ * 筛选条件:结束 Unix 时间戳(秒)
3300
3349
  */
3301
- SessionId?: string;
3350
+ EndTimestamp: number;
3351
+ /**
3352
+ * 事件类型。如果不传则返回所有类型的数据
3353
+ */
3354
+ Types?: Array<string>;
3355
+ /**
3356
+ * 运行实例 ID 数组
3357
+ */
3358
+ RunningOrderIds?: Array<number | bigint>;
3359
+ /**
3360
+ * 工作空间 SerialId
3361
+ */
3362
+ WorkSpaceId?: string;
3302
3363
  }
3303
3364
  /**
3304
3365
  * CheckSavepoint返回参数结构体
@@ -3464,3 +3525,27 @@ export interface FetchSqlGatewayStatementResultRequest {
3464
3525
  */
3465
3526
  ResultUri?: string;
3466
3527
  }
3528
+ /**
3529
+ * DescribeJobEvents返回参数结构体
3530
+ */
3531
+ export interface DescribeJobEventsResponse {
3532
+ /**
3533
+ * 该作业指定范围内的事件列表
3534
+ 注意:此字段可能返回 null,表示取不到有效值。
3535
+ */
3536
+ Events: Array<JobEvent>;
3537
+ /**
3538
+ * 该作业指定范围内运行实例 ID 数组,仅当入参没有传入 RunningOrderIds 参数时才会返回。倒序输出
3539
+ 注意:此字段可能返回 null,表示取不到有效值。
3540
+ */
3541
+ RunningOrderIds: Array<number | bigint>;
3542
+ /**
3543
+ * 事件的总数
3544
+ 注意:此字段可能返回 null,表示取不到有效值。
3545
+ */
3546
+ TotalCount: number;
3547
+ /**
3548
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3549
+ */
3550
+ RequestId?: string;
3551
+ }
@@ -3862,7 +3862,7 @@ export interface DescribeBackupDownloadRestrictionResponse {
3862
3862
  */
3863
3863
  LimitVpc?: Array<BackupLimitVpcItem>;
3864
3864
  /**
3865
- * 自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时,显示该参数。
3865
+ * 自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时,显示该参数。
3866
3866
  */
3867
3867
  LimitIp?: Array<string>;
3868
3868
  /**
@@ -4306,11 +4306,31 @@ export interface OperationLog {
4306
4306
  /**
4307
4307
  * 操作证书动作。
4308
4308
  */
4309
- Action: string;
4309
+ Action?: string;
4310
4310
  /**
4311
4311
  * 操作时间。
4312
4312
  */
4313
- CreatedOn: string;
4313
+ CreatedOn?: string;
4314
+ /**
4315
+ * 主账号
4316
+ 注意:此字段可能返回 null,表示取不到有效值。
4317
+ */
4318
+ Uin?: string;
4319
+ /**
4320
+ * 子账号
4321
+ 注意:此字段可能返回 null,表示取不到有效值。
4322
+ */
4323
+ SubAccountUin?: string;
4324
+ /**
4325
+ * 证书ID
4326
+ 注意:此字段可能返回 null,表示取不到有效值。
4327
+ */
4328
+ CertId?: string;
4329
+ /**
4330
+ * 操作
4331
+ 注意:此字段可能返回 null,表示取不到有效值。
4332
+ */
4333
+ Type?: string;
4314
4334
  }
4315
4335
  /**
4316
4336
  * ModifyCertificateAlias返回参数结构体
@@ -1557,7 +1557,7 @@ export interface RegisterCodeInfo {
1557
1557
  */
1558
1558
  InstanceNamePrefix?: string;
1559
1559
  /**
1560
- * 该注册码允许注册的实列数目。
1560
+ * 该注册码允许注册的实例数目。
1561
1561
  注意:此字段可能返回 null,表示取不到有效值。
1562
1562
  */
1563
1563
  RegisterLimit?: number;