tencentcloud-sdk-nodejs-tcb 4.1.301 → 4.1.303

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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-tcb",
3
- "version": "4.1.301",
3
+ "version": "4.1.303",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -216,7 +216,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
216
216
  */
217
217
  DeleteAuthDomain(req: DeleteAuthDomainRequest, cb?: (error: string, rep: DeleteAuthDomainResponse) => void): Promise<DeleteAuthDomainResponse>;
218
218
  /**
219
- * 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。HTTP访问服务提供了默认域名,通过本接口可直接获取默认域名。
219
+ * 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。HTTP访问服务提供了默认域名,通过本接口可直接获取默认域名。前置需已开通 HTTP 访问服务;调用CreateHTTPServiceRoute或者ModifyHTTPServiceRoute后可使用本接口查询创建或者修改结果
220
220
  */
221
221
  DescribeHTTPServiceRoute(req: DescribeHTTPServiceRouteRequest, cb?: (error: string, rep: DescribeHTTPServiceRouteResponse) => void): Promise<DescribeHTTPServiceRouteResponse>;
222
222
  /**
@@ -308,7 +308,7 @@ class Client extends TencentCloudCommon.AbstractClient {
308
308
  return this.request("DeleteAuthDomain", req, cb);
309
309
  }
310
310
  /**
311
- * 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。HTTP访问服务提供了默认域名,通过本接口可直接获取默认域名。
311
+ * 本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。HTTP访问服务提供了默认域名,通过本接口可直接获取默认域名。前置需已开通 HTTP 访问服务;调用CreateHTTPServiceRoute或者ModifyHTTPServiceRoute后可使用本接口查询创建或者修改结果
312
312
  */
