tencentcloud-sdk-nodejs 4.1.197 → 4.1.198

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 (40) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/bh/v20230418/bh_client.js +20 -8
  3. package/es/services/cynosdb/v20190107/cynosdb_client.js +69 -27
  4. package/es/services/tcb/v20180608/tcb_client.js +50 -20
  5. package/es/services/tione/v20211111/tione_client.js +3 -0
  6. package/package.json +1 -1
  7. package/tencentcloud/common/sdk_version.d.ts +1 -1
  8. package/tencentcloud/common/sdk_version.js +1 -1
  9. package/tencentcloud/services/ags/v20250920/ags_models.d.ts +26 -26
  10. package/tencentcloud/services/bh/v20230418/bh_client.d.ts +25 -9
  11. package/tencentcloud/services/bh/v20230418/bh_client.js +36 -12
  12. package/tencentcloud/services/bh/v20230418/bh_models.d.ts +172 -100
  13. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +23 -15
  14. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +8 -9
  15. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +1 -1
  16. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +85 -29
  17. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +126 -42
  18. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +1260 -456
  19. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +2 -2
  20. package/tencentcloud/services/emr/v20190103/emr_client.js +2 -2
  21. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +16 -0
  22. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +32 -4
  23. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +25 -88
  24. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +9 -0
  25. package/tencentcloud/services/ivld/v20210903/ivld_models.d.ts +31 -31
  26. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +56 -56
  27. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +7 -7
  28. package/tencentcloud/services/monitor/v20230616/monitor_models.d.ts +60 -33
  29. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +4 -5
  30. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +21 -13
  31. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +94 -37
  32. package/tencentcloud/services/tcb/v20180608/tcb_client.js +123 -46
  33. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +1076 -157
  34. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
  35. package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
  36. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +363 -48
  37. package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +1 -1
  38. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +11 -11
  39. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +11 -41
  40. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +62 -0
@@ -82,6 +82,15 @@ export interface ListTablesResponse {
82
82
  */
83
83
  RequestId?: string;
84
84
  }
85
+ /**
86
+ * GetProviders请求参数结构体
87
+ */
88
+ export interface GetProvidersRequest {
89
+ /**
90
+ * 环境 ID,用于指定需要查询配置第三方身份源的云开发环境。
91
+ */
92
+ EnvId: string;
93
+ }
85
94
  /**
86
95
  * 订单信息
87
96
  */
@@ -159,6 +168,19 @@ export interface CheckTcbServiceResponse {
159
168
  */
160
169
  RequestId?: string;
161
170
  }
171
+ /**
172
+ * 可以为每种语言配置一个字符串。比如:name,中文展示为:名字,英文展示为 name,韩文展示为:이름
173
+ */
174
+ export interface LocalizedMessage {
175
+ /**
176
+ * 默认展示的文本
177
+ */
178
+ Message: string;
179
+ /**
180
+ * 针对每种语言展示的文字
181
+ */
182
+ Localized?: Array<MessageLocalized>;
183
+ }
162
184
  /**
163
185
  * DescribeCloudBaseRunServerVersion请求参数结构体
164
186
  */
@@ -388,17 +410,75 @@ export interface ModifyEnvPlanRequest {
388
410
  AutoVoucher?: boolean;
389
411
  }
390
412
  /**
391
- * http访问服务客户端限频
413
+ * AddProvider请求参数结构体
392
414
  */
393
- export interface CloudBaseClientQPSPolicy {
415
+ export interface AddProviderRequest {
394
416
  /**
395
- * UserID 或 ClientIP 或 None,如果为 None 代表不限制
417
+ * 云开发环境 ID,用于唯一标识当前操作所属的云开发环境。
396
418
  */
397
- LimitBy?: string;
419
+ EnvId: string;
398
420
  /**
399
- * 限制值
421
+ * 身份源的显示名称,支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段,建议根据实际业务场景填写易于识别的名称,例如:企业微信、GitHub 等。
400
422
  */
401
- LimitValue?: number;
423
+ Name: LocalizedMessage;
424
+ /**
425
+ * 身份源协议类型,决定该身份源使用何种认证协议与第三方平台对接。可选值:
426
+ OAUTH:标准 OAuth 2.0 协议
427
+ OIDC:OpenID Connect 协议
428
+ SAML:SAML 2.0 协议
429
+ WX_MICRO_APP:微信小程序登录
430
+ WX_QRCODE_MICRO_APP:微信小程序扫码登录
431
+ WX_CLOUDBASE_MICRO_APP:云开发托管小程序登录
432
+ WX_MP:微信公众号网页授权登录
433
+ WX_OPEN:微信开放平台扫码登录
434
+ WX_WORK_INTERNAL:企业微信自建应用登录
435
+ WX_WORK_AGENT:企业微信代开发应用登录
436
+ WX_WORK_THIRD_PARTY:企业微信第三方应用登录
437
+ WX_WORK_THIRD_PARTY_ASSOCIATION:企业微信第三方应用关联登录
438
+ CUSTOM:自定义登录
439
+ EMAIL:邮箱登录
440
+ */
441
+ ProviderType: string;
442
+ /**
443
+ * 身份源的唯一标识符,用于在系统内区分不同的身份源。格式要求:2~32 位,仅支持小写英文字母和数字,不可包含空格或特殊字符。若不填写,系统将自动生成。例如:github、google。
444
+ */
445
+ Id?: string;
446
+ /**
447
+ * 身份源图标的访问地址,将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度,支持 HTTP/HTTPS 公网可访问的图片链接。
448
+ */
449
+ Picture?: string;
450
+ /**
451
+ * 身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示,帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写:https://github.com。
452
+ */
453
+ Homepage?: string;
454
+ /**
455
+ * 身份认证源协议连接配置,包含与第三方平台对接所需的核心参数,如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope、SAML Metadata、请求和响应参数映射等。不同 ProviderType 对应不同的配置项要求。
456
+ */
457
+ Config?: ProviderConfig;
458
+ /**
459
+ * 是否开启透传登录模式。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE,企业微信代开发应用 WX_WORK_AGENT 类型默认为 TRUE)。开启后,平台不会持久化存储用户数据,仅将第三方身份源返回的用户信息透传给业务方,适用于不希望平台留存用户数据的场景。注意:开启透传模式时,ReuseUserId 将自动设为 TRUE,AutoSignUpWithProviderUser 将自动设为 FALSE。
460
+ */
461
+ TransparentMode?: string;
462
+ /**
463
+ * 身份源的详细描述信息,支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景,例如:谷歌授权登录。
464
+ */
465
+ Description?: LocalizedMessage;
466
+ /**
467
+ * 是否直接复用第三方身份源的用户 ID 作为平台的用户 ID。可选值:TRUE(直接复用,适用于已有用户体系迁移场景)、FALSE(不复用,由平台生成独立用户 ID)、UNSPECIFIED(默认为 FALSE,但当 TransparentMode 为 TRUE 时自动设为 TRUE)。注意:开启后需确保第三方用户 ID 的唯一性,避免 ID 冲突。
468
+ */
469
+ ReuseUserId?: string;
470
+ /**
471
+ * 身份源的启用状态。可选值:TRUE(启用,用户可通过该身份源登录)、FALSE(禁用,登录入口将被隐藏,已有绑定关系不受影响)、UNSPECIFIED(默认为 TRUE)。
472
+ */
473
+ On?: string;
474
+ /**
475
+ * 是否开启邮箱自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE)。开启后,若第三方身份源返回的邮箱与系统中已有用户的邮箱一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。
476
+ */
477
+ AutoSignInWhenEmailMatch?: string;
478
+ /**
479
+ * 是否开启手机号自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认行为等同 TRUE)。开启后,若第三方身份源返回的手机号与系统中已有用户的手机号一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。注意:该字段默认行为(UNSPECIFIED)与 AutoSignInWhenEmailMatch 不同,手机号匹配在未显式关闭时默认生效。
480
+ */
481
+ AutoSignInWhenPhoneNumberMatch?: string;
402
482
  }
403
483
  /**
404
484
  * ModifyClsTopic返回参数结构体
@@ -409,6 +489,15 @@ export interface ModifyClsTopicResponse {
409
489
  */
410
490
  RequestId?: string;
411
491
  }
492
+ /**
493
+ * DeleteProvider返回参数结构体
494
+ */
495
+ export interface DeleteProviderResponse {
496
+ /**
497
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
498
+ */
499
+ RequestId?: string;
500
+ }
412
501
  /**
413
502
  * 本类型用于UpdateTable接口中描述待创建索引信息
414
503
  */
@@ -646,33 +735,33 @@ export interface BindCloudBaseAccessDomainResponse {
646
735
  RequestId?: string;
647
736
  }
648
737
  /**
649
- * 云日志服务相关信息
738
+ * 邮箱smtp配置
650
739
  */
651
- export interface LogServiceInfo {
740
+ export interface EmailSmtpConfig {
652
741
  /**
653
- * log名
742
+ * 邮件发送者的邮箱地址,即收件人看到的发件人地址。需为有效的邮箱格式,且须与 SMTP 服务器的授权账号一致,否则可能被邮件服务商拒绝发送。例如:abc@example.com
654
743
  */
655
- LogsetName?: string;
744
+ SenderAddress?: string;
656
745
  /**
657
- * log-id
746
+ * SMTP 邮件服务器的域名或 IP 地址,用于建立邮件发送连接。不同邮件服务商的 SMTP 地址不同,例如 QQ 邮箱为 smtp.qq.com,Gmail 为 smtp.gmail.com,请以实际服务商提供的地址为准。
658
747
  */
659
- LogsetId?: string;
748
+ ServerHost?: string;
660
749
  /**
661
- * topic名
750
+ * SMTP 邮件服务器的端口号,需与所选安全模式(SecurityMode)匹配。常用端口:465(SSL 加密)、587(STARTTLS 加密)、25(无加密,不推荐)。建议优先使用 465 或 587 以保障传输安全。
662
751
  */
663
- TopicName?: string;
752
+ ServerPort?: number;
664
753
  /**
665
- * topic-id
754
+ * SMTP 服务器的登录账号,通常为发件人的完整邮箱地址。部分邮件服务商支持使用独立的 SMTP 授权账号,请以实际服务商的要求为准。
666
755
  */
667
- TopicId?: string;
756
+ AccountUsername?: string;
668
757
  /**
669
- * cls日志所属地域
758
+ * SMTP 服务器的登录密码。注意:部分邮件服务商(如 QQ 邮箱、163 邮箱)不支持直接使用账号登录密码,需在邮箱设置中开启 SMTP 服务并生成专用的授权码,请以实际服务商的要求为准。
670
759
  */
671
- Region?: string;
760
+ AccountPassword?: string;
672
761
  /**
673
- * topic保存时长 默认7天
762
+ * SMTP 连接的加密模式,用于保障邮件传输安全。可选值:AUTO(自动选择,优先使用安全连接)、SSL(全程 SSL/TLS 加密,通常配合端口 465 使用)、STARTSSL(通过 STARTTLS 命令升级为加密连接,通常配合端口 587 使用)、NO_SSL(不使用加密,仅建议在内网或测试环境中使用)。推荐使用 AUTO 或 SSL 以确保传输安全。
674
763
  */
675
- Period?: number;
764
+ SecurityMode?: string;
676
765
  }
677
766
  /**
678
767
  * DescribeCurveData返回参数结构体
@@ -822,6 +911,15 @@ export interface ModifyClsTopicRequest {
822
911
  */
823
912
  Period?: number;
824
913
  }
