tencentcloud-sdk-nodejs 4.0.830 → 4.0.832

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 (57) hide show
  1. package/CHANGELOG.md +203 -0
  2. package/SERVICE_CHANGELOG.md +284 -32
  3. package/package.json +1 -1
  4. package/products.md +22 -22
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/aiart/v20221229/aiart_models.ts +1 -2
  7. package/src/services/bri/v20190328/bri_client.ts +3 -1
  8. package/src/services/captcha/v20190722/captcha_models.ts +15 -15
  9. package/src/services/ccc/v20200210/ccc_models.ts +5 -0
  10. package/src/services/dts/v20211206/dts_models.ts +11 -2
  11. package/src/services/ess/v20201111/ess_models.ts +17 -2
  12. package/src/services/essbasic/v20210526/essbasic_models.ts +35 -14
  13. package/src/services/faceid/v20180301/faceid_client.ts +2 -3
  14. package/src/services/faceid/v20180301/faceid_models.ts +4 -2
  15. package/src/services/gs/v20191118/gs_client.ts +14 -2
  16. package/src/services/gs/v20191118/gs_models.ts +30 -6
  17. package/src/services/lcic/v20220817/lcic_models.ts +5 -0
  18. package/src/services/lighthouse/v20200324/lighthouse_models.ts +7 -1
  19. package/src/services/mongodb/v20190725/mongodb_client.ts +20 -4
  20. package/src/services/mongodb/v20190725/mongodb_models.ts +128 -41
  21. package/src/services/organization/v20210331/organization_client.ts +2 -3
  22. package/src/services/organization/v20210331/organization_models.ts +72 -72
  23. package/src/services/sqlserver/v20180328/sqlserver_client.ts +1 -0
  24. package/src/services/sqlserver/v20180328/sqlserver_models.ts +23 -0
  25. package/src/services/ssl/v20191205/ssl_models.ts +6 -2
  26. package/src/services/tione/v20211111/tione_models.ts +15 -2
  27. package/src/services/trtc/v20190722/trtc_models.ts +4 -0
  28. package/tencentcloud/common/sdk_version.d.ts +1 -1
  29. package/tencentcloud/common/sdk_version.js +1 -1
  30. package/tencentcloud/services/aiart/v20221229/aiart_models.d.ts +1 -2
  31. package/tencentcloud/services/bri/v20190328/bri_client.d.ts +3 -1
  32. package/tencentcloud/services/bri/v20190328/bri_client.js +3 -1
  33. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +15 -15
  34. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +5 -0
  35. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +11 -2
  36. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +17 -2
  37. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +35 -14
  38. package/tencentcloud/services/faceid/v20180301/faceid_client.d.ts +0 -1
  39. package/tencentcloud/services/faceid/v20180301/faceid_client.js +0 -1
  40. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +4 -2
  41. package/tencentcloud/services/gs/v20191118/gs_client.d.ts +5 -1
  42. package/tencentcloud/services/gs/v20191118/gs_client.js +6 -0
  43. package/tencentcloud/services/gs/v20191118/gs_models.d.ts +28 -6
  44. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +5 -0
  45. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +7 -1
  46. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +6 -1
  47. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +7 -0
  48. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +123 -41
  49. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +0 -1
  50. package/tencentcloud/services/organization/v20210331/organization_client.js +0 -1
  51. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +72 -72
  52. package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +22 -0
  53. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +6 -2
  54. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +15 -2
  55. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +4 -0
  56. package/test/gs.v20191118.test.js +10 -0
  57. package/test/mongodb.v20190725.test.js +10 -0