313
313
  async DescribeHTTPServiceRoute(req, cb) {
314
314
  return this.request("DescribeHTTPServiceRoute", req, cb);
@@ -421,6 +421,23 @@ export interface DeleteProviderResponse {
421
421
  */
422
422
  RequestId?: string;
423
423
  }
424
+ /**
425
+ * HTTPService缓存规则匹配条件(必填)
426
+ */
427
+ export interface HTTPServiceRuleCondition {
428
+ /**
429
+ * <p>Target 匹配对象</p><p>枚举值:</p><ul><li>url_path: 请求 URI 路径(不含查询串),例:/static/logo.jpg</li><li>file_extension: 请求文件扩展名(EO 从 path 中解析),例:jpg</li><li>full_uri: 完整 URI(路径 + 查询串),例:/download?type=hd</li></ul>
430
+ */
431
+ Target?: string;
432
+ /**
433
+ * <p>MatchType 字符串匹配类型</p><p>枚举值:</p><ul><li>prefix: 前缀匹配</li><li>suffix: 后缀匹配</li><li>contains: 包含匹配</li><li>exact: 精确匹配</li></ul>
434
+ */
435
+ MatchType?: string;
436
+ /**
437
+ * <p>Values 匹配值集合,Values 内任一命中即认为条件成立(OR 语义)</p><p>入参限制:单项 1~1024 字节,最多 100 条</p>
438
+ */
439
+ Values?: Array<string>;
440
+ }
424
441
  /**
425
442
  * 本类型用于UpdateTable接口中描述待创建索引信息
426
443
  */
@@ -621,6 +638,31 @@ export interface CloudAppVersionItem {
621
638
  */
622
639
  Steps?: Array<BuildStepStatus>;
623
640
  }
641
+ /**
642
+ * 自定义缓存键参数。约束:FullURLCache=on 与 QueryStringSwitch=on 互斥
643
+ 使用示例:
644
+ - 整 URL 参与缓存键:{FullURLCache: "on", QueryStringSwitch: "off"}
645
+ - URL 路径 + 仅保留 x/y:{FullURLCache: "off", QueryStringSwitch: "on", QueryStringAction: "includeCustom", QueryStringValues: ["x", "y"]}
646
+ - URL 路径 + 忽略 debug:{FullURLCache: "off", QueryStringSwitch: "on", QueryStringAction: "excludeCustom", QueryStringValues: ["debug"]}
647
+ */
648
+ export interface HTTPServiceCacheKeyParams {
649
+ /**
650
+ * <p>全 URL 缓存开关</p><p>枚举值:</p><ul><li>on: 开启</li><li>off: 关闭</li></ul>
651
+ */
652
+ FullURLCache?: string;
653
+ /**
654
+ * <p>查询参数是否参与缓存键</p><p>枚举值:</p><ul><li>on: 开启</li><li>off: 关闭</li></ul>
655
+ */
656
+ QueryStringSwitch?: string;
657
+ /**
658
+ * <p>QueryStringSwitch=on 时必填</p><p>枚举值:</p><ul><li>includeCustom: 白名单</li><li>excludeCustom: 黑名单</li></ul>
659
+ */
660
+ QueryStringAction?: string;
661
+ /**
662
+ * <p>参数名列表</p><p>入参限制:最多 100 项,单项 1~128 字节</p>
663
+ */
664
+ QueryStringValues?: Array<string>;
665
+ }
624
666
  /**
625
667
  * CreateVmInstance请求参数结构体
626
668
  */
@@ -1407,6 +1449,68 @@ export interface CreateHostingDomainRequest {
1407
1449
  */
1408
1450
  CertId: string;
1409
1451
  }
1452
+ /**
1453
+ * 创建或修改HTTP访问服务输入的域名信息,修改HTTP访问服务域名时对应字段不传参数表示不需要修改。
1454
+ */
1455
+ export interface HTTPServiceDomainParam {
1456
+ /**
1457
+ * <p>域名。全局唯一。如果域名在其他环境下占用或者腾讯云CDN占用,可能会导致创建失败</p>
1458
+ */
1459
+ Domain: string;
1460
+ /**
1461
+ * <p>绑定类型</p><p>枚举值:</p><ul><li>DIRECT: 直连到HTTP访问服务</li><li>CDN: 接入云开发CDN(即将下线)</li><li>CUSTOM: 自定义接入类型(CDN、EO、WAF等接入)</li><li>EO: 接入云开发EdgeOne</li></ul><p>默认值:DIRECT</p>
1462
+ */
1463
+ AccessType?: string;
1464
+ /**
1465
+ * <p>证书ID。当前账户下SSL平台的证书ID,无证书无法使用https访问</p>
1466
+ */
1467
+ CertId?: string;
1468
+ /**
1469
+ * <p>协议类型</p><p>枚举值:</p><ul><li>HTTP: 仅开启http</li><li>HTTPS: 仅开启https</li><li>HTTP_AND_HTTPS: 同时开启http和https,默认</li><li>HTTP_TO_HTTPS: http重定向成https,需配置证书</li><li>HTTPS_TO_HTTP: https重定向成http,需配置证书</li></ul><p>默认值:HTTP_AND_HTTPS</p>
1470
+ */
1471
+ Protocol?: string;
1472
+ /**
1473
+ * <p>自定义CNAME。对应AccessType: Custom</p>
1474
+ */
1475
+ CustomCname?: string;
1476
+ /**
1477
+ * <p>域名开启状态,不传默认开启</p>
1478
+ */
1479
+ Enable?: boolean;
1480
+ /**
1481
+ * <p>创建/修改的HTTP访问服务路由列表。如果不传,仅创建或修改域名信息。列表最大支持传入20个</p>
1482
+ */
1483
+ Routes?: Array<HTTPServiceRouteParam>;
1484
+ /**
1485
+ * <p>扩展字段,内部包含headers处理等</p>
1486
+ */
1487
+ Extension?: HTTPServiceExtension;
1488
+ }
1489
+ /**
1490
+ * HTTPService 缓存参数(节点缓存 + 浏览器缓存共用行为模式)。
1491
+ FollowOrigin / NoCache / (CacheTime||MaxAgeTime) 三者互斥,必须开启其一:
1492
+ - FollowOrigin=true:节点与浏览器缓存均遵循源站;
1493
+ - NoCache=true:节点与浏览器缓存均不缓存(Cache-Control: no-cache);
1494
+ - CacheTime>0 或 MaxAgeTime>0:至少设置其一,分别控制节点、浏览器缓存秒数,可独立设置。
1495
+ */
1496
+ export interface HTTPServiceCacheParams {
1497
+ /**
1498
+ * <p>遵循源站</p>
1499
+ */
1500
+ FollowOrigin?: boolean;
1501
+ /**
1502
+ * <p>不缓存</p>
1503
+ */
1504
+ NoCache?: boolean;
1505
+ /**
1506
+ * <p>自定义缓存时间(秒)</p><p>取值范围:[0, 31536000]</p><p>单位:秒</p>
1507
+ */
1508
+ CacheTime?: number;
1509
+ /**
1510
+ * <p>浏览器缓存秒数(对应 max-age)</p><p>取值范围:[0, 31536000]</p><p>单位:秒</p>
1511
+ */
1512
+ MaxAgeTime?: number;
1513
+ }
1410
1514
  /**
1411
1515
  * 自定义短信模板中的自定义参数
1412
1516
  */
@@ -2567,28 +2671,26 @@ export interface CreateStaticStoreRequest {
2567
2671
  ExternalStorage?: ExternalStorage;
2568
2672
  }
2569
2673
  /**
2570
- * HTTP访问服务路由扩展字段
2674
+ * HTTPService 路由扩展字段
2571
2675
  */
2572
2676
  export interface HTTPServiceExtension {
2573
2677
  /**
2574
- * 添加请求头列表
2678
+ * <p>添加请求头列表</p>
2575
2679
  */
2576
2680
  HeadersHandler?: HTTPServiceHeadersHandler;
2681
+ /**
2682
+ * <p>HTTPService 缓存配置,包含Cache 节点缓存 / MaxAge 浏览器缓存 / CacheKey 自定义缓存键</p>
2683
+ */
2684
+ Cache?: HTTPServiceCacheSet;
2577
2685
  }
2578
2686
  /**
2579
- * 多语言模板
2687
+ * HTTPService 缓存配置(域名维度)
2580
2688
  */
2581
- export interface LocalizedTemplate {
2689
+ export interface HTTPServiceCacheSet {
2582
2690
  /**
2583
- * <p>中文</p>
2584
- 注意:此字段可能返回 null,表示取不到有效值。
2691
+ * <p>HTTPService 缓存配置列表。Rules 按数组顺序为优先级顺序,Rules[n-1] 优先级最高</p>
2585
2692
  */
2586
- ZhCN?: string;
2587
- /**
2588
- * <p>英文</p>
2589
- 注意:此字段可能返回 null,表示取不到有效值。
2590
- */
2591
- EnUS?: string;
2693
+ Rules?: Array<HTTPServiceCacheRule>;
2592
2694
  }
2593
2695
  /**
2594
2696
  * DescribeBillingInfo返回参数结构体
@@ -5338,6 +5440,23 @@ export interface DescribeResourcePermissionRequest {
5338
5440
  */
5339
5441
  Resources?: Array<string>;
5340
5442
  }
5443
+ /**
5444
+ * HTTPService缓存动作(Type + 具体子字段的标签联合,Type 与被设置的子字段必须一一对应)
5445
+ */
5446
+ export interface HTTPServiceCacheAction {
5447
+ /**
5448
+ * <p>HTTPService 缓存动作类型</p><p>枚举值:</p><ul><li>Cache: 节点缓存 + 浏览器缓存统一动作(节点秒数 CacheTime、浏览器秒数 MaxAgeTime)</li><li>CacheKey: 仅开启EO边缘加速通道下发</li></ul>
5449
+ */
5450
+ Type?: string;
5451
+ /**
5452
+ * <p>节点缓存配置。Type=Cache 时必填</p>
5453
+ */
5454
+ Cache?: HTTPServiceCacheParams;
5455
+ /**
5456
+ * <p>自定义缓存键。Type=CacheKey 时必填</p>
5457
+ */
5458
+ CacheKey?: HTTPServiceCacheKeyParams;
5459
+ }
5341
5460
  /**
5342
5461
  * 资源权限
5343
5462
  */
@@ -6199,41 +6318,25 @@ export interface InquireVmPriceRequest {
6199
6318
  */
6200
6319
  export type CheckTcbServiceRequest = null;
6201
6320
  /**
6202
- * 创建或修改HTTP访问服务输入的域名信息,修改HTTP访问服务域名时对应字段不传参数表示不需要修改。
6321
+ * HTTPService 缓存规则条目
6203
6322
  */
6204
- export interface HTTPServiceDomainParam {
6205
- /**
6206
- * <p>域名。全局唯一。如果域名在其他环境下占用或者腾讯云CDN占用,可能会导致创建失败</p>
6207
- */
6208
- Domain: string;
6209
- /**
6210
- * <p>绑定类型</p><p>枚举值:</p><ul><li>DIRECT: 直连到HTTP访问服务</li><li>CDN: 接入云开发CDN(即将下线)</li><li>CUSTOM: 自定义接入类型(CDN、EO、WAF等接入)</li><li>EO: 接入云开发EdgeOne</li></ul><p>默认值:DIRECT</p>
6211
- */
6212
- AccessType?: string;
6323
+ export interface HTTPServiceCacheRule {
6213
6324
  /**
6214
- * <p>证书ID。当前账户下SSL平台的证书ID,无证书无法使用https访问</p>
6325
+ * <p>自定义描述,最多 128 字节</p>
6215
6326
  */
6216
- CertId?: string;
6217
- /**
6218
- * <p>协议类型</p><p>枚举值:</p><ul><li>HTTP: 仅开启http</li><li>HTTPS: 仅开启https</li><li>HTTP_AND_HTTPS: 同时开启http和https,默认</li><li>HTTP_TO_HTTPS: http重定向成https,需配置证书</li><li>HTTPS_TO_HTTP: https重定向成http,需配置证书</li></ul><p>默认值:HTTP_AND_HTTPS</p>
6219
- */
6220
- Protocol?: string;
6221
- /**
6222
- * <p>自定义CNAME。对应AccessType: Custom</p>
6223
- */
6224
- CustomCname?: string;
6327
+ Description?: string;
6225
6328
  /**
6226
- * <p>域名开启状态,不传默认开启</p>
6329
+ * <p>规则开关:nil/true 启用,false 禁用</p>
6227
6330
  */
6228
6331
  Enable?: boolean;
6229
6332
  /**
6230
- * <p>创建/修改的HTTP访问服务路由列表。如果不传,仅创建或修改域名信息。列表最大支持传入20个</p>
6333
+ * <p>HTTPService 规则匹配条件(必填)</p>
6231
6334
  */
6232
- Routes?: Array<HTTPServiceRouteParam>;
6335
+ Condition?: HTTPServiceRuleCondition;
6233
6336
  /**
6234
- * <p>扩展字段,内部包含headers处理等</p>
6337
+ * <p>HTTPService 缓存动作列表,同一规则内相同 Type 至多一个</p>
6235
6338
  */
6236
- Extension?: HTTPServiceExtension;
6339
+ Actions?: Array<HTTPServiceCacheAction>;
6237
6340
  }
6238
6341
  /**
6239
6342
  * FlexDB数据库权限信息
@@ -6318,6 +6421,21 @@ export interface StaticEnvironment {
6318
6421
  */
6319
6422
  Variables?: Array<Variable>;
6320
6423
  }
6424
+ /**
6425
+ * 多语言模板
6426
+ */
6427
+ export interface LocalizedTemplate {
6428
+ /**
6429
+ * <p>中文</p>
6430
+ 注意:此字段可能返回 null,表示取不到有效值。
6431
+ */
6432
+ ZhCN?: string;
6433
+ /**
6434
+ * <p>英文</p>
6435
+ 注意:此字段可能返回 null,表示取不到有效值。
6436
+ */
6437
+ EnUS?: string;
6438
+ }
6321
6439
  /**
6322
6440
  * 标签键值对
6323
6441
  */