914
+ /**
915
+ * DescribeLoginConfig请求参数结构体
916
+ */
917
+ export interface DescribeLoginConfigRequest {
918
+ /**
919
+ * 环境id
920
+ */
921
+ EnvId: string;
922
+ }
825
923
  /**
826
924
  * CreateHostingDomain请求参数结构体
827
925
  */
@@ -856,6 +954,43 @@ export interface TkeClusterInfo {
856
954
  */
857
955
  VersionClbSubnetId?: string;
858
956
  }
957
+ /**
958
+ * ModifyLoginConfig请求参数结构体
959
+ */
960
+ export interface ModifyLoginConfigRequest {
961
+ /**
962
+ * 环境 ID,用于指定需要修改登录策略的云开发环境。
963
+ */
964
+ EnvId: string;
965
+ /**
966
+ * 手机号短信登录开关。设置为 true 开启手机号短信登录,允许用户使用手机号和短信验证码进行登录和注册;设置为 false 关闭手机号短信登录。
967
+ */
968
+ PhoneNumberLogin: boolean;
969
+ /**
970
+ * 邮箱登录开关。设置为 true 开启邮箱登录,允许用户使用邮箱和密码进行登录和注册;设置为 false 关闭邮箱登录。
971
+ */
972
+ EmailLogin: boolean;
973
+ /**
974
+ * 用户名密码登录开关。设置为 true 开启用户名密码登录,允许用户使用用户名和密码进行登录和注册;设置为 false 关闭用户名密码登录。
975
+ */
976
+ UserNameLogin: boolean;
977
+ /**
978
+ * 匿名登录开关。设置为 true 开启匿名登录,允许用户无需注册即可以匿名身份访问应用;设置为 false 关闭匿名登录。
979
+ */
980
+ AnonymousLogin: boolean;
981
+ /**
982
+ * 短信验证码发送配置,用于设置短信验证码的发送通道类型和日发送限额。不传则不修改当前配置。
983
+ */
984
+ SmsVerificationConfig?: VerificationConfig;
985
+ /**
986
+ * MFA 多因子认证登录配置,用于设置多因子认证开关及验证方式(短信、邮箱、TOTP、强制绑定手机号)。不传则不修改当前配置。
987
+ */
988
+ MfaConfig?: MFALoginConfig;
989
+ /**
990
+ * 密码更新策略配置,用于设置首次登录强制修改密码和定期强制修改密码策略。不传则不修改当前配置。
991
+ */
992
+ PwdUpdateStrategy?: PasswordUpdateLoginConfig;
993
+ }
859
994
  /**
860
995
  * ModifyDatabaseACL请求参数结构体
861
996
  */
@@ -930,6 +1065,19 @@ export interface MySQLNetDetail {
930
1065
  */
931
1066
  SubnetName?: string;
932
1067
  }
1068
+ /**
1069
+ * CreateEnvResource请求参数结构体
1070
+ */
1071
+ export interface CreateEnvResourceRequest {
1072
+ /**
1073
+ * 环境ID
1074
+ */
1075
+ EnvId: string;
1076
+ /**
1077
+ * 资源类型。代表本次开通哪些资源。 可取值以及含义: - log : 表示日志资源,当前仅支持 log(日志资源类型),后续版本可能扩展,该数组不能为空,且每个元素必须为合法的资源类型值
1078
+ */
1079
+ Resources: Array<string>;
1080
+ }
933
1081
  /**
934
1082
  * 本类型用于接口中描述待创建索引结构
935
1083
  */
@@ -956,6 +1104,19 @@ export interface DescribeHostingDomainTaskRequest {
956
1104
  */
957
1105
  EnvId: string;
958
1106
  }
1107
+ /**
1108
+ * 邮箱登录配置
1109
+ */
1110
+ export interface EmailProviderConfig {
1111
+ /**
1112
+ * smtp配置
1113
+ */
1114
+ SmtpConfig?: EmailSmtpConfig;
1115
+ /**
1116
+ * 可选:TRUE,FALSE,如果On为TRUE,则表示采用默认代发。
1117
+ */
1118
+ On?: string;
1119
+ }
959
1120
  /**
960
1121
  * 查询用户返回结果
961
1122
  */
@@ -1043,6 +1204,19 @@ export interface CreateBillDealResponse {
1043
1204
  */
1044
1205
  RequestId?: string;
1045
1206
  }
1207
+ /**
1208
+ * DestroyMySQL返回参数结构体
1209
+ */
1210
+ export interface DestroyMySQLResponse {
1211
+ /**
1212
+ * 销毁结果
1213
+ */
1214
+ Data?: DestroyMySQLResult;
1215
+ /**
1216
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1217
+ */
1218
+ RequestId?: string;
1219
+ }
1046
1220
  /**
1047
1221
  * 开通Mysql 结果
1048
1222
  */
@@ -1052,6 +1226,47 @@ export interface CreateMySQLResult {
1052
1226
  */
1053
1227
  TaskId?: string;
1054
1228
  }
1229
+ /**
1230
+ * http访问服务客户端限频
1231
+ */
1232
+ export interface CloudBaseClientQPSPolicy {
1233
+ /**
1234
+ * UserID 或 ClientIP 或 None,如果为 None 代表不限制
1235
+ */
1236
+ LimitBy?: string;
1237
+ /**
1238
+ * 限制值
1239
+ */
1240
+ LimitValue?: number;
1241
+ }
1242
+ /**
1243
+ * ModifySafeRule请求参数结构体
1244
+ */
1245
+ export interface ModifySafeRuleRequest {
1246
+ /**
1247
+ * 环境ID
1248
+ */
1249
+ EnvId: string;
1250
+ /**
1251
+ * 集合名称
1252
+ */
1253
+ CollectionName: string;
1254
+ /**
1255
+ * 权限标签。包含以下取值:
1256
+ <li> READONLY:所有用户可读,仅创建者和管理员可写</li>
1257
+ <li> PRIVATE:仅创建者及管理员可读写</li>
1258
+ <li> ADMINWRITE:所有用户可读,仅管理员可写</li>
1259
+ <li> ADMINONLY:仅管理员可读写</li>
1260
+ <li> CUSTOM:自定义安全规则</li>
1261
+ */
1262
+ AclTag: string;
1263
+ /**
1264
+ * 安全规则内容。
1265
+ 当 AclTag=CUSTOM 时,此参数必填。
1266
+ 详情参考:[文档型数据库安全规则](https://docs.cloudbase.net/database/security-rules)
1267
+ */
1268
+ Rule?: string;
1269
+ }
1055
1270
  /**
1056
1271
  * 键值对
1057
1272
  */
@@ -1106,6 +1321,42 @@ export interface RunCommandsResponse {
1106
1321
  */
1107
1322
  RequestId?: string;
1108
1323
  }
1324
+ /**
1325
+ * 静态托管资源信息
1326
+ */
1327
+ export interface StaticStoreInfo {
1328
+ /**
1329
+ * 环境ID
1330
+ 注意:此字段可能返回 null,表示取不到有效值。
1331
+ */
1332
+ EnvId?: string;
1333
+ /**
1334
+ * 静态域名
1335
+ 注意:此字段可能返回 null,表示取不到有效值。
1336
+ */
1337
+ CdnDomain?: string;
1338
+ /**
1339
+ * COS桶
1340
+ 注意:此字段可能返回 null,表示取不到有效值。
1341
+ */
1342
+ Bucket?: string;
1343
+ /**
1344
+ * cos区域
1345
+ 注意:此字段可能返回 null,表示取不到有效值。
1346
+ * @deprecated
1347
+ */
1348
+ Regoin?: string;
1349
+ /**
1350
+ * 资源状态:init(初始化)/process(处理中)/online(上线)/destroying(销毁中)/offline(下线))
1351
+ 注意:此字段可能返回 null,表示取不到有效值。
1352
+ */
1353
+ Status?: string;
1354
+ /**
1355
+ * 地域
1356
+ 注意:此字段可能返回 null,表示取不到有效值。
1357
+ */
1358
+ Region?: string;
1359
+ }
1109
1360
  /**
1110
1361
  * RunSql返回参数结构体
1111
1362
  */
@@ -1127,6 +1378,63 @@ export interface RunSqlResponse {
1127
1378
  */
1128
1379
  RequestId?: string;
1129
1380
  }
