tencentcloud-sdk-nodejs-tcb 4.1.236 → 4.1.238
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.
package/package.json
CHANGED
|
@@ -472,6 +472,51 @@ export interface ModifyStorageSourceResponse {
|
|
|
472
472
|
*/
|
|
473
473
|
RequestId?: string;
|
|
474
474
|
}
|
|
475
|
+
/**
|
|
476
|
+
* 自定义短信服务商模板配置
|
|
477
|
+
*/
|
|
478
|
+
export interface SMSProviderTemplateConfig {
|
|
479
|
+
/**
|
|
480
|
+
* <p>短信服务商类型</p><p>枚举值:</p><ul><li>TENCENT_CN: 腾讯云国内短信</li><li>TENCENT_INTL: 腾讯云国际短信</li></ul>
|
|
481
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
482
|
+
*/
|
|
483
|
+
Vendor: string;
|
|
484
|
+
/**
|
|
485
|
+
* <p>短信服务商侧申请并审核通过的模板ID。</p><ul><li>腾讯云短信模板ID可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-template">腾讯云国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-template">国际/港澳台短信</a> 的正文模板管理查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。</li></ul>
|
|
486
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
487
|
+
*/
|
|
488
|
+
TemplateId: string;
|
|
489
|
+
/**
|
|
490
|
+
* <p>短信服务商侧为应用分配的ID,按照服务商文档和要求需要此参数的,填写该参数。</p><ul><li>腾讯云国内短信和国际短信此参数必填,可以在<a href="https://console.cloud.tencent.com/smsv2/app-manage">短信控制台</a>的应用列表中查看对应的应用id。</li></ul>
|
|
491
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
492
|
+
*/
|
|
493
|
+
SdkAppId?: string;
|
|
494
|
+
/**
|
|
495
|
+
* <p>短信服务商侧申请并审核通过的签名,按照服务商的文档和要求填写。</p><ul><li>腾讯云短信服务商,签名信息可前往 <a href="https://console.cloud.tencent.com/smsv2/csms-sign">国内短信</a> 或 <a href="https://console.cloud.tencent.com/smsv2/isms-sign">国际/港澳台短信</a> 的签名管理查看。<br> 注意:<ol><li>发送国内短信该参数必填,且需填写签名内容而非签名ID。</li><li>发送国际/港澳台短信该参数非必填。</li></ol></li></ul>
|
|
496
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
497
|
+
*/
|
|
498
|
+
SignName?: string;
|
|
499
|
+
/**
|
|
500
|
+
* <p>调用短信服务商发送短信接口的调用秘钥对应的ID。</p><ul><li>调用api秘钥会保存在云开发平台控制台—扩展功能—授权管理中,如果对于短信调用的api秘钥有删除需求,可在此处进行删除,删除后,短信将无法正常发送。</li><li>腾讯云的调用api秘钥在腾讯云控制台获取,建议使用子账号的秘钥ID,并且按照最小权限配置。</li></ul>
|
|
501
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
502
|
+
*/
|
|
503
|
+
SecretId?: string;
|
|
504
|
+
/**
|
|
505
|
+
* <p>调用短信服务商发送短信接口的调用api秘钥对应的秘钥Key。</p><ul><li>腾讯云的调用api秘钥在腾讯云控制台获取,建议使用子账号的秘钥ID, 并且按照最小权限配置。平台对于调用api秘钥key是加密存储的,不会明文存储。</li></ul>
|
|
506
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
507
|
+
*/
|
|
508
|
+
SecretKey?: string;
|
|
509
|
+
/**
|
|
510
|
+
* <p>短信服务商侧自定义短信发送的senderID,按照服务商文档和要求传参。</p><ul><li>仅国际化场景使用。部分国家/运营商支持自定义 Sender ID替代默认主叫号码。国内站点忽略此字段。</li></ul>
|
|
511
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
512
|
+
*/
|
|
513
|
+
SenderId?: string;
|
|
514
|
+
/**
|
|
515
|
+
* <p>当短信自定义模板含多个占位符时,平台只负责生成验证码值,其余占位符由调用方在此提供。</p><ul><li>无需提供验证码对应的占位的值,验证码由云开发平台侧生成。</li><li>如果是命名占位的服务商的短信模板,这里的参数按照需要对应的占位的key和value,会按照对应的key和value在发送短信时,填充到模板中。</li><li>如果是序号占位的服务商的短信模板,这里的参数不需要key, 只需要填写对应的value, 会按照填写的顺序依次填充到模板中。</li></ul>
|
|
516
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
517
|
+
*/
|
|
518
|
+
TemplateExtendParam?: Array<SMSTemplateParams>;
|
|
519
|
+
}
|
|
475
520
|
/**
|
|
476
521
|
* HTTP访问服务路径重写配置
|
|
477
522
|
*/
|
|
@@ -1087,21 +1132,19 @@ export interface CreateHostingDomainRequest {
|
|
|
1087
1132
|
CertId: string;
|
|
1088
1133
|
}
|
|
1089
1134
|
/**
|
|
1090
|
-
*
|
|
1135
|
+
* 自定义短信模板中的自定义参数
|
|
1091
1136
|
*/
|
|
1092
|
-
export interface
|
|
1093
|
-
/**
|
|
1094
|
-
* 集群ID
|
|
1095
|
-
*/
|
|
1096
|
-
ClusterId?: string;
|
|
1137
|
+
export interface SMSTemplateParams {
|
|
1097
1138
|
/**
|
|
1098
|
-
*
|
|
1139
|
+
* <p>短信模板的自定义参数的key。如果短信厂商的自定义参数按照命名占位的,才需要此参数;如果按照序号占位的, 不需要此参数。</p><p>腾讯云短信是按照序号占位的,不需要此参数。</p>
|
|
1140
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1099
1141
|
*/
|
|
1100
|
-
|
|
1142
|
+
Key?: string;
|
|
1101
1143
|
/**
|
|
1102
|
-
*
|
|
1144
|
+
* <p>短信模板的自定义参数对应的value</p>
|
|
1145
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1103
1146
|
*/
|
|
1104
|
-
|
|
1147
|
+
Value?: string;
|
|
1105
1148
|
}
|
|
1106
1149
|
/**
|
|
1107
1150
|
* UnbindStorageSource返回参数结构体
|
|
@@ -3245,6 +3288,23 @@ export interface SearchClsLogResponse {
|
|
|
3245
3288
|
*/
|
|
3246
3289
|
RequestId?: string;
|
|
3247
3290
|
}
|
|
3291
|
+
/**
|
|
3292
|
+
* tke集群信息
|
|
3293
|
+
*/
|
|
3294
|
+
export interface TkeClusterInfo {
|
|
3295
|
+
/**
|
|
3296
|
+
* 集群ID
|
|
3297
|
+
*/
|
|
3298
|
+
ClusterId?: string;
|
|
3299
|
+
/**
|
|
3300
|
+
* 集群的vpcId
|
|
3301
|
+
*/
|
|
3302
|
+
VpcId?: string;
|
|
3303
|
+
/**
|
|
3304
|
+
* 版本内网CLB所在子网Id
|
|
3305
|
+
*/
|
|
3306
|
+
VersionClbSubnetId?: string;
|
|
3307
|
+
}
|
|
3248
3308
|
/**
|
|
3249
3309
|
* 身份源配置信息。描述云开发环境下用户登录身份源的完整配置,定义了用户通过何种方式进入系统并完成身份认证。支持多种类型:包括标准协议身份源(OAuth 2.0、OIDC、SAML 2.0)、内置身份源(邮箱登录、自定义登录)以及通过插件机制扩展的身份源(如 CAS)。每个身份源包含认证配置、启用状态、用户自动注册策略、信息透传模式等核心属性,是登录认证流程的核心数据结构。
|
|
3250
3310
|
*/
|
|
@@ -3457,8 +3517,8 @@ export interface AssumeRoleForAllocatedEnvResponse {
|
|
|
3457
3517
|
RequestId?: string;
|
|
3458
3518
|
}
|
|
3459
3519
|
/**
|
|
3460
|
-
*
|
|
3461
|
-
如果使用自定义APIs发送短信,方法命名规则
|
|
3520
|
+
* 登录短信验证码发送配置。用于管理登录时使用的短信验证码发送的通道相关设置,目前提供云开发默认短信包和客户自定义短信包,自定义短信包可以通过自定义apis或者自定义短信模板的方式接入,推荐使用云开发默认短信包,方便快捷。
|
|
3521
|
+
- 如果使用自定义APIs发送短信,方法命名规则
|
|
3462
3522
|
方法名称:发送验证码
|
|
3463
3523
|
方法标识:SendVerificationCode
|
|
3464
3524
|
入参
|
|
@@ -3467,31 +3527,34 @@ VerificationCode:字符串(验证码,如:“123456”)
|
|
|
3467
3527
|
返回值
|
|
3468
3528
|
ErrorCode:int(0 表示成功,非 0 表示失败)
|
|
3469
3529
|
ErrorMessage:字符串(ErrorCode 非 0 时,返回错误信息)
|
|
3530
|
+
- 如果使用自定义短信模板发送短信时,需要按照对应的短信服务商的要求,申请并审核通过对应的短信模板后,在云开发平台配置自定义短信模板,云开发平台对于短信模板不会做其他操作和限制,只做短信发送的逻辑,其他的操作限制都由短信服务商自身提供。
|
|
3470
3531
|
*/
|
|
3471
3532
|
export interface VerificationConfig {
|
|
3472
3533
|
/**
|
|
3473
|
-
*
|
|
3474
|
-
default:使用默认云开发短信包发送短信。
|
|
3475
|
-
apis:使用云开发自定义 APIs 作为短信发送通道,需配合 Name 和 Method 参数使用。
|
|
3476
|
-
不传则不修改当前配置。
|
|
3534
|
+
* <p>短信验证码发送通道类型。</p><p>枚举值:</p><ul><li>default: 使用默认云开发短信包发送短信</li><li>apis: 使用云开发自定义 APIs 作为短信发送通道,需配合 Name 和 Method 参数使用。不传则不修改当前配置。</li><li>template: 自定义短信模板配置,需要配置TemplateProvider</li></ul>
|
|
3477
3535
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3478
3536
|
*/
|
|
3479
3537
|
Type?: string;
|
|
3480
3538
|
/**
|
|
3481
|
-
*
|
|
3539
|
+
* <p>自定义 APIs 数据源唯一标识,当 Type 为 apis 时必填。用于定位微搭 APIs 中对应的数据源。</p>
|
|
3482
3540
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3483
3541
|
*/
|
|
3484
3542
|
Name?: string;
|
|
3485
3543
|
/**
|
|
3486
|
-
*
|
|
3544
|
+
* <p>自定义 APIs 方法名,当 Type 为 apis 时必填。指定微搭 APIs 中用于发送验证码的方法。</p>
|
|
3487
3545
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3488
3546
|
*/
|
|
3489
3547
|
Method?: string;
|
|
3490
3548
|
/**
|
|
3491
|
-
*
|
|
3549
|
+
* <p>单个手机号每日短信发送上限。默认值为 30,传 -1 表示不限制,如果设置为不限制,需要注意恶意攻击,导致短信套餐用量计费问题。仅支持正整数或 -1。不传则不修改当前配置。</p>
|
|
3492
3550
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3493
3551
|
*/
|
|
3494
3552
|
SmsDayLimit?: number;
|
|
3553
|
+
/**
|
|
3554
|
+
* <p>自定义短信服务商模板配置</p>
|
|
3555
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3556
|
+
*/
|
|
3557
|
+
TemplateProvider?: SMSProviderTemplateConfig;
|
|
3495
3558
|
}
|
|
3496
3559
|
/**
|
|
3497
3560
|
* DescribeTables返回参数结构体
|