@@ -5,17 +5,17 @@ export interface DescribeCaptchaOperDataResponse {
5
5
  /**
6
6
  * 成功返回 0 其它失败
7
7
  */
8
- CaptchaCode: number;
8
+ CaptchaCode?: number;
9
9
  /**
10
10
  * 返回信息
11
11
  注意:此字段可能返回 null,表示取不到有效值。
12
12
  */
13
- CaptchaMsg: string;
13
+ CaptchaMsg?: string;
14
14
  /**
15
15
  * 用户操作数据
16
16
  注意:此字段可能返回 null,表示取不到有效值。
17
17
  */
18
- Data: CaptchaOperDataRes;
18
+ Data?: CaptchaOperDataRes;
19
19
  /**
20
20
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
21
21
  */
@@ -602,40 +602,40 @@ export interface DescribeCaptchaDataSumResponse {
602
602
  /**
603
603
  * 请求总量
604
604
  */
605
- GetSum: number;
605
+ GetSum?: number;
606
606
  /**
607
607
  * 请求验证成功量
608
608
  */
609
- VfySuccSum: number;
609
+ VfySuccSum?: number;
610
610
  /**
611
611
  * 请求验证量
612
612
  */
613
- VfySum: number;
613
+ VfySum?: number;
614
614
  /**
615
615
  * 拦截攻击量
616
616
  */
617
- AttackSum: number;
617
+ AttackSum?: number;
618
618
  /**
619
619
  * 返回信息
620
620
  注意:此字段可能返回 null,表示取不到有效值。
621
621
  */
622
- CaptchaMsg: string;
622
+ CaptchaMsg?: string;
623
623
  /**
624
624
  * 成功返回0 其它失败
625
625
  */
626
- CaptchaCode: number;
626
+ CaptchaCode?: number;
627
627
  /**
628
628
  * 票据校验总量
629
629
  */
630
- CheckTicketSum: number;
630
+ CheckTicketSum?: number;
631
631
  /**
632
632
  * 票据验证通过量
633
633
  */
634
- TicketThroughputSum: number;
634
+ TicketThroughputSum?: number;
635
635
  /**
636
636
  * 票据验证拦截量
637
637
  */
638
- TicketInterceptSum: number;
638
+ TicketInterceptSum?: number;
639
639
  /**
640
640
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
641
641
  */
@@ -831,15 +831,15 @@ export interface GetTicketStatisticsResponse {
831
831
  * 查询后数据块
832
832
  注意:此字段可能返回 null,表示取不到有效值。
833
833
  */
834
- Data: CaptchaStatisticObj;
834
+ Data?: CaptchaStatisticObj;
835
835
  /**
836
836
  * 验证码返回码
837
837
  */
838
- CaptchaCode: number;
838
+ CaptchaCode?: number;
839
839
  /**
840
840
  * 验证码返回信息
841
841
  */
842
- CaptchaMsg: string;
842
+ CaptchaMsg?: string;
843
843
  /**
844
844
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
845
845
  */
@@ -2312,6 +2312,11 @@ export interface UploadIvrAudioResponse {
2312
2312
  注意:此字段可能返回 null,表示取不到有效值。
2313
2313
  */
2314
2314
  FailedFileList?: Array<UploadIvrAudioFailedInfo>;
2315
+ /**
2316
+ * 上传成功文件列表
2317
+ 注意:此字段可能返回 null,表示取不到有效值。
2318
+ */
2319
+ SuccessFileList?: Array<AudioFileInfo>;
2315
2320
  /**
2316
2321
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2317
2322
  */
@@ -1331,6 +1331,11 @@ export interface DBEndpointInfo {
1331
1331
  注意:此字段可能返回 null,表示取不到有效值。
1332
1332
  */
1333
1333
  DatabaseNetEnv?: string;
1334
+ /**
1335
+ * tdsql连接方式:proxy-通过tdsql proxy主机访问各个set节点,注意只有在自研上云的网络环境下才能通过这种方式连接,Info中只需要提供proxy主机信息。set-直连set节点,如选择直连set方式,Info中需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。
1336
+ 注意:此字段可能返回 null,表示取不到有效值。
1337
+ */
1338
+ ConnectType?: string;
1334
1339
  }
1335
1340
  /**
1336
1341
  * ResumeSubscribe请求参数结构体
@@ -2241,7 +2246,7 @@ export interface DifferenceDetail {
2241
2246
  */
2242
2247
  export interface DBInfo {
2243
2248
  /**
2244
- * 表示节点角色,针对分布式数据库,如mongodb中的mongos节点。如数据库是tdsql,枚举值为:proxyset
2249
+ * 表示节点角色,针对分布式数据库,如mongodb中的mongos节点。tdsqlmysql的可选项:proxy表示节点类型为主机,set表示节点类型为节点。proxy类型必须填在数组第一项。tdsqlmysql类型的源/目标配置必填。
2245
2250
  注意:此字段可能返回 null,表示取不到有效值。
2246
2251
  */
2247
2252
  Role?: string;
@@ -2341,7 +2346,7 @@ export interface DBInfo {
2341
2346
  */
2342
2347
  TmpToken?: string;
2343
2348
  /**
2344
- * tdsql分片id。tdsql set节点必填
2349
+ * tdsql的分片id。如节点类型为set必填。
2345
2350
  注意:此字段可能返回 null,表示取不到有效值。
2346
2351
  */
2347
2352
  SetId?: string;
@@ -2593,6 +2598,10 @@ export interface ConfigureSyncJobRequest {
2593
2598
  * 期待启动时间,当RunMode取值为Timed时,此值必填,形如:"2006-01-02 15:04:05"
2594
2599
  */
2595
2600
  ExpectRunTime?: string;
2601
+ /**
2602
+ * 源端tdsql连接方式:proxy-通过tdsql proxy主机访问各个set节点,注意只有在自研上云的网络环境下才能通过这种方式连接,SrcInfos中只需要提供proxy主机信息。set-直连set节点,如选择直连set方式,需要正确填写proxy主机信息及所有set节点信息。源端是tdsqlmysql类型必填。
2603
+ */
2604
+ SrcConnectType?: string;
2596
2605
  /**
2597
2606
  * 源端信息,单节点数据库使用,且SrcNodeType传single
2598
2607
  */
@@ -2221,6 +2221,19 @@ export interface AutoSignConfig {
2221
2221
  <li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
2222
2222
  */
2223
2223
  LicenseType?: number;
2224
+ /**
2225
+ * 开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。
2226
+
2227
+ 注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
2228
+
2229
+ 跳转场景:
2230
+ <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>
2231
+ <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
2232
+
2233
+ 成功结果返回:
2234
+ 若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
2235
+ */
2236
+ JumpUrl?: string;
2224
2237
  }
2225
2238
  /**
2226
2239
  * DescribeThirdPartyAuthCode请求参数结构体
@@ -5706,6 +5719,10 @@ export interface CreateUserAutoSignEnableUrlRequest {
5706
5719
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5707
5720
  */
5708
5721
  Agent?: Agent;
5722
+ /**
5723
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。
5724
+ */
5725
+ UserData?: string;
5709
5726
  }
5710
5727
  /**
5711
5728
  * CreateOrganizationBatchSignUrl返回参数结构体
@@ -6617,8 +6634,6 @@ export interface Component {
6617
6634
 
6618
6635
  - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
6619
6636
  - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
6620
- - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
6621
- - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
6622
6637
 
6623
6638
 
6624
6639
  注:`控件ID可以在一个PDF中不可重复`
@@ -55,8 +55,6 @@ export interface Component {
55
55
 
56
56
  - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
57
57
  - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
58
- - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
59
- - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
60
58
 
61
59
 
62
60
  注:`控件ID可以在一个PDF中不可重复`
@@ -2589,6 +2587,19 @@ export interface AutoSignConfig {
2589
2587
  <li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
2590
2588
  */
2591
2589
  LicenseType?: number;
2590
+ /**
2591
+ * 开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。
2592
+
2593
+ 注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
2594
+
2595
+ 跳转场景:
2596
+ <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>
2597
+ <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
2598
+
2599
+ 成功结果返回:
2600
+ 若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,比如 qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
2601
+ */
2602
+ JumpUrl?: string;
2592
2603
  }
2593
2604
  /**
2594
2605
  * 第三方应用集成员工角色信息
@@ -3571,6 +3582,10 @@ export interface ChannelCreateUserAutoSignEnableUrlRequest {
3571
3582
  * 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
3572
3583
  */
3573
3584
  ExpiredTime?: number;
3585
+ /**
3586
+ * 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中,该字段的信息将原封不动地透传给贵方。
3587
+ */
3588
+ UserData?: string;
3574
3589
  }
3575
3590
  /**
3576
3591
  * ChannelCancelMultiFlowSignQRCode请求参数结构体
@@ -7133,48 +7148,54 @@ export interface OccupiedSeal {
7133
7148
  /**
7134
7149
  * 电子印章编号
7135
7150
  */
7136
- SealId: string;
7151
+ SealId?: string;
7137
7152
  /**
7138
7153
  * 电子印章名称
7139
7154
  */
7140
- SealName: string;
7155
+ SealName?: string;
7141
7156
  /**
7142
7157
  * 电子印章授权时间戳,单位秒
7143
7158
  */
7144
- CreateOn: number;
7159
+ CreateOn?: number;
7145
7160
  /**
7146
7161
  * 电子印章授权人,电子签的UserId
7147
7162
  */
7148
- Creator: string;
7163
+ Creator?: string;
7149
7164
  /**
7150
7165
  * 电子印章策略Id
7151
7166
  */
7152
- SealPolicyId: string;
7167
+ SealPolicyId?: string;
7153
7168
  /**
7154
7169
  * 印章状态,有以下六种:CHECKING(审核中)SUCCESS(已启用)FAIL(审核拒绝)CHECKING-SADM(待超管审核)DISABLE(已停用)STOPPED(已终止)
7155
7170
  */
7156
- SealStatus: string;
7171
+ SealStatus?: string;
7157
7172
  /**
7158
7173
  * 审核失败原因
7159
7174
  注意:此字段可能返回 null,表示取不到有效值。
7160
7175
  */
7161
- FailReason: string;
7176
+ FailReason?: string;
7162
7177
  /**
7163
7178
  * 印章图片url,5分钟内有效
7164
7179
  */
7165
- Url: string;
7180
+ Url?: string;
7166
7181
  /**
7167
- * 印章类型,OFFICIAL-企业公章,CONTRACT-合同专用章,LEGAL_PERSON_SEAL-法人章
7182
+ * 电子印章类型 , 可选类型如下:
7183
+ <ul><li>**OFFICIAL**: (默认)公章</li>
7184
+ <li>**CONTRACT**: 合同专用章;</li>
7185
+ <li>**FINANCE**: 财务专用章;</li>
7186
+ <li>**PERSONNEL**: 人事专用章</li>
7187
+ <li>**INVOICE**: 发票专用章</li>
7188
+ </ul>
7168
7189
  */
7169
- SealType: string;
7190
+ SealType?: string;
7170
7191
  /**
7171
7192
  * 用印申请是否为永久授权
7172
7193
  */
7173
- IsAllTime: boolean;
7194
+ IsAllTime?: boolean;
7174
7195
  /**
7175
7196
  * 授权人列表
7176
7197
  */
7177
- AuthorizedUsers: Array<AuthorizedUser>;
7198
+ AuthorizedUsers?: Array<AuthorizedUser>;
7178
7199
  }
7179
7200
  /**
7180
7201
  * CreateFlowsByTemplates请求参数结构体
@@ -49,7 +49,6 @@ export declare class Client extends AbstractClient {
49
49
  GetFaceIdToken(req: GetFaceIdTokenRequest, cb?: (error: string, rep: GetFaceIdTokenResponse) => void): Promise<GetFaceIdTokenResponse>;
50
50
  /**
51
51
  * 手机号二要素核验接口用于校验手机号和姓名的真实性和一致性,支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
52
-
53
52
  */
54
53
  CheckPhoneAndName(req: CheckPhoneAndNameRequest, cb?: (error: string, rep: CheckPhoneAndNameResponse) => void): Promise<CheckPhoneAndNameResponse>;
55
54
  /**
@@ -89,7 +89,6 @@ class Client extends abstract_client_1.AbstractClient {
89
89
  }
90
90
  /**
91
91
  * 手机号二要素核验接口用于校验手机号和姓名的真实性和一致性,支持的手机号段详情请查阅<a href="https://cloud.tencent.com/document/product/1007/46063">运营商类</a>文档。
92
-
93
92
  */
94
93
  async CheckPhoneAndName(req, cb) {
95
94
  return this.request("CheckPhoneAndName", req, cb);
@@ -2426,12 +2426,14 @@ export interface CheckPhoneAndNameResponse {
2426
2426
  -1:查无记录
2427
2427
  -2:引擎未知错误
2428
2428
  -3:引擎服务异常
2429
+ -4:姓名校验不通过
2430
+ -5:手机号码不合法
2429
2431
  */
2430
- Result: string;
2432
+ Result?: string;
2431
2433
  /**
2432
2434
  * 业务结果描述
2433
2435
  */
2434
- Description: string;
2436
+ Description?: string;
2435
2437
  /**
2436
2438
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2437
2439
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { StopPublishStreamResponse, StopGameRequest, SaveGameArchiveResponse, StopPublishStreamRequest, SwitchGameArchiveRequest, TrylockWorkerResponse, DescribeInstancesCountResponse, StartPublishStreamResponse, CreateSessionRequest, CreateSessionResponse, DescribeInstancesCountRequest, SaveGameArchiveRequest, TrylockWorkerRequest, SwitchGameArchiveResponse, StartPublishStreamRequest, StopGameResponse } from "./gs_models";
3
+ import { StartPublishStreamToCSSResponse, StopGameRequest, SaveGameArchiveResponse, StopPublishStreamRequest, StopPublishStreamResponse, TrylockWorkerResponse, SwitchGameArchiveRequest, StartPublishStreamToCSSRequest, DescribeInstancesCountResponse, StartPublishStreamResponse, CreateSessionRequest, CreateSessionResponse, DescribeInstancesCountRequest, SaveGameArchiveRequest, TrylockWorkerRequest, SwitchGameArchiveResponse, StartPublishStreamRequest, StopGameResponse } from "./gs_models";
4
4
  /**
5
5
  * gs client
6
6
  * @class
@@ -23,6 +23,10 @@ export declare class Client extends AbstractClient {
23
23
  * 保存游戏存档
24
24
  */
25
25
  SaveGameArchive(req: SaveGameArchiveRequest, cb?: (error: string, rep: SaveGameArchiveResponse) => void): Promise<SaveGameArchiveResponse>;
26
+ /**
27
+ * 开始云端推流
28
+ */
29
+ StartPublishStreamToCSS(req: StartPublishStreamToCSSRequest, cb?: (error: string, rep: StartPublishStreamToCSSResponse) => void): Promise<StartPublishStreamToCSSResponse>;
26
30
  /**
27
31
  * 切换游戏存档
28
32
  */
@@ -51,6 +51,12 @@ class Client extends abstract_client_1.AbstractClient {
51
51
  async SaveGameArchive(req, cb) {
52
52
  return this.request("SaveGameArchive", req, cb);
53
53
  }
54
+ /**
55
+ * 开始云端推流
56
+ */
57
+ async StartPublishStreamToCSS(req, cb) {
58
+ return this.request("StartPublishStreamToCSS", req, cb);
59
+ }
54
60
  /**
55
61
  * 切换游戏存档
56
62
  */
@@ -1,7 +1,7 @@
1
1
  /**
2
- * StopPublishStream返回参数结构体
2
+ * StartPublishStreamToCSS返回参数结构体
3
3
  */
4
- export interface StopPublishStreamResponse {
4
+ export interface StartPublishStreamToCSSResponse {
5
5
  /**
6
6
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7
7
  */
@@ -38,6 +38,24 @@ export interface StopPublishStreamRequest {
38
38
  */
39
39
  UserId: string;
40
40
  }
41
+ /**
42
+ * StopPublishStream返回参数结构体
43
+ */
44
+ export interface StopPublishStreamResponse {
45
+ /**
46
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
47
+ */
48
+ RequestId?: string;
49
+ }
50
+ /**
51
+ * TrylockWorker返回参数结构体
52
+ */
53
+ export interface TrylockWorkerResponse {
54
+ /**
55
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
56
+ */
57
+ RequestId?: string;
58
+ }
41
59
  /**
42
60
  * SwitchGameArchive请求参数结构体
43
61
  */
@@ -60,13 +78,17 @@ export interface SwitchGameArchiveRequest {
60
78
  GameContext?: string;
61
79
  }
62
80
  /**
63
- * TrylockWorker返回参数结构体
81
+ * StartPublishStreamToCSS请求参数结构体
64
82
  */
65
- export interface TrylockWorkerResponse {
83
+ export interface StartPublishStreamToCSSRequest {
66
84
  /**
67
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
85
+ * 唯一用户身份标识,由业务方自定义,平台不予理解。(可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成;在用户重连时应保持UserId不变)
68
86
  */
69
- RequestId?: string;
87
+ UserId: string;
88
+ /**
89
+ * 推流参数,推流时携带自定义参数。
90
+ */
91
+ PublishStreamArgs?: string;
70
92
  }
71
93
  /**
72
94
  * DescribeInstancesCount返回参数结构体
@@ -106,6 +106,7 @@ export interface CreateRoomRequest {
106
106
  IsGradingRequiredPostClass?: number;
107
107
  /**
108
108
  * 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放)
109
+ 注:大班课的布局(layout)只有三分屏
109
110
  */
110
111
  RoomType?: number;
111
112
  /**
@@ -725,6 +726,7 @@ export interface RoomItem {
725
726
  IsGradingRequiredPostClass?: number;
726
727
  /**
727
728
  * 房间类型。0:小班课(默认值);1:大班课;2:1V1(后续扩展)
729
+ 注:大班课的布局(layout)只有三分屏
728
730
  注意:此字段可能返回 null,表示取不到有效值。
729
731
  */
730
732
  RoomType?: number;
@@ -2084,6 +2086,7 @@ export interface DescribeRoomResponse {
2084
2086
  IsGradingRequiredPostClass?: number;
2085
2087
  /**
2086
2088
  * 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
2089
+ 注:大班课的布局(layout)只有三分屏
2087
2090
  */
2088
2091
  RoomType?: number;
2089
2092
  /**
@@ -2652,6 +2655,7 @@ export interface RoomInfo {
2652
2655
  IsGradingRequiredPostClass?: number;
2653
2656
  /**
2654
2657
  * 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
2658
+ 注:大班课的布局(layout)只有三分屏
2655
2659
  */
2656
2660
  RoomType?: number;
2657
2661
  /**
@@ -2781,6 +2785,7 @@ export interface ModifyRoomRequest {
2781
2785
  IsGradingRequiredPostClass?: number;
2782
2786
  /**
2783
2787
  * 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数、暂未开放)
2788
+ 注:大班课的布局(layout)只有三分屏
2784
2789
  */
2785
2790
  RoomType?: number;
2786
2791
  /**
@@ -4608,7 +4608,13 @@ export interface ModifyInstancesRenewFlagRequest {
4608
4608
  */
4609
4609
  InstanceIds: Array<string>;
4610
4610
  /**
4611
- * 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费<br><br>若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
4611
+ * 自动续费标识。取值范围:
4612
+
4613
+ - NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
4614
+ - NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
4615
+ - DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费
4616
+
4617
+ 若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
4612
4618
  */
4613
4619
  RenewFlag: string;
4614
4620
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { DescribeSpecInfoRequest, CreateDBInstanceRequest, DescribeCurrentOpResponse, DescribeAccountUsersRequest, SetInstanceMaintenanceResponse, CreateBackupDBInstanceResponse, KillOpsRequest, InquirePriceRenewDBInstancesRequest, DescribeSlowLogsRequest, FlushInstanceRouterConfigResponse, AssignProjectResponse, DescribeDBInstanceDealResponse, OfflineIsolatedDBInstanceResponse, IsolateDBInstanceResponse, DescribeSecurityGroupRequest, DescribeBackupDownloadTaskResponse, FlushInstanceRouterConfigRequest, SetAccountUserPrivilegeResponse, ModifyDBInstanceNetworkAddressRequest, CreateDBInstanceHourResponse, DescribeDBInstanceNodePropertyRequest, DeleteAccountUserRequest, ModifyDBInstanceNetworkAddressResponse, CreateAccountUserResponse, DescribeSlowLogPatternsResponse, DescribeSlowLogsResponse, InquirePriceModifyDBInstanceSpecRequest, DescribeDBInstancesRequest, ModifyDBInstanceSpecRequest, ResetDBInstancePasswordRequest, DescribeAsyncRequestInfoResponse, CreateDBInstanceResponse, CreateAccountUserRequest, ModifyDBInstanceSecurityGroupRequest, DescribeAccountUsersResponse, DescribeBackupDownloadTaskRequest, DescribeClientConnectionsResponse, TerminateDBInstancesRequest, DescribeDBBackupsResponse, ModifyDBInstanceSecurityGroupResponse, InquirePriceCreateDBInstancesResponse, DescribeSecurityGroupResponse, ResetDBInstancePasswordResponse, DescribeDBInstanceDealRequest, DescribeAsyncRequestInfoRequest, CreateBackupDownloadTaskRequest, InquirePriceModifyDBInstanceSpecResponse, DescribeDBInstanceNodePropertyResponse, DescribeCurrentOpRequest, DescribeDBBackupsRequest, DescribeClientConnectionsRequest, TerminateDBInstancesResponse, RenameInstanceRequest, RenewDBInstancesResponse, RenameInstanceResponse, CreateBackupDBInstanceRequest, SetAccountUserPrivilegeRequest, KillOpsResponse, IsolateDBInstanceRequest, CreateDBInstanceHourRequest, AssignProjectRequest, CreateBackupDownloadTaskResponse, DescribeSlowLogPatternsRequest, DescribeSpecInfoResponse, InquirePriceRenewDBInstancesResponse, DeleteAccountUserResponse, DescribeDBInstancesResponse, OfflineIsolatedDBInstanceRequest, InquirePriceCreateDBInstancesRequest, DescribeInstanceParamsResponse, DescribeInstanceParamsRequest, SetInstanceMaintenanceRequest, ModifyDBInstanceSpecResponse, RenewDBInstancesRequest } from "./mongodb_models";
3
+ import { DescribeSpecInfoRequest, CreateDBInstanceRequest, DescribeCurrentOpResponse, DescribeAccountUsersRequest, SetInstanceMaintenanceResponse, CreateBackupDBInstanceResponse, FlushInstanceRouterConfigRequest, KillOpsRequest, InquirePriceRenewDBInstancesRequest, DescribeSlowLogsRequest, FlushInstanceRouterConfigResponse, AssignProjectResponse, DescribeDBInstanceDealResponse, OfflineIsolatedDBInstanceResponse, IsolateDBInstanceResponse, DescribeSecurityGroupRequest, DescribeBackupDownloadTaskResponse, SetAccountUserPrivilegeResponse, ModifyDBInstanceNetworkAddressRequest, CreateDBInstanceHourResponse, DescribeDBInstanceNodePropertyRequest, DeleteAccountUserRequest, ModifyDBInstanceNetworkAddressResponse, CreateAccountUserResponse, DescribeSlowLogPatternsResponse, DescribeSlowLogsResponse, InquirePriceModifyDBInstanceSpecRequest, DescribeDBInstancesRequest, ModifyDBInstanceSpecRequest, FlashBackDBInstanceRequest, ResetDBInstancePasswordRequest, DescribeAsyncRequestInfoResponse, CreateDBInstanceResponse, CreateAccountUserRequest, ModifyDBInstanceSecurityGroupRequest, DescribeAccountUsersResponse, DescribeBackupDownloadTaskRequest, DescribeClientConnectionsResponse, TerminateDBInstancesRequest, DescribeDBBackupsResponse, ModifyDBInstanceSecurityGroupResponse, DescribeInstanceParamsRequest, InquirePriceCreateDBInstancesResponse, DescribeSecurityGroupResponse, ResetDBInstancePasswordResponse, DescribeDBInstanceDealRequest, DescribeAsyncRequestInfoRequest, CreateBackupDownloadTaskRequest, InquirePriceModifyDBInstanceSpecResponse, DescribeDBInstanceNodePropertyResponse, DescribeCurrentOpRequest, DescribeDBBackupsRequest, DescribeClientConnectionsRequest, TerminateDBInstancesResponse, RenameInstanceRequest, RenewDBInstancesResponse, FlashBackDBInstanceResponse, RenameInstanceResponse, CreateBackupDBInstanceRequest, SetAccountUserPrivilegeRequest, KillOpsResponse, IsolateDBInstanceRequest, CreateDBInstanceHourRequest, AssignProjectRequest, CreateBackupDownloadTaskResponse, DescribeSlowLogPatternsRequest, DescribeSpecInfoResponse, InquirePriceRenewDBInstancesResponse, DeleteAccountUserResponse, DescribeDBInstancesResponse, OfflineIsolatedDBInstanceRequest, InquirePriceCreateDBInstancesRequest, DescribeInstanceParamsResponse, SetInstanceMaintenanceRequest, ModifyDBInstanceSpecResponse, RenewDBInstancesRequest } from "./mongodb_models";
4
4
  /**
5
5
  * mongodb client
6
6
  * @class
@@ -75,6 +75,11 @@ export declare class Client extends AbstractClient {
75
75
  * 本接口用来创建某个备份文件的下载任务
76
76
  */
77
77
  CreateBackupDownloadTask(req: CreateBackupDownloadTaskRequest, cb?: (error: string, rep: CreateBackupDownloadTaskResponse) => void): Promise<CreateBackupDownloadTaskResponse>;
78
+ /**
79
+ * 该接口用于发起按 Key 闪回任务,依据数据的闪回 Key(默认为 id)对数据进行极速回档,快速恢复业务。
80
+ **说明:按 Key 闪回于2023年09月11日正式进行公测,在此期间,该接口仅对公测用户开放。**
81
+ */
82
+ FlashBackDBInstance(req: FlashBackDBInstanceRequest, cb?: (error: string, rep: FlashBackDBInstanceResponse) => void): Promise<FlashBackDBInstanceResponse>;
78
83
  /**
79
84
  * 本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。
80
85
  */
@@ -129,6 +129,13 @@ class Client extends abstract_client_1.AbstractClient {
129
129
  async CreateBackupDownloadTask(req, cb) {
130
130
  return this.request("CreateBackupDownloadTask", req, cb);
131
131
  }
132
+ /**
133
+ * 该接口用于发起按 Key 闪回任务,依据数据的闪回 Key(默认为 id)对数据进行极速回档,快速恢复业务。
134
+ **说明:按 Key 闪回于2023年09月11日正式进行公测,在此期间,该接口仅对公测用户开放。**
135
+ */
136
+ async FlashBackDBInstance(req, cb) {
137
+ return this.request("FlashBackDBInstance", req, cb);
138
+ }
132
139
  /**
133
140
  * 本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。
134
141
  */