1381
+ /**
1382
+ * 三方认证入参映射。如果您的对接方不标准,则可以使用这个参数。默认情况下,该参数可以为空。比如:github,google,apple 接入,这些参数为空,但是国内的腾讯,新浪等则需要配置该参数。原因主要是:腾讯等公司在实现oauth时,未能完全遵循oauth标准。
1383
+ */
1384
+ export interface ProviderRequestParametersMap {
1385
+ /**
1386
+ * OAuth 标准协议中的 client_id。不同第三方平台的字段名称可能不同,例如微信平台对应 appid、新浪微博对应 app_id。
1387
+ */
1388
+ ClientId?: string;
1389
+ /**
1390
+ * OAuth 标准协议中的 client_secret,用于身份认证源的密钥鉴权。请妥善保管,避免泄露。
1391
+ */
1392
+ ClientSecret?: string;
1393
+ /**
1394
+ * OAuth 标准协议中的 redirect_uri,即授权回调地址。用户完成第三方认证后将重定向至该地址。
1395
+ */
1396
+ RedirectUri?: string;
1397
+ /**
1398
+ * 身份源注册用户时自动绑定的角色 ID。配置后,通过该身份源注册的新用户将自动关联指定角色。
1399
+ */
1400
+ RegisterUserRoleId?: string;
1401
+ /**
1402
+ * 身份源注册用户时是否自动授予许可证。取值范围:
1403
+ TRUE:自动授权许可证
1404
+ FALSE:不自动授权(默认值)
1405
+ */
1406
+ RegisterUserAutoLicense?: string;
1407
+ /**
1408
+ * OAuth 获取 Token 时认证信息的请求位置。取值范围:
1409
+ URL:将认证信息放在请求 URL 参数中
1410
+ Headers:将认证信息放在请求 Header 中
1411
+ Body:将认证信息放在请求 Body 中
1412
+ */
1413
+ AuthPosition?: string;
1414
+ /**
1415
+ * OAuth 授权模式匹配的参数字段名。用于指定获取 Token 请求中 grant_type 参数对应的字段名称。
1416
+ */
1417
+ GrantType?: string;
1418
+ /**
1419
+ * OAuth 授权模式类型。用于指定 grant_type 的值,例如 client_credentials 表示客户端凭证模式。
1420
+ */
1421
+ ClientCredentials?: string;
1422
+ /**
1423
+ * OAuth 返回中 access_token 的映射字段名。若第三方平台返回的 Token 字段名不是标准的 access_token,可通过此字段指定实际字段名。
1424
+ */
1425
+ AccessToken?: string;
1426
+ /**
1427
+ * OAuth 返回中 Token 有效期的映射字段名。若第三方平台返回的有效期字段名不是标准的 expires_in,可通过此字段指定实际字段名。
1428
+ */
1429
+ ExpiresIn?: string;
1430
+ /**
1431
+ * 身份源注册用户时的用户类型。取值范围:
1432
+ externalUser:外部用户
1433
+ internalUser:内部用户
1434
+ 默认值为 externalUser。
1435
+ */
1436
+ RegisterUserType?: string;
1437
+ }
1130
1438
  /**
1131
1439
  * CreateUser返回参数结构体
1132
1440
  */
@@ -1241,6 +1549,15 @@ export interface Tag {
1241
1549
  */
1242
1550
  Value: string;
1243
1551
  }
1552
+ /**
1553
+ * ModifyClient返回参数结构体
1554
+ */
1555
+ export interface ModifyClientResponse {
1556
+ /**
1557
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1558
+ */
1559
+ RequestId?: string;
1560
+ }
1244
1561
  /**
1245
1562
  * EditAuthConfig返回参数结构体
1246
1563
  */
@@ -1269,13 +1586,38 @@ export interface RenewEnvRequest {
1269
1586
  AutoVoucher?: boolean;
1270
1587
  }
1271
1588
  /**
1272
- * DestroyMySQL返回参数结构体
1589
+ * DescribeClient返回参数结构体
1273
1590
  */
1274
- export interface DestroyMySQLResponse {
1591
+ export interface DescribeClientResponse {
1275
1592
  /**
1276
- * 销毁结果
1593
+ * 客户端的唯一标识符(Client ID),在 OAuth/OIDC 授权流程中作为 client_id 参数使用。创建时仅可传入环境 ID 或留空:传入环境 ID 时将直接使用该值作为客户端 ID(一个环境仅允许一个);留空时由系统自动生成与环境 ID 关联的唯一 ID。创建后不可修改。
1277
1594
  */
1278
- Data?: DestroyMySQLResult;
1595
+ Id?: string;
1596
+ /**
1597
+ * 客户端的创建时间,格式遵循 ISO 8601 标准(如:2024-01-01T00:00:00Z),由系统自动生成,不可手动修改。
1598
+ 注意:此字段可能返回 null,表示取不到有效值。
1599
+ */
1600
+ CreatedAt?: string;
1601
+ /**
1602
+ * 客户端信息的最后修改时间,格式遵循 ISO 8601 标准(如:2024-01-01T00:00:00Z),每次更新应用配置时由系统自动更新。
1603
+ 注意:此字段可能返回 null,表示取不到有效值。
1604
+ */
1605
+ UpdatedAt?: string;
1606
+ /**
1607
+ * Refresh Token 的有效期,单位为秒。超过该时间后 Refresh Token 将失效,用户需重新登录。取值范围:最小 1800 秒(30 分钟),最大 2592000 秒(30 天),超出上限将自动截断为 30 天。若不设置则默认为 30 天。当该值小于等于 7200 秒时,系统会自动将 AccessTokenExpiresIn 调整为 RefreshTokenExpiresIn - 660 秒。
1608
+ 注意:此字段可能返回 null,表示取不到有效值。
1609
+ */
1610
+ RefreshTokenExpiresIn?: number;
1611
+ /**
1612
+ * Access Token 的有效期,单位为秒。超过该时间后 Access Token 将失效,需通过 Refresh Token 换取新的 Access Token。若不设置则默认为 7200 秒(2 小时)。设置值小于 1800 秒时将被忽略,使用系统默认值。
1613
+ 注意:此字段可能返回 null,表示取不到有效值。
1614
+ */
1615
+ AccessTokenExpiresIn?: number;
1616
+ /**
1617
+ * 单个用户在该客户端下允许同时登录的最大会话数量。取值范围:-1 至 50。-1 表示不限制设备数量;0 或不填默认按 User-Agent 区分设备(相同 User-Agent 共享一个会话,不同 User-Agent 各独立一个会话);1 表示单设备登录,新登录将踢出旧会话;大于 1 时按真实设备 ID 限制,超出限制后最早登录的会话将被自动踢出。
1618
+ 注意:此字段可能返回 null,表示取不到有效值。
1619
+ */
1620
+ MaxDevice?: number;
1279
1621
  /**
1280
1622
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1281
1623
  */
@@ -1300,11 +1642,32 @@ export interface ModifyEnvPlanResponse {
1300
1642
  RequestId?: string;
1301
1643
  }
1302
1644
  /**
1303
- * DescribeCreateMySQLResult请求参数结构体
1645
+ * RunSql请求参数结构体
1304
1646
  */
1305
- export interface DescribeCreateMySQLResultRequest {
1647
+ export interface RunSqlRequest {
1306
1648
  /**
1307
- * 云开发环境ID
1649
+ * 要执行的SQL语句
1650
+ */
1651
+ Sql: string;
1652
+ /**
1653
+ * 云开发环境ID
1654
+ */
1655
+ EnvId: string;
1656
+ /**
1657
+ * 数据库连接器实例信息
1658
+ */
1659
+ DbInstance?: DbInstance;
1660
+ /**
1661
+ * 是否只读;当 `true` 时仅允许以 `SELECT/WITH/SHOW/DESCRIBE/DESC/EXPLAIN` 开头的 SQL
1662
+ */
1663
+ ReadOnly?: boolean;
1664
+ }
1665
+ /**
1666
+ * DescribeCreateMySQLResult请求参数结构体
1667
+ */
1668
+ export interface DescribeCreateMySQLResultRequest {
1669
+ /**
1670
+ * 云开发环境ID
1308
1671
  */
1309
1672
  EnvId: string;
1310
1673
  /**
@@ -1453,6 +1816,81 @@ export interface DeleteAuthDomainResponse {
1453
1816
  */
1454
1817
  RequestId?: string;
1455
1818
  }
1819
+ /**
1820
+ * ModifyProvider请求参数结构体
1821
+ */
1822
+ export interface ModifyProviderRequest {
1823
+ /**
1824
+ * 云开发环境 ID,用于唯一标识当前操作所属的云开发环境。
1825
+ */
1826
+ EnvId: string;
1827
+ /**
1828
+ * 身份源的唯一标识符,用于指定需要修改的目标身份源。格式要求:2~32 位,仅支持小写英文字母和数字,不可包含空格或特殊字符。例如:github、google。
1829
+ */
1830
+ Id: string;
1831
+ /**
1832
+ * 身份源的显示名称,支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段,建议根据实际业务场景填写易于识别的名称,例如:GitHub、Google 等。
1833
+ */
1834
+ Name?: LocalizedMessage;
1835
+ /**
1836
+ * 身份源图标的访问地址,将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度,支持 HTTP/HTTPS 公网可访问的图片链接。
1837
+ */
1838
+ Picture?: string;
1839
+ /**
1840
+ * 身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示,帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写:https://github.com。
1841
+ */
1842
+ Homepage?: string;
1843
+ /**
1844
+ * 身份源协议类型,决定该身份源使用何种认证协议与第三方平台对接。可选值:
1845
+ OAUTH:标准 OAuth 2.0 协议
1846
+ OIDC:OpenID Connect 协议
1847
+ SAML:SAML 2.0 协议
1848
+ WX_MICRO_APP:微信小程序登录
1849
+ WX_QRCODE_MICRO_APP:微信小程序扫码登录
1850
+ WX_CLOUDBASE_MICRO_APP:云开发托管小程序登录
1851
+ WX_MP:微信公众号网页授权登录
1852
+ WX_OPEN:微信开放平台扫码登录
1853
+ WX_WORK_INTERNAL:企业微信自建应用登录
1854
+ WX_WORK_AGENT:企业微信代开发应用登录
1855
+ WX_WORK_THIRD_PARTY:企业微信第三方应用登录
1856
+ WX_WORK_THIRD_PARTY_ASSOCIATION:企业微信第三方应用关联登录
1857
+ CUSTOM:自定义登录
1858
+ EMAIL:邮箱登录
1859
+ */
1860
+ ProviderType?: string;
1861
+ /**
1862
+ * 身份认证源协议连接配置,包含与第三方平台对接所需的核心参数,如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope、SAML Metadata、请求和响应参数映射等。不同 ProviderType 对应不同的配置项要求。注意:CUSTOM 和 EMAIL 类型的身份源,其存储后端类型(StorageDb)不可修改。
1863
+ */
1864
+ Config?: ProviderConfig;
1865
+ /**
1866
+ * 是否开启透传登录模式。可选值:TRUE(开启)、FALSE(关闭,默认值)。开启后,平台不会持久化存储用户数据,仅将第三方身份源返回的用户信息透传给业务方,适用于不希望平台留存用户数据的场景。注意:开启透传模式时,ReuseUserId 将被强制设为 TRUE,AutoSignUpWithProviderUser 将被强制设为 FALSE。
1867
+ */
1868
+ TransparentMode?: string;
1869
+ /**
1870
+ * 身份源的启用状态。可选值:TRUE(启用,用户可通过该身份源登录)、FALSE(禁用,登录入口将被隐藏,已有绑定关系不受影响)、UNSPECIFIED(默认为 TRUE)。
1871
+ */
1872
+ On?: string;
1873
+ /**
1874
+ * 身份源的详细描述信息,支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景,例如:谷歌授权登录。
1875
+ */
1876
+ Description?: LocalizedMessage;
1877
+ /**
1878
+ * 是否直接复用第三方身份源的用户 ID 作为平台用户 ID。可选值:TRUE(开启,返回的用户 ID 将直接使用第三方身份源的用户 ID,适用于已有用户体系迁移场景)、FALSE(关闭,由平台生成独立用户 ID)、UNSPECIFIED(默认为 FALSE,但当 TransparentMode 为 TRUE 时将被强制设为 TRUE)。注意:开启后需确保第三方用户 ID 的全局唯一性,避免 ID 冲突。
1879
+ */
1880
+ ReuseUserId?: string;
1881
+ /**
1882
+ * 邮箱身份源的专项配置,包含邮件服务商、发件人地址、SMTP 配置等参数,用于支持通过邮箱验证码或邮箱密码方式进行身份认证。仅当身份源 ID 为 email 时有效。若该身份源不存在,系统将自动创建一个默认关闭的邮箱身份源。
1883
+ */
1884
+ EmailConfig?: EmailProviderConfig;
1885
+ /**
1886
+ * 是否开启邮箱自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE)。开启后,若第三方身份源返回的邮箱与系统中已有用户的邮箱一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。
1887
+ */
1888
+ AutoSignInWhenEmailMatch?: string;
1889
+ /**
1890
+ * 是否开启手机号自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认行为等同 TRUE)。开启后,若第三方身份源返回的手机号与系统中已有用户的手机号一致,则自动将该第三方账号与已有用户关联并完成登录,无需用户手动绑定。注意:该字段默认行为(UNSPECIFIED)与 AutoSignInWhenEmailMatch 不同,手机号匹配在未显式关闭时默认生效。
1891
+ */
1892
+ AutoSignInWhenPhoneNumberMatch?: string;
1893
+ }
1456
1894
  /**
1457
1895
  * DeleteTable请求参数结构体
1458
1896
  */
@@ -1575,25 +2013,13 @@ export interface DeleteTableResponse {
1575
2013
  RequestId?: string;
1576
2014
  }
1577
2015
  /**
1578
- * RunSql请求参数结构体
2016
+ * AddProvider返回参数结构体
1579
2017
  */
1580
- export interface RunSqlRequest {
2018
+ export interface AddProviderResponse {
1581
2019
  /**
1582
- * 要执行的SQL语句
1583
- */
1584
- Sql: string;
1585
- /**
1586
- * 云开发环境ID
1587
- */
1588
- EnvId: string;
1589
- /**
1590
- * 数据库连接器实例信息
1591
- */
1592
- DbInstance?: DbInstance;
1593
- /**
1594
- * 是否只读;当 `true` 时仅允许以 `SELECT/WITH/SHOW/DESCRIBE/DESC/EXPLAIN` 开头的 SQL
2020
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1595
2021
  */
1596
- ReadOnly?: boolean;
2022
+ RequestId?: string;
1597
2023
  }
1598
2024
  /**
1599
2025
  * DestroyMySQL请求参数结构体
@@ -1701,6 +2127,43 @@ export interface DescribeEnvsResponse {
1701
2127
  */
1702
2128
  RequestId?: string;
1703
2129
  }
2130
+ /**
2131
+ * ListTables请求参数结构体
2132
+ */
2133
+ export interface ListTablesRequest {
2134
+ /**
2135
+ * 每页返回数量(0-1000)
2136
+ */
2137
+ MgoLimit: number;
2138
+ /**
2139
+ * FlexDB实例ID
2140
+ */
2141
+ Tag?: string;
2142
+ /**
2143
+ * 分页偏移量
2144
+ */
2145
+ MgoOffset?: number;
2146
+ /**
2147
+ * 过滤标签数组,用于过滤表名,可选值如:HIDDEN、WEDA、WEDA_SYSTEM
2148
+ */
2149
+ Filters?: Array<string>;
2150
+ /**
2151
+ * 模糊搜索查询值
2152
+ */
2153
+ SearchValue?: string;
2154
+ /**
2155
+ * 是否展示隐藏表
2156
+ */
2157
+ ShowHidden?: boolean;
2158
+ /**
2159
+ * 云开发环境ID
2160
+ */
2161
+ EnvId?: string;
2162
+ /**
2163
+ * mongo连接器信息
2164
+ */
2165
+ MongoConnector?: MongoConnector;
2166
+ }
1704
2167
  /**
1705
2168
  * CreateAuthDomain请求参数结构体
1706
2169
  */
@@ -1870,6 +2333,78 @@ export interface SearchClsLogResponse {
1870
2333
  */
1871
2334
  RequestId?: string;
1872
2335
  }
2336
+ /**
2337
+ * 身份源配置信息。描述云开发环境下用户登录身份源的完整配置,定义了用户通过何种方式进入系统并完成身份认证。支持多种类型:包括标准协议身份源(OAuth 2.0、OIDC、SAML 2.0)、内置身份源(邮箱登录、自定义登录)以及通过插件机制扩展的身份源(如 CAS)。每个身份源包含认证配置、启用状态、用户自动注册策略、信息透传模式等核心属性,是登录认证流程的核心数据结构。
2338
+ */
2339
+ export interface Provider {
2340
+ /**
2341
+ * 身份源的唯一标识符,用于在系统内区分不同的身份源。格式要求:2~32 位,仅支持小写英文字母和数字,不可包含空格或特殊字符。创建后不可修改
2342
+ */
2343
+ Id: string;
2344
+ /**
2345
+ * 身份源的安全认证配置,包含与第三方平台对接所需的核心参数,如 ClientId、ClientSecret、授权端点、Token 端点、回调地址、Scope 等。不同 ProviderType 对应不同的配置项。CUSTOM 类型无需手动配置(系统自动填充),OIDC 类型会根据 Issuer 自动补全端点信息,SAML 类型需提供 SamlMetadata(最大 10KB)
2346
+ */
2347
+ Config: ProviderConfig;
2348
+ /**
2349
+ * 身份源的显示名称,支持国际化多语言配置。用户在登录页面看到的身份源名称将使用该字段,建议根据实际业务场景填写易于识别的名称。未传入时默认使用 Id 值作为显示名称
2350
+ */
2351
+ Name?: LocalizedMessage;
2352
+ /**
2353
+ * 身份源图标的访问地址,将展示在登录页的身份源按钮上。建议使用 64×64 像素的 SVG 格式图片以保证清晰度,支持 HTTP/HTTPS 公网可访问的图片链接
2354
+ 注意:此字段可能返回 null,表示取不到有效值。
2355
+ */
2356
+ Picture?: string;
2357
+ /**
2358
+ * 身份源对应的官方主页地址。该信息将在用户查看自己的第三方账号绑定列表时展示,帮助用户识别已绑定的身份源来源。例如 GitHub 身份源可填写:https://github.com
2359
+ 注意:此字段可能返回 null,表示取不到有效值。
2360
+ */
2361
+ Homepage?: string;
2362
+ /**
2363
+ * 身份源协议类型,决定该身份源使用何种认证协议与第三方平台对接。可选值:OAUTH(标准 OAuth 2.0 协议)、OIDC(OpenID Connect 协议)、SAML(SAML 2.0 协议)、CUSTOM(自定义登录,使用 RSA 密钥对签名验证)、EMAIL(邮箱登录,需配合 EmailConfig 使用)
2364
+ 注意:此字段可能返回 null,表示取不到有效值。
2365
+ */
2366
+ ProviderType?: string;
2367
+ /**
2368
+ * 控制第三方身份源登录时是否自动注册系统用户。可选值:TRUE(始终自动注册,无论第三方返回的用户信息是否包含手机号或邮箱)、FALSE(不自动注册,需用户手动绑定)、UNSPECIFIED(默认行为:仅当第三方身份源返回的用户信息中包含手机号或邮箱时才自动注册,否则登录完成后要求用户绑定手机号方可继续使用)。注意:企业微信类型(WX_WORK_AGENT/WX_WORK_INTERNAL/WX_WORK_THIRD_PARTY/WX_WORK_THIRD_PARTY_ASSOCIATION)和微信小程序类型(WX_MICRO_APP/WX_QRCODE_MICRO_APP/WX_OPEN)在 UNSPECIFIED 时会自动设为 TRUE。当 TransparentMode 为 TRUE 时,该字段将被强制设为 FALSE
2369
+ 注意:此字段可能返回 null,表示取不到有效值。
2370
+ */
2371
+ AutoSignUpWithProviderUser?: string;
2372
+ /**
2373
+ * 身份源的启用状态。可选值:TRUE(启用,用户可通过该身份源登录)、FALSE(禁用,已有绑定关系不受影响)。未传入时默认为 TRUE(启用)
2374
+ 注意:此字段可能返回 null,表示取不到有效值。
2375
+ */
2376
+ On?: string;
2377
+ /**
2378
+ * 身份源的详细描述信息,支持国际化多语言配置。可用于向用户说明该身份源的用途或使用场景。
2379
+ 注意:此字段可能返回 null,表示取不到有效值。
2380
+ */
2381
+ Description?: LocalizedMessage;
2382
+ /**
2383
+ * 是否开启信息透传模式。可选值:TRUE(仅登录模式:平台不持久化存储用户数据,仅将第三方身份源返回的用户信息透传给业务方,适用于不希望平台留存用户数据的场景)、FALSE(登录且注册模式:平台正常注册并存储用户信息,默认值)。注意:开启透传模式时,AutoSignUpWithProviderUser 将被强制设为 FALSE;若 ReuseUserId 为 UNSPECIFIED,将被自动设为 TRUE。
2384
+ 注意:此字段可能返回 null,表示取不到有效值。
2385
+ */
2386
+ TransparentMode?: string;
2387
+ /**
2388
+ * 是否直接复用第三方身份源返回的用户标识(如 OpenID、UnionID 等)作为平台用户 ID。可选值:TRUE(开启,平台用户 ID 将直接使用第三方身份源返回的用户标识,适用于已有用户体系迁移场景)、FALSE(关闭,由平台生成独立用户 ID)。注意:开启后需确保第三方用户标识的全局唯一性,避免 ID 冲突。当 TransparentMode 为 TRUE 且该字段为 UNSPECIFIED 时,将被自动设为 TRUE
2389
+ 注意:此字段可能返回 null,表示取不到有效值。
2390
+ */
2391
+ ReuseUserId?: string;
2392
+ /**
2393
+ * 邮箱身份源的专项配置,仅当 ProviderType 为 EMAIL 时有效且必填。包含邮件服务商、发件人地址、SMTP 配置等参数,用于支持通过邮箱验证码方式进行身份认证。支持两种模式:自有 SMTP 服务器(需填写完整的 SMTP 配置)和平台代发(EmailConfig.On 设为 TRUE 时由平台随机分配 SMTP 服务器)
2394
+ 注意:此字段可能返回 null,表示取不到有效值。
2395
+ */
2396
+ EmailConfig?: EmailProviderConfig;
2397
+ /**
2398
+ * 是否开启邮箱自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认为 FALSE)。开启后,若第三方身份源返回的邮箱与系统中已有用户的邮箱一致,则自动将该第三方账号与已有用户关联绑定并完成登录,无需用户手动绑定
2399
+ 注意:此字段可能返回 null,表示取不到有效值。
2400
+ */
2401
+ AutoSignInWhenEmailMatch?: string;
2402
+ /**
2403
+ * 是否开启手机号自动关联登录。可选值:TRUE(开启)、FALSE(关闭)、UNSPECIFIED(默认行为等同于 TRUE,即默认开启)。开启后,若第三方身份源返回的手机号与系统中已有用户的手机号一致,则自动将该第三方账号与已有用户关联绑定并完成登录,无需用户手动绑定
2404
+ 注意:此字段可能返回 null,表示取不到有效值。
2405
+ */
2406
+ AutoSignInWhenPhoneNumberMatch?: string;
2407
+ }
1873
2408
  /**
1874
2409
  * 本类型用于UpdateTable接口中描述待创建索引信息
1875
2410
  */
@@ -1924,6 +2459,43 @@ export interface DescribeSafeRuleResponse {
1924
2459
  */
1925
2460
  RequestId?: string;
1926
2461
  }
2462
+ /**
2463
+ * 登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置,目前提供云开发默认短信包和客户自定义短信包,推荐使用云开发默认短信包。
2464
+ 如果使用自定义APIs发送短信,方法命名规则
2465
+ 方法名称:发送验证码
2466
+ 方法标识:SendVerificationCode
2467
+ 入参
2468
+ Mobile:字符串(手机号,如:“+86 + 手机号”)
2469
+ VerificationCode:字符串(验证码,如:“123456”)
2470
+ 返回值
2471
+ ErrorCode:int(0 表示成功,非 0 表示失败)
2472
+ ErrorMessage:字符串(ErrorCode 非 0 时,返回错误信息)
2473
+ */
2474
+ export interface VerificationConfig {
2475
+ /**
2476
+ * 短信验证码发送通道类型。取值范围:
2477
+ default:使用默认云开发短信包发送短信。
2478
+ apis:使用云开发自定义 APIs 作为短信发送通道,需配合 Name 和 Method 参数使用。
2479
+ 不传则不修改当前配置。
2480
+ 注意:此字段可能返回 null,表示取不到有效值。
2481
+ */
2482
+ Type?: string;
2483
+ /**
2484
+ * 自定义 APIs 数据源唯一标识,当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。
2485
+ 注意:此字段可能返回 null,表示取不到有效值。
2486
+ */
2487
+ Name?: string;
2488
+ /**
2489
+ * 自定义 APIs 方法名,当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。
2490
+ 注意:此字段可能返回 null,表示取不到有效值。
2491
+ */
2492
+ Method?: string;
2493
+ /**
2494
+ * 单个手机号每日短信发送上限。默认值为 30,传 -1 表示不限制,如果设置为不限制,需要注意恶意攻击,导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。
2495
+ 注意:此字段可能返回 null,表示取不到有效值。
2496
+ */
2497
+ SmsDayLimit?: number;
2498
+ }
1927
2499
  /**
1928
2500
  * DescribeTables返回参数结构体
1929
2501
  */
@@ -1961,45 +2533,41 @@ export interface DescribeEnvAccountCircleResponse {
1961
2533
  RequestId?: string;
1962
2534
  }
1963
2535
  /**
1964
- * 用户信息
2536
+ * 多因子认证登录配置,用于管理 MFA(Multi-Factor Authentication)相关设置。包括 MFA 总开关、短信验证、邮箱验证、强制绑定手机号、TOTP 动态验证码等认证方式的独立开关配置。当 MFA 总开关(On)开启时,用户在登录后需完成额外的身份验证步骤。各子开关可独立控制具体的验证方式。不传则不修改当前配置。
1965
2537
  */
1966
- export interface User {
1967
- /**
1968
- * 用户ID
1969
- */
1970
- Uid?: string;
1971
- /**
1972
- * 用户名
1973
- */
1974
- Name?: string;
2538
+ export interface MFALoginConfig {
1975
2539
  /**
1976
- * 用户类型:internalUser-内部用户、externalUser-外部用户
1977
- */
1978
- Type?: string;
1979
- /**
1980
- * 用户状态:ACTIVE(激活)、BLOCKED(冻结)
2540
+ * MFA 多因子认证开关。取值范围:
2541
+ TRUE:开启 MFA 多因子认证
2542
+ FALSE:关闭 MFA 多因子认证
2543
+ 不传则不修改当前配置。
2544
+ 注意:此字段可能返回 null,表示取不到有效值。
1981
2545
  */
1982
- UserStatus?: string;
2546
+ On?: string;
1983
2547
  /**
1984
- * 用户昵称
1985
- */
1986
- NickName?: string;
1987
- /**
1988
- * 手机号
2548
+ * 短信验证开关,控制是否在 MFA 流程中启用短信验证码校验。取值范围:
2549
+ TRUE:开启短信验证
2550
+ FALSE:关闭短信验证
2551
+ 不传则不修改当前配置。
2552
+ 注意:此字段可能返回 null,表示取不到有效值。
1989
2553
  */
1990
- Phone?: string;
2554
+ Sms?: string;
1991
2555
  /**
1992
- * 邮箱
2556
+ * 邮箱验证开关,控制是否在 MFA 流程中启用邮箱验证码校验。取值范围:
2557
+ TRUE:开启邮箱验证
2558
+ FALSE:关闭邮箱验证
2559
+ 不传则不修改当前配置。
2560
+ 注意:此字段可能返回 null,表示取不到有效值。
1993
2561
  */
1994
2562
  Email?: string;
1995
2563
  /**
1996
- * 头像链接
1997
- */
1998
- AvatarUrl?: string;
1999
- /**
2000
- * 用户描述
2564
+ * 强制绑定手机号开关,控制用户在完成 MFA 认证前是否必须绑定手机号。取值范围:
2565
+ TRUE:要求绑定手机号
2566
+ FALSE:不要求绑定手机号
2567
+ 不传则不修改当前配置。
2568
+ 注意:此字段可能返回 null,表示取不到有效值。
2001
2569
  */
2002
- Description?: string;
2570
+ RequiredBindPhone?: string;
2003
2571
  }
2004
2572
  /**
2005
2573
  * 待执行命令
@@ -2018,6 +2586,25 @@ export interface MgoCommandParam {
2018
2586
  */
2019
2587
  Command: string;
2020
2588
  }
2589
+ /**
2590
+ * VM规格
2591
+ */
2592
+ export interface VMSpec {
2593
+ /**
2594
+ * LightHouse=轻量云服务器
2595
+ CVM=云服务器
2596
+ */
2597
+ Type?: string;
2598
+ /**
2599
+ * 轻量云服务器规格。
2600
+ 当Type=LightHouse时有效
2601
+ */
2602
+ LightHouseSpec?: VMSpecLightHouse;
2603
+ /**
2604
+ * 价格信息
2605
+ */
2606
+ Price?: VMPrice;
2607
+ }
2021
2608
  /**
2022
2609
  * ModifyDatabaseACL返回参数结构体
2023
2610
  */
@@ -2061,6 +2648,47 @@ export interface CreateTableResponse {
2061
2648
  */
2062
2649
  RequestId?: string;
2063
2650
  }
2651
+ /**
2652
+ * 用户信息
2653
+ */
2654
+ export interface User {
2655
+ /**
2656
+ * 用户ID
2657
+ */
2658
+ Uid?: string;
2659
+ /**
2660
+ * 用户名
2661
+ */
2662
+ Name?: string;
2663
+ /**
2664
+ * 用户类型:internalUser-内部用户、externalUser-外部用户
2665
+ */
2666
+ Type?: string;
2667
+ /**
2668
+ * 用户状态:ACTIVE(激活)、BLOCKED(冻结)
2669
+ */
2670
+ UserStatus?: string;
2671
+ /**
2672
+ * 用户昵称
2673
+ */
2674
+ NickName?: string;
2675
+ /**
2676
+ * 手机号
2677
+ */
2678
+ Phone?: string;
2679
+ /**
2680
+ * 邮箱
2681
+ */
2682
+ Email?: string;
2683
+ /**
2684
+ * 头像链接
2685
+ */
2686
+ AvatarUrl?: string;
2687
+ /**
2688
+ * 用户描述
2689
+ */
2690
+ Description?: string;
2691
+ }
2064
2692
  /**
2065
2693
  * 销毁 Mysql 结果
2066
2694
  */
@@ -2111,6 +2739,85 @@ export interface DescribeCloudBaseGWAPIResponse {
2111
2739
  */
2112
2740
  RequestId?: string;
2113
2741
  }
2742
+ /**
2743
+ * 身份认证源协议连接配置。包含 OAuth 2.0 / OIDC 协议端点(授权端点、令牌端点、用户信息端点、JWKS 端点等)、客户端凭证(ClientId、ClientSecret)、SAML 元数据、请求与响应参数的字段映射等配置信息。OIDC 类型的认证源字段定义参考 https://openid.net/specs/openid-connect-discovery-1_0.html 规范。
2744
+ */
2745
+ export interface ProviderConfig {
2746
+ /**
2747
+ * 身份提供方的唯一标识符(Issuer URL),用于验证 ID Token 中的 iss 字段。仅当 ProviderType 为 OIDC 时需要填写,值通常为第三方 OIDC 服务的根地址,例如:https://accounts.google.com。填写后平台将自动通过 /.well-known/openid-configuration 发现并填充 AuthorizationEndpoint、TokenEndpoint、UserinfoEndpoint、JwksUri 等端点地址。详情参考 OpenID Connect Discovery 标准。
2748
+ 注意:此字段可能返回 null,表示取不到有效值。
2749
+ */
2750
+ Issuer?: string;
2751
+ /**
2752
+ * 第三方身份提供方的 JSON Web Key Set 地址,用于获取公钥以验证 ID Token 签名。仅当 ProviderType 为 OIDC 时需要填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OpenID Connect Discovery 标准。
2753
+ 注意:此字段可能返回 null,表示取不到有效值。
2754
+ */
2755
+ JwksUri?: string;
2756
+ /**
2757
+ * 在第三方身份提供方注册的应用客户端 ID,用于标识当前接入应用。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,可在对应平台的开发者控制台中获取。详情参考 OAuth 2.0 标准。
2758
+ 注意:此字段可能返回 null,表示取不到有效值。
2759
+ */
2760
+ ClientId?: string;
2761
+ /**
2762
+ * 在第三方身份提供方注册的应用客户端密钥,与 ClientId 配合使用,用于在 Token 端点进行身份验证。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,请妥善保管,避免泄露。详情参考 OAuth 2.0 标准。
2763
+ 注意:此字段可能返回 null,表示取不到有效值。
2764
+ */
2765
+ ClientSecret?: string;
2766
+ /**
2767
+ * OAuth 授权完成后第三方平台回调的地址,需与在第三方平台注册的回调地址完全一致,否则授权将失败。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,并需在对应平台的开发者控制台中配置该地址为合法回调地址。详情参考 OAuth 2.0 标准。
2768
+ 注意:此字段可能返回 null,表示取不到有效值。
2769
+ */
2770
+ RedirectUri?: string;
2771
+ /**
2772
+ * 向第三方身份提供方申请的权限范围,多个 scope 之间用空格分隔。当 ProviderType 为 OIDC 或 OAUTH 时必须填写,OIDC 场景下通常至少包含 openid,如需获取用户邮箱或手机号可追加 email、phone 等。若已填写 Issuer 且未指定 Scope,将自动使用 OpenID Connect Discovery 返回的 scopes_supported。详情参考 OAuth 2.0 标准。
2773
+ 注意:此字段可能返回 null,表示取不到有效值。
2774
+ */
2775
+ Scope?: string;
2776
+ /**
2777
+ * 第三方身份提供方的授权端点地址,用于发起 OAuth/OIDC 授权请求,引导用户跳转至第三方登录页面。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
2778
+ 注意:此字段可能返回 null,表示取不到有效值。
2779
+ */
2780
+ AuthorizationEndpoint?: string;
2781
+ /**
2782
+ * 第三方身份提供方的 Token 端点地址,用于通过授权码(code)换取 Access Token 和 ID Token。当 ProviderType 为 OIDC 或 OAUTH 时必须填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OAuth 2.0 / OIDC 标准。
2783
+ 注意:此字段可能返回 null,表示取不到有效值。
2784
+ */
2785
+ TokenEndpoint?: string;
2786
+ /**
2787
+ * 第三方身份提供方的用户信息端点地址,用于通过 Access Token 获取用户的基本信息(如昵称、头像、邮箱等)。当 ProviderType 为 OIDC 或 OAUTH 且需要获取用户详细信息时填写。若已填写 Issuer,该字段将通过 OpenID Connect Discovery 自动获取,无需手动填写。详情参考 OIDC 标准。
2788
+ 注意:此字段可能返回 null,表示取不到有效值。
2789
+ */
2790
+ UserinfoEndpoint?: string;
2791
+ /**
2792
+ * OAuth/OIDC 授权请求的响应类型,决定授权端点返回的内容。可选值:code(授权码模式,推荐)、token(隐式模式,直接返回 Access Token)、id_token(直接返回 ID Token)。当 ProviderType 为 OIDC 时默认使用 id_token,其他类型默认使用 code。当 ProviderType 为 OIDC 或 OAUTH 时可选填写。详情参考 OAuth 2.0 / OIDC 标准。
2793
+ 注意:此字段可能返回 null,表示取不到有效值。
2794
+ */
2795
+ ResponseType?: string;
2796
+ /**
2797
+ * 第三方身份提供方的单点退出端点地址。配置后,用户退出当前应用时将被跳转至该地址,使第三方 IDP 的登录态也一并失效,实现单点退出(SLO)。适用于 OIDC、OAUTH、SAML 等所有支持单点退出的身份源类型。不填则退出时仅清除本平台登录态。
2798
+ 注意:此字段可能返回 null,表示取不到有效值。
2799
+ */
2800
+ SignoutEndpoint?: string;
2801
+ /**
2802
+ * Token 端点的客户端身份验证方式,决定请求 Token 时如何传递 ClientId 和 ClientSecret。可选值:CLIENT_SECRET_POST(将凭证放在请求 Body 中传递)、CLIENT_SECRET_BASIC(将凭证通过 HTTP Basic Auth Header 传递)。当 ProviderType 为 OIDC 或 OAUTH 时可选填写,默认使用 CLIENT_SECRET_POST。详情参考 OIDC 标准。
2803
+ 注意:此字段可能返回 null,表示取不到有效值。
2804
+ */
2805
+ TokenEndpointAuthMethod?: string;
2806
+ /**
2807
+ * SAML 身份提供方的 Metadata XML 内容,包含 IDP 的实体 ID、SSO 端点地址、签名证书等关键信息,平台将据此完成 SAML 协议的对接配置。仅当 ProviderType 为 SAML 时可填写,通常可从第三方 IDP 的管理控制台中下载获取。详情参考 SAML 2.0 标准。
2808
+ */
2809
+ SamlMetadata?: string;
2810
+ /**
2811
+ * 请求参数映射配置,用于处理非标准 OAuth 协议的参数转换。默认情况下平台严格遵循 OAuth 2.0 标准进行参数传递,若对接的第三方平台(如微信、企业微信等)使用了非标准的参数名称或传参方式,可通过该字段配置自定义的参数映射规则,以确保请求参数与第三方平台的要求一致。
2812
+ 注意:此字段可能返回 null,表示取不到有效值。
2813
+ */
2814
+ RequestParametersMap?: ProviderRequestParametersMap;
2815
+ /**
2816
+ * 响应参数映射配置,用于处理非标准 OAuth 协议的响应参数转换。默认情况下平台严格遵循 OAuth 2.0 标准解析响应参数,若对接的第三方平台(如微信、企业微信等)返回了非标准的字段名称或数据结构,可通过该字段配置自定义的响应参数映射规则,将第三方返回的字段映射为平台标准字段。
2817
+ 注意:此字段可能返回 null,表示取不到有效值。
2818
+ */
2819
+ ResponseParametersMap?: ProviderResponseParametersMap;
2820
+ }
2114
2821
  /**
2115
2822
  * DescribeCloudBaseGWAPI请求参数结构体
2116
2823
  */
@@ -2211,6 +2918,35 @@ export interface DatabasesInfo {
2211
2918
  */
2212
2919
  UpdateTime?: string;
2213
2920
  }
2921
+ /**
2922
+ * 虚拟主机价格
2923
+ */
2924
+ export interface VMPrice {
2925
+ /**
2926
+ * 价格货币单位。取值范围CNY:人民币。USD:美元。
2927
+ */
2928
+ Currency?: string;
2929
+ /**
2930
+ * 原始价格
2931
+ */
2932
+ OriginalPrice?: number;
2933
+ /**
2934
+ * 折扣率
2935
+ */
2936
+ Discount?: number;
2937
+ /**
2938
+ * 折扣后的价格
2939
+ */
2940
+ DiscountPrice?: number;
2941
+ /**
2942
+ * 折扣前每天资源点
2943
+ */
2944
+ OriginalCredits?: number;
2945
+ /**
2946
+ * 折扣后每天所需资源点
2947
+ */
2948
+ DiscountCredits?: number;
2949
+ }
2214
2950
  /**
2215
2951
  * DescribeCloudBaseGWService返回参数结构体
2216
2952
  */
@@ -2257,6 +2993,35 @@ export interface DescribeCloudBaseGWServiceResponse {
2257
2993
  */
2258
2994
  RequestId?: string;
2259
2995
  }
2996
+ /**
2997
+ * 登录配置中密码更新配置策略,用于管理使用用户名密码登录方式时,密码的过期策略和更新策略。例如,首次登录需要更新密码、定期过期密码等策略。
2998
+ */
2999
+ export interface PasswordUpdateLoginConfig {
3000
+ /**
3001
+ * 首次登录强制修改密码开关。开启后,用户首次登录时将强制要求修改密码。
3002
+ 注意:此字段可能返回 null,表示取不到有效值。
3003
+ */
3004
+ FirstLoginUpdate?: boolean;
3005
+ /**
3006
+ * 定期强制修改密码开关。开启后,用户需按照 PeriodValue 和 PeriodType 指定的周期定期修改密码,超过周期未修改将在登录时强制要求修改。
3007
+ 注意:此字段可能返回 null,表示取不到有效值。
3008
+ */
3009
+ PeriodUpdate?: boolean;
3010
+ /**
3011
+ * 定期修改密码的周期数值,与 PeriodType 配合使用。例如 PeriodValue 为 6,PeriodType 为 MONTH,表示每 6 个月需修改一次密码。当 PeriodUpdate 为 true 时必填。
3012
+ 注意:此字段可能返回 null,表示取不到有效值。
3013
+ */
3014
+ PeriodValue?: number;
3015
+ /**
3016
+ * 定期修改密码的周期时间单位,与 PeriodValue 配合使用。取值范围:
3017
+ WEEK:周
3018
+ MONTH:月
3019
+ YEAR:年
3020
+ 当 PeriodUpdate 为 true 时必填。
3021
+ 注意:此字段可能返回 null,表示取不到有效值。
3022
+ */
3023
+ PeriodType?: string;
3024
+ }
2260
3025
  /**
2261
3026
  * ReinstateEnv请求参数结构体
2262
3027
  */
@@ -2279,6 +3044,19 @@ export interface DescribeDatabaseACLRequest {
2279
3044
  */
2280
3045
  CollectionName: string;
2281
3046
  }
3047
+ /**
3048
+ * vm规格
3049
+ */
3050
+ export interface VMSpecLightHouse {
3051
+ /**
3052
+ * LH主机的BundleId
3053
+ */
3054
+ BundleId?: string;
3055
+ /**
3056
+ * 主机配置详情json
3057
+ */
3058
+ BundleConfig?: string;
3059
+ }
2282
3060
  /**
2283
3061
  * DescribeMySQLTaskStatus返回参数结构体
2284
3062
  */
@@ -2322,6 +3100,45 @@ export interface TableInfo {
2322
3100
  */
2323
3101
  IndexSize?: number;
2324
3102
  }
3103
+ /**
3104
+ * DescribeLoginConfig返回参数结构体
3105
+ */
3106
+ export interface DescribeLoginConfigResponse {
3107
+ /**
3108
+ * 是否开启邮箱登录方式。true 表示已开启,允许用户使用邮箱和密码进行登录;false 表示已关闭。
3109
+ */
3110
+ EmailLogin?: boolean;
3111
+ /**
3112
+ * 是否开启匿名登录方式。true 表示已开启,允许用户无需注册即可以匿名身份登录;false 表示已关闭。
3113
+ */
3114
+ AnonymousLogin?: boolean;
3115
+ /**
3116
+ * 是否开启用户名密码登录方式。true 表示已开启,允许用户使用用户名和密码进行登录;false 表示已关闭。
3117
+ */
3118
+ UserNameLogin?: boolean;
3119
+ /**
3120
+ * 短信验证码发送配置,包含短信发送通道类型、自定义 APIs 数据源、调用方法及每日发送限额等信息。
3121
+ */
3122
+ SmsVerificationConfig?: VerificationConfig;
3123
+ /**
3124
+ * 是否开启手机号短信登录方式。true 表示已开启,允许用户使用手机号和短信验证码进行登录和注册;false 表示已关闭。
3125
+ */
3126
+ PhoneNumberLogin?: boolean;
3127
+ /**
3128
+ * MFA 多因子认证登录配置,包含 MFA 开关及各验证方式(短信、邮箱、TOTP、强制绑定手机号)的启用状态。
3129
+ 注意:此字段可能返回 null,表示取不到有效值。
3130
+ */
3131
+ MfaConfig?: MFALoginConfig;
3132
+ /**
3133
+ * 密码修改策略配置,包含首次登录强制修改密码开关及定期修改密码策略(周期和时间单位)。
3134
+ 注意:此字段可能返回 null,表示取不到有效值。
3135
+ */
3136
+ PwdUpdateStrategy?: PasswordUpdateLoginConfig;
3137
+ /**
3138
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3139
+ */
3140
+ RequestId?: string;
3141
+ }
2325
3142
  /**
2326
3143
  * DeleteCloudBaseGWDomain请求参数结构体
2327
3144
  */
@@ -2335,6 +3152,15 @@ export interface DeleteCloudBaseGWDomainRequest {
2335
3152
  */
2336
3153
  Domain: string;
2337
3154
  }
3155
+ /**
3156
+ * CreateEnvResource返回参数结构体
3157
+ */
3158
+ export interface CreateEnvResourceResponse {
3159
+ /**
3160
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3161
+ */
3162
+ RequestId?: string;
3163
+ }
2338
3164
  /**
2339
3165
  * DescribeTables请求参数结构体
2340
3166
  */
@@ -2528,41 +3354,23 @@ export interface DescribeStaticStoreResponse {
2528
3354
  RequestId?: string;
2529
3355
  }
2530
3356
  /**
2531
- * ListTables请求参数结构体
3357
+ * GetProviders返回参数结构体
2532
3358
  */
2533
- export interface ListTablesRequest {
2534
- /**
2535
- * 每页返回数量(0-1000)
2536
- */
2537
- MgoLimit: number;
2538
- /**
2539
- * FlexDB实例ID
2540
- */
2541
- Tag?: string;
2542
- /**
2543
- * 分页偏移量
2544
- */
2545
- MgoOffset?: number;
2546
- /**
2547
- * 过滤标签数组,用于过滤表名,可选值如:HIDDEN、WEDA、WEDA_SYSTEM
2548
- */
2549
- Filters?: Array<string>;
2550
- /**
2551
- * 模糊搜索查询值
2552
- */
2553
- SearchValue?: string;
3359
+ export interface GetProvidersResponse {
2554
3360
  /**
2555
- * 是否展示隐藏表
3361
+ * 总数
3362
+ 注意:此字段可能返回 null,表示取不到有效值。
2556
3363
  */
2557
- ShowHidden?: boolean;
3364
+ Total?: number;
2558
3365
  /**
2559
- * 云开发环境ID
3366
+ * 三方认证源列表
3367
+ 注意:此字段可能返回 null,表示取不到有效值。
2560
3368
  */
2561
- EnvId?: string;
3369
+ Data?: Array<Provider>;
2562
3370
  /**
2563
- * mongo连接器信息
3371
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2564
3372
  */
2565
- MongoConnector?: MongoConnector;
3373
+ RequestId?: string;
2566
3374
  }
2567
3375
  /**
2568
3376
  * DescribeQuotaData请求参数结构体
@@ -2887,53 +3695,46 @@ export interface CloudBaseGWAPIQPSPolicy {
2887
3695
  QPSPerClient?: CloudBaseClientQPSPolicy;
2888
3696
  }
2889
3697
  /**
2890
- * FlexDB数据库权限信息
3698
+ * 云日志服务相关信息
2891
3699
  */
2892
- export interface PermissionInfo {
3700
+ export interface LogServiceInfo {
2893
3701
  /**
2894
- * "READONLY", //公有读,私有写。所有用户可读,仅创建者及管理员可写
2895
- "PRIVATE", //私有读写,仅创建者及管理员可读写
2896
- "ADMINWRITE", //所有用户可读,仅管理员可写
2897
- "ADMINONLY", //仅管理员可操作
2898
- "CUSTOM", // 安全规则
3702
+ * log名
2899
3703
  */
2900
- AclTag: string;
3704
+ LogsetName?: string;
2901
3705
  /**
2902
- * 云开发环境ID
3706
+ * log-id
2903
3707
  */
2904
- EnvId: string;
3708
+ LogsetId?: string;
2905
3709
  /**
2906
- * 自定义规则
3710
+ * topic名
2907
3711
  */
2908
- Rule?: string;
3712
+ TopicName?: string;
3713
+ /**
3714
+ * topic-id
3715
+ */
3716
+ TopicId?: string;
3717
+ /**
3718
+ * cls日志所属地域
3719
+ */
3720
+ Region?: string;
3721
+ /**
3722
+ * topic保存时长 默认7天
3723
+ */
3724
+ Period?: number;
2909
3725
  }
2910
3726
  /**
2911
- * ModifySafeRule请求参数结构体
3727
+ * DescribeClient请求参数结构体
2912
3728
  */
2913
- export interface ModifySafeRuleRequest {
3729
+ export interface DescribeClientRequest {
2914
3730
  /**
2915
3731
  * 环境ID
2916
3732
  */
2917
3733
  EnvId: string;
2918
3734
  /**
2919
- * 集合名称
2920
- */
2921
- CollectionName: string;
2922
- /**
2923
- * 权限标签。包含以下取值:
2924
- <li> READONLY:所有用户可读,仅创建者和管理员可写</li>
2925
- <li> PRIVATE:仅创建者及管理员可读写</li>
2926
- <li> ADMINWRITE:所有用户可读,仅管理员可写</li>
2927
- <li> ADMINONLY:仅管理员可读写</li>
2928
- <li> CUSTOM:自定义安全规则</li>
2929
- */
2930
- AclTag: string;
2931
- /**
2932
- * 安全规则内容。
2933
- 当 AclTag=CUSTOM 时,此参数必填。
2934
- 详情参考:[文档型数据库安全规则](https://docs.cloudbase.net/database/security-rules)
3735
+ * 客户端的唯一标识符(Client ID),在 OAuth/OIDC 授权流程中作为 client_id 参数使用,创建后不可修改,一般使用环境id
2935
3736
  */
2936
- Rule?: string;
3737
+ Id: string;
2937
3738
  }
2938
3739
  /**
2939
3740
  * DescribeHostingDomainTask返回参数结构体
@@ -2957,7 +3758,7 @@ export interface DeleteAuthDomainRequest {
2957
3758
  */
2958
3759
  EnvId: string;
2959
3760
  /**
2960
- * 域名ID列表,支持批量
3761
+ * 域名ID列表,支持批量传递
2961
3762
  */
2962
3763
  DomainIds: Array<string>;
2963
3764
  }
@@ -3094,6 +3895,31 @@ export interface IndexInfo {
3094
3895
  */
3095
3896
  Unique?: boolean;
3096
3897
  }
3898
+ /**
3899
+ * ModifyClient请求参数结构体
3900
+ */
3901
+ export interface ModifyClientRequest {
3902
+ /**
3903
+ * 客户端所属的云开发环境 ID,用于标识该应用归属的云开发环境。不同环境之间的应用数据相互隔离。
3904
+ */
3905
+ EnvId: string;
3906
+ /**
3907
+ * 需要修改的客户端唯一标识符(Client ID),在 OAuth/OIDC 授权流程中作为 client_id 参数使用。该字段为定位参数,仅用于指定目标客户端,不可修改。
3908
+ */
3909
+ Id: string;
3910
+ /**
3911
+ * Refresh Token 的有效期,单位为秒。超过该时间后 Refresh Token 将失效,用户需重新登录。取值范围:1800~2592000(即 30 分钟至 30 天),超出上限将被截断为 2592000。默认值为 2592000(即 30 天)。注意:当该值 ≤ 7200 时,AccessTokenExpiresIn 将被自动设为该值减去 660 秒。
3912
+ */
3913
+ RefreshTokenExpiresIn?: number;
3914
+ /**
3915
+ * 单个用户在该应用下允许同时登录的最大会话数量。取值范围:-1~50。特殊值说明:-1 表示不限制设备数;0 表示按客户端 User-Agent 区分设备(相同 User-Agent 视为同一设备);1~50 为精确的最大会话数限制,超出限制后最早登录的会话将被自动踢出。不传则保持原有配置不变。
3916
+ */
3917
+ MaxDevice?: number;
3918
+ /**
3919
+ * Access Token 的有效期,单位为秒。超过该时间后 Access Token 将失效,需使用 Refresh Token 重新换取。最小有效值为 1800 秒(小于 1800 将被忽略,使用默认值),默认值为 7200(即 2 小时)。该值应小于 RefreshTokenExpiresIn。
3920
+ */
3921
+ AccessTokenExpiresIn?: number;
3922
+ }
3097
3923
  /**
3098
3924
  * DescribeCloudBaseGWService请求参数结构体
3099
3925
  */
@@ -3115,6 +3941,46 @@ export interface DescribeCloudBaseGWServiceRequest {
3115
3941
  */
3116
3942
  EnableUnion?: boolean;
3117
3943
  }
3944
+ /**
3945
+ * 三方认证出参映射。如果您的对接方不标准,则可以使用这个参数。默认情况下,该参数可以为空。比如:microsoft, github,google,apple 接入,这些参数为空,但是国内的腾讯,新浪等则需要配置该参数。原因主要是:腾讯等公司在实现oauth时,未能完全遵循oauth标准。
3946
+ */
3947
+ export interface ProviderResponseParametersMap {
3948
+ /**
3949
+ * 用户唯一标识(sub)的映射字段名。对应 OIDC 标准中的 sub 字段,值为第三方平台返回的用户信息 JSON 中表示用户 ID 的字段路径。例如github平台填sub。
3950
+ 注意:此字段可能返回 null,表示取不到有效值。
3951
+ */
3952
+ Sub?: string;
3953
+ /**
3954
+ * 用户名称(name)的映射字段名。对应 OIDC 标准中的 name 字段,值为第三方平台返回的用户信息 JSON 中表示用户昵称或姓名的字段路径。例如github平台填 name。
3955
+ 注意:此字段可能返回 null,表示取不到有效值。
3956
+ */
3957
+ Name?: string;
3958
+ /**
3959
+ * 用户头像(picture)的映射字段名。对应 OIDC 标准中的 picture 字段,值为第三方平台返回的用户信息 JSON 中表示用户头像 URL 的字段路径。需要公网可访问的url。
3960
+ 注意:此字段可能返回 null,表示取不到有效值。
3961
+ */
3962
+ Picture?: string;
3963
+ /**
3964
+ * 用户登录名(username)的映射字段名。对应 OIDC 标准中的 preferred_username 字段,值为第三方平台返回的用户信息 JSON 中表示用户唯一登录名的字段, 例如可使用sub或email等唯一值的字段。
3965
+ 注意:此字段可能返回 null,表示取不到有效值。
3966
+ */
3967
+ Username?: string;
3968
+ /**
3969
+ * 用户邮箱(email)的映射字段名。对应 OIDC 标准中的 email 字段,值为第三方平台返回的用户信息 JSON 中表示用户邮箱地址的字段。
3970
+ 注意:此字段可能返回 null,表示取不到有效值。
3971
+ */
3972
+ Email?: string;
3973
+ /**
3974
+ * 用户手机号(phone_number)的映射字段名。对应 OIDC 标准中的 phone_number 字段,值为第三方平台返回的用户信息 JSON 中表示用户手机号的字段。
3975
+ 注意:此字段可能返回 null,表示取不到有效值。
3976
+ */
3977
+ PhoneNumber?: string;
3978
+ /**
3979
+ * 用户角色/分组(groups)的映射字段名。对应 OIDC 标准中的 groups 字段,值为第三方平台返回的用户信息 JSON 中表示用户所属角色或分组的字段路径。支持字符串数组类型的返回值。
3980
+ 注意:此字段可能返回 null,表示取不到有效值。
3981
+ */
3982
+ Groups?: string;
3983
+ }
3118
3984
  /**
3119
3985
  * DescribeCloudBaseBuildService请求参数结构体
3120
3986
  */
@@ -3194,6 +4060,27 @@ export interface MongoConnector {
3194
4060
  * CheckTcbService请求参数结构体
3195
4061
  */
3196
4062
  export type CheckTcbServiceRequest = null;
4063
+ /**
4064
+ * FlexDB数据库权限信息
4065
+ */
4066
+ export interface PermissionInfo {
4067
+ /**
4068
+ * "READONLY", //公有读,私有写。所有用户可读,仅创建者及管理员可写
4069
+ "PRIVATE", //私有读写,仅创建者及管理员可读写
4070
+ "ADMINWRITE", //所有用户可读,仅管理员可写
4071
+ "ADMINONLY", //仅管理员可操作
4072
+ "CUSTOM", // 安全规则
4073
+ */
4074
+ AclTag: string;
4075
+ /**
4076
+ * 云开发环境ID
4077
+ */
4078
+ EnvId: string;
4079
+ /**
4080
+ * 自定义规则
4081
+ */
4082
+ Rule?: string;
4083
+ }
3197
4084
  /**
3198
4085
  * 分页信息
3199
4086
  */
@@ -3345,40 +4232,30 @@ export interface DescribeAuthDomainsRequest {
3345
4232
  EnvId: string;
3346
4233
  }
3347
4234
  /**
3348
- * 静态托管资源信息
4235
+ * DescribeVmSpec返回参数结构体
3349
4236
  */
3350
- export interface StaticStoreInfo {
3351
- /**
3352
- * 环境ID
3353
- 注意:此字段可能返回 null,表示取不到有效值。
3354
- */
3355
- EnvId?: string;
3356
- /**
3357
- * 静态域名
3358
- 注意:此字段可能返回 null,表示取不到有效值。
3359
- */
3360
- CdnDomain?: string;
4237
+ export interface DescribeVmSpecResponse {
3361
4238
  /**
3362
- * COS桶
3363
- 注意:此字段可能返回 null,表示取不到有效值。
4239
+ * 规格列表
3364
4240
  */
3365
- Bucket?: string;
4241
+ SpecList?: Array<VMSpec>;
3366
4242
  /**
3367
- * cos区域
3368
- 注意:此字段可能返回 null,表示取不到有效值。
3369
- * @deprecated
4243
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3370
4244
  */
3371
- Regoin?: string;
4245
+ RequestId?: string;
4246
+ }
4247
+ /**
4248
+ * 多语言文字,在 Locale 中 展示的 Message
4249
+ */
4250
+ export interface MessageLocalized {
3372
4251
  /**
3373
- * 资源状态:init(初始化)/process(处理中)/online(上线)/destroying(销毁中)/offline(下线))
3374
- 注意:此字段可能返回 null,表示取不到有效值。
4252
+ * 字符串
3375
4253
  */
3376
- Status?: string;
4254
+ Message: string;
3377
4255
  /**
3378
- * 地域
3379
- 注意:此字段可能返回 null,表示取不到有效值。
4256
+ * 在该语言中
3380
4257
  */
3381
- Region?: string;
4258
+ Locale: string;
3382
4259
  }
3383
4260
  /**
3384
4261
  * CreateUser请求参数结构体
@@ -3505,6 +4382,30 @@ export interface DescribeDatabaseACLResponse {
3505
4382
  */
3506
4383
  RequestId?: string;
3507
4384
  }
4385
+ /**
4386
+ * DeleteProvider请求参数结构体
4387
+ */
4388
+ export interface DeleteProviderRequest {
4389
+ /**
4390
+ * 环境ID
4391
+ */
4392
+ EnvId: string;
4393
+ /**
4394
+ * 认证源ID,比如:github, 格式必须为:2-32位小写英文字符串或数字
4395
+ */
4396
+ Id: string;
4397
+ }
4398
+ /**
4399
+ * DescribeVmSpec请求参数结构体
4400
+ */
4401
+ export interface DescribeVmSpecRequest {
4402
+ /**
4403
+ * 类型:
4404
+ LightHouse = 轻量云服务器
4405
+ CVM = 云服务器
4406
+ */
4407
+ Type?: string;
4408
+ }
3508
4409
  /**
3509
4410
  * ReinstateEnv返回参数结构体
3510
4411
  */
@@ -3514,6 +4415,15 @@ export interface ReinstateEnvResponse {
3514
4415
  */
3515
4416
  RequestId?: string;
3516
4417
  }
4418
+ /**
4419
+ * ModifyProvider返回参数结构体
4420
+ */
4421
+ export interface ModifyProviderResponse {
4422
+ /**
4423
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4424
+ */
4425
+ RequestId?: string;
4426
+ }
3517
4427
  /**
3518
4428
  * 网关服务
3519
4429
  */
@@ -3779,3 +4689,12 @@ export interface CloudBaseGWAPI {
3779
4689
  */
3780
4690
  QPSPolicy?: CloudBaseGWAPIQPSPolicy;
3781
4691
  }
4692
+ /**
4693
+ * ModifyLoginConfig返回参数结构体
4694
+ */
4695
+ export interface ModifyLoginConfigResponse {
4696
+ /**
4697
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4698
+ */
4699
+ RequestId?: string;
4700
+ }