tencentcloud-sdk-nodejs-teo 4.1.328 → 4.1.330
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
|
@@ -305,14 +305,22 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
305
305
|
*/
|
|
306
306
|
DescribeInferenceDomains(req: DescribeInferenceDomainsRequest, cb?: (error: string, rep: DescribeInferenceDomainsResponse) => void): Promise<DescribeInferenceDomainsResponse>;
|
|
307
307
|
/**
|
|
308
|
-
*
|
|
309
|
-
- 当数据投递类型(LogType)为七层访问日志、四层代理日志、边缘函数运行日志时,同一个实体(七层域名、四层代理实例、边缘函数实例)在同种数据投递类型(LogType)和数据投递区域(Area)的组合下,只能被添加到如下实时日志投递任务类型(TaskType)组合中:
|
|
310
|
-
- 一个推送至腾讯云 CLS 的任务,加上另一个推送至自定义 HTTP(S) 地址的任务;
|
|
311
|
-
- 一个推送至腾讯云 CLS 的任务,加上另一个推送至 AWS S3 兼容对象存储的任务;
|
|
312
|
-
- 当数据投递类型(LogType)为速率限制和 CC 攻击防护日志、托管规则日志、自定义规则日志、Bot 管理日志时,同一个实体在同种数据投递类型(LogType)和数据投递区域(Area)的组合下,只能被添加到一个实时日志投递任务中。
|
|
313
|
-
- 当实时日志投递任务类型(TaskType)为 EdgeOne 日志分析(log_analysis)时,只支持数据投递类型(LogType)为七层访问日志(l7-access-logs)或托管规则日志(web-attack);在同一站点(ZoneId)、同一数据投递区域(Area)和数据的组合下,每种数据投递类型(LogType)只能添加一个推送至 EdgeOne 日志分析的实时日志投递任务。
|
|
308
|
+
* 本接口用于创建实时日志投递任务。
|
|
314
309
|
|
|
315
|
-
|
|
310
|
+
**限制规则**
|
|
311
|
+
|
|
312
|
+
同一实体(七层域名、四层代理实例、边缘函数实例)在同一 `LogType` + `Area` 组合下,每种 `TaskType` 仅允许创建一个任务。不同 `LogType` 的互斥规则如下:
|
|
313
|
+
|
|
314
|
+
| LogType | 互斥的 TaskType |
|
|
315
|
+
| --- | --- |
|
|
316
|
+
| 四层代理日志、边缘函数运行日志 | `custom_endpoint`、`s3`、`aws_s3` 三选一 |
|
|
317
|
+
|
|
318
|
+
当 `TaskType` 为 `log_analysis` 时:
|
|
319
|
+
|
|
320
|
+
- 仅支持 `LogType` 为 `l7-access-logs` 或 `web-attack`。
|
|
321
|
+
- 同一 `ZoneId` + `Area` 下,每种 `LogType` 仅允许创建一个任务。
|
|
322
|
+
|
|
323
|
+
**建议**:创建前先通过 [DescribeRealtimeLogDeliveryTasks](https://cloud.tencent.com/document/product/1552/104110) 接口查询已有任务,避免重复添加。
|
|
316
324
|
*/
|
|
317
325
|
CreateRealtimeLogDeliveryTask(req: CreateRealtimeLogDeliveryTaskRequest, cb?: (error: string, rep: CreateRealtimeLogDeliveryTaskResponse) => void): Promise<CreateRealtimeLogDeliveryTaskResponse>;
|
|
318
326
|
/**
|
|
@@ -465,14 +465,22 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
465
465
|
return this.request("DescribeInferenceDomains", req, cb);
|
|
466
466
|
}
|
|
467
467
|
/**
|
|
468
|
-
*
|
|
469
|
-
- 当数据投递类型(LogType)为七层访问日志、四层代理日志、边缘函数运行日志时,同一个实体(七层域名、四层代理实例、边缘函数实例)在同种数据投递类型(LogType)和数据投递区域(Area)的组合下,只能被添加到如下实时日志投递任务类型(TaskType)组合中:
|
|
470
|
-
- 一个推送至腾讯云 CLS 的任务,加上另一个推送至自定义 HTTP(S) 地址的任务;
|
|
471
|
-
- 一个推送至腾讯云 CLS 的任务,加上另一个推送至 AWS S3 兼容对象存储的任务;
|
|
472
|
-
- 当数据投递类型(LogType)为速率限制和 CC 攻击防护日志、托管规则日志、自定义规则日志、Bot 管理日志时,同一个实体在同种数据投递类型(LogType)和数据投递区域(Area)的组合下,只能被添加到一个实时日志投递任务中。
|
|
473
|
-
- 当实时日志投递任务类型(TaskType)为 EdgeOne 日志分析(log_analysis)时,只支持数据投递类型(LogType)为七层访问日志(l7-access-logs)或托管规则日志(web-attack);在同一站点(ZoneId)、同一数据投递区域(Area)和数据的组合下,每种数据投递类型(LogType)只能添加一个推送至 EdgeOne 日志分析的实时日志投递任务。
|
|
468
|
+
* 本接口用于创建实时日志投递任务。
|
|
474
469
|
|
|
475
|
-
|
|
470
|
+
**限制规则**
|
|
471
|
+
|
|
472
|
+
同一实体(七层域名、四层代理实例、边缘函数实例)在同一 `LogType` + `Area` 组合下,每种 `TaskType` 仅允许创建一个任务。不同 `LogType` 的互斥规则如下:
|
|
473
|
+
|
|
474
|
+
| LogType | 互斥的 TaskType |
|
|
475
|
+
| --- | --- |
|
|
476
|
+
| 四层代理日志、边缘函数运行日志 | `custom_endpoint`、`s3`、`aws_s3` 三选一 |
|
|
477
|
+
|
|
478
|
+
当 `TaskType` 为 `log_analysis` 时:
|
|
479
|
+
|
|
480
|
+
- 仅支持 `LogType` 为 `l7-access-logs` 或 `web-attack`。
|
|
481
|
+
- 同一 `ZoneId` + `Area` 下,每种 `LogType` 仅允许创建一个任务。
|
|
482
|
+
|
|
483
|
+
**建议**:创建前先通过 [DescribeRealtimeLogDeliveryTasks](https://cloud.tencent.com/document/product/1552/104110) 接口查询已有任务,避免重复添加。
|
|
476
484
|
*/
|
|
477
485
|
async CreateRealtimeLogDeliveryTask(req, cb) {
|
|
478
486
|
return this.request("CreateRealtimeLogDeliveryTask", req, cb);
|
|
@@ -1252,7 +1252,7 @@ export interface CreateRealtimeLogDeliveryTaskRequest {
|
|
|
1252
1252
|
*/
|
|
1253
1253
|
TaskName: string;
|
|
1254
1254
|
/**
|
|
1255
|
-
* <p>实时日志投递任务类型,取值有:<ul><li>cls: 推送到腾讯云 CLS;</li><li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li><li>s3:推送到 AWS S3
|
|
1255
|
+
* <p>实时日志投递任务类型,取值有:<ul><li>cls: 推送到腾讯云 CLS;</li><li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li><li>s3:推送到 S3 兼容(兼容 SigV4 鉴权算法)的对象存储的地址,当 <code>LogType = web-attack</code> 时不支持该任务类型;</li><li>aws_s3:推送到 AWS S3 存储桶地址,使用 IAM 角色授权,免长期密钥,仅适用于 AWS 原生 S3;</li><li>log_analysis:推送到 EdgeOne 日志分析,仅当 <code>LogType = l7-access-logs</code> 或 <code>web-attack</code> 时支持。</li></ul></p>
|
|
1256
1256
|
*/
|
|
1257
1257
|
TaskType: string;
|
|
1258
1258
|
/**
|
|
@@ -1268,7 +1268,7 @@ export interface CreateRealtimeLogDeliveryTaskRequest {
|
|
|
1268
1268
|
*/
|
|
1269
1269
|
CustomFields?: Array<CustomField>;
|
|
1270
1270
|
/**
|
|
1271
|
-
* <p>投递的自定义表达式字段列表,可以通过自定义日志推送字段名称和取值表达式,实现个性化的实时日志内容推送,使用详情见 [自定义日志字段表达式]()。<br>仅七层访问日志(LogType= l7-access-logs 或 domain)支持添加自定义字段。<br>允许配置的自定义字段个数有配额限制,如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE) 。<br>**注意**:若 CustomExpressionFields 中存在命名 与 Fields 和 CustomFields 中同名的字段,以 CustomExpressionFields 中的取值为准。</p>
|
|
1271
|
+
* <p>投递的自定义表达式字段列表,可以通过自定义日志推送字段名称和取值表达式,实现个性化的实时日志内容推送,使用详情见 [自定义日志字段表达式](https://cloud.tencent.com/document/product/1552/105794)。<br>仅七层访问日志(LogType= l7-access-logs 或 domain)支持添加自定义字段。<br>允许配置的自定义字段个数有配额限制,如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE) 。<br>**注意**:若 CustomExpressionFields 中存在命名 与 Fields 和 CustomFields 中同名的字段,以 CustomExpressionFields 中的取值为准。</p>
|
|
1272
1272
|
*/
|
|
1273
1273
|
CustomExpressionFields?: Array<CustomExpressionField>;
|
|
1274
1274
|
/**
|
|
@@ -1280,7 +1280,7 @@ export interface CreateRealtimeLogDeliveryTaskRequest {
|
|
|
1280
1280
|
*/
|
|
1281
1281
|
Sample?: number;
|
|
1282
1282
|
/**
|
|
1283
|
-
* <p>日志投递的输出格式,使用详情见 <a href="https://cloud.tencent.com/document/product/1552/110448">自定义日志输出格式</a>。不填表示为默认格式,默认格式逻辑如下:<ul><li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li><li>当 TaskType 取值为 s3 时,默认格式为 JSON Lines;</li></ul>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。</p>
|
|
1283
|
+
* <p>日志投递的输出格式,使用详情见 <a href="https://cloud.tencent.com/document/product/1552/110448">自定义日志输出格式</a>。不填表示为默认格式,默认格式逻辑如下:<ul><li>当 TaskType 取值为 custom_endpoint 时,默认格式为多个 JSON 对象组成的数组,每个 JSON 对象为一条日志;</li><li>当 TaskType 取值为 s3 或 aws_s3 时,默认格式为 JSON Lines;</li></ul>特别地,当 TaskType 取值为 cls 或 log_analysis 时,LogFormat.FormatType 的值只能为 json,且 LogFormat 中其他参数将被忽略,建议不传 LogFormat。</p>
|
|
1284
1284
|
*/
|
|
1285
1285
|
LogFormat?: LogFormat;
|
|
1286
1286
|
/**
|
|
@@ -1292,9 +1292,13 @@ export interface CreateRealtimeLogDeliveryTaskRequest {
|
|
|
1292
1292
|
*/
|
|
1293
1293
|
CustomEndpoint?: CustomEndpoint;
|
|
1294
1294
|
/**
|
|
1295
|
-
* <p>
|
|
1295
|
+
* <p>S3 兼容(兼容 SigV4 鉴权算法)的对象存储的配置信息。当 TaskType 取值为 s3 时,该参数必填。</p>
|
|
1296
1296
|
*/
|
|
1297
1297
|
S3?: S3;
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>AWS S3 的对象存储的配置信息,使用 IAM 角色授权,免长期密钥,仅适用于 AWS 原生 S3 。当 TaskType 为 aws_s3 时,该参数必填。</p>
|
|
1300
|
+
*/
|
|
1301
|
+
AWSS3?: AWSS3;
|
|
1298
1302
|
}
|
|
1299
1303
|
/**
|
|
1300
1304
|
* ModifyAccelerationDomainStatuses返回参数结构体
|
|
@@ -2700,7 +2704,7 @@ export interface RealtimeLogDeliveryTask {
|
|
|
2700
2704
|
*/
|
|
2701
2705
|
DeliveryStatus?: string;
|
|
2702
2706
|
/**
|
|
2703
|
-
* <p>实时日志投递任务类型,取值有: <ul><li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 S3 兼容(兼容 SigV4 鉴权算法)的对象存储的地址;</li><li>log_analysis:推送到 EdgeOne 日志分析。</li></ul></p>
|
|
2707
|
+
* <p>实时日志投递任务类型,取值有: <ul><li>cls: 推送到腾讯云 CLS;</li> <li>custom_endpoint:推送到自定义 HTTP(S) 地址;</li> <li>s3:推送到 S3 兼容(兼容 SigV4 鉴权算法)的对象存储的地址;</li><li>aws_s3:推送到 AWS S3 存储桶地址;</li><li>log_analysis:推送到 EdgeOne 日志分析。</li></ul></p>
|
|
2704
2708
|
*/
|
|
2705
2709
|
TaskType?: string;
|
|
2706
2710
|
/**
|
|
@@ -2755,6 +2759,11 @@ export interface RealtimeLogDeliveryTask {
|
|
|
2755
2759
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2756
2760
|
*/
|
|
2757
2761
|
S3?: S3;
|
|
2762
|
+
/**
|
|
2763
|
+
* <p>AWS S3 的对象存储的配置信息,使用 IAM 角色授权,免长期密钥,仅适用于 AWS 原生 S3 。</p>
|
|
2764
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2765
|
+
*/
|
|
2766
|
+
AWSS3?: AWSS3;
|
|
2758
2767
|
/**
|
|
2759
2768
|
* <p>创建时间。</p>
|
|
2760
2769
|
*/
|
|
@@ -6952,11 +6961,11 @@ export interface ModifyRealtimeLogDeliveryTaskRequest {
|
|
|
6952
6961
|
*/
|
|
6953
6962
|
Fields?: Array<string>;
|
|
6954
6963
|
/**
|
|
6955
|
-
* <p
|
|
6964
|
+
* <p>投递的自定义字段列表,支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。<br>自定义字段名称不能重复,仅七层访问日志(LogType= l7-access-logs 或 domain)支持添加自定义字段。<br>允许配置的自定义字段个数有配额限制,如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE)。</p>
|
|
6956
6965
|
*/
|
|
6957
6966
|
CustomFields?: Array<CustomField>;
|
|
6958
6967
|
/**
|
|
6959
|
-
* <p>投递的自定义表达式字段列表,可以通过自定义日志推送字段名称和取值表达式,实现个性化的实时日志内容推送,使用详情见 [自定义日志字段表达式]()。<br>仅七层访问日志(LogType= l7-access-logs 或 domain
|
|
6968
|
+
* <p>投递的自定义表达式字段列表,可以通过自定义日志推送字段名称和取值表达式,实现个性化的实时日志内容推送,使用详情见 [自定义日志字段表达式](https://cloud.tencent.com/document/product/1552/105794)。<br>仅七层访问日志(LogType= l7-access-logs 或 domain)支持添加自定义字段。<br>允许配置的自定义字段个数有配额限制,如遇配额不足请 [联系我们](https://cloud.tencent.com/online-service?from=sales&source=PRESALE) 。<br>**注意**:若 CustomExpressionFields 中存在命名 与 Fields 和 CustomFields 中同名的字段,以 CustomExpressionFields 中的取值为准。</p>
|
|
6960
6969
|
*/
|
|
6961
6970
|
CustomExpressionFields?: Array<CustomExpressionField>;
|
|
6962
6971
|
/**
|
|
@@ -6976,9 +6985,13 @@ export interface ModifyRealtimeLogDeliveryTaskRequest {
|
|
|
6976
6985
|
*/
|
|
6977
6986
|
CustomEndpoint?: CustomEndpoint;
|
|
6978
6987
|
/**
|
|
6979
|
-
* <p>
|
|
6988
|
+
* <p>S3 兼容(兼容 SigV4 鉴权算法)的对象存储的配置信息,不填保持原有配置。</p>
|
|
6980
6989
|
*/
|
|
6981
6990
|
S3?: S3;
|
|
6991
|
+
/**
|
|
6992
|
+
* <p>AWS S3 对象存储的配置信息,不填保持原有配置。</p>
|
|
6993
|
+
*/
|
|
6994
|
+
AWSS3?: AWSS3;
|
|
6982
6995
|
}
|
|
6983
6996
|
/**
|
|
6984
6997
|
* 视频流配置参数。
|
|
@@ -9360,28 +9373,25 @@ export interface DescribeFunctionComponentBindingsRequest {
|
|
|
9360
9373
|
*/
|
|
9361
9374
|
export interface AccessURLRedirectParameters {
|
|
9362
9375
|
/**
|
|
9363
|
-
*
|
|
9376
|
+
* <p>状态码,取值为 301、302、303、307、308 之一。</p>
|
|
9364
9377
|
*/
|
|
9365
9378
|
StatusCode?: number;
|
|
9366
9379
|
/**
|
|
9367
|
-
*
|
|
9368
|
-
<li>http:目标请求协议 HTTP;</li>
|
|
9369
|
-
<li>https:目标请求协议 HTTPS;</li>
|
|
9370
|
-
<li>follow:跟随请求。</li>
|
|
9380
|
+
* <p>目标请求协议。</p><p>枚举值:</p><ul><li>http: 目标请求协议为 HTTP。</li><li>https: 目标请求协议为 HTTPS。</li><li>follow: 跟随请求。</li></ul>
|
|
9371
9381
|
*/
|
|
9372
9382
|
Protocol?: string;
|
|
9373
9383
|
/**
|
|
9374
|
-
*
|
|
9384
|
+
* <p>目标 HostName。</p>
|
|
9375
9385
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
9376
9386
|
*/
|
|
9377
9387
|
HostName?: HostName;
|
|
9378
9388
|
/**
|
|
9379
|
-
*
|
|
9389
|
+
* <p>目标路径。</p>
|
|
9380
9390
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
9381
9391
|
*/
|
|
9382
9392
|
URLPath?: URLPath;
|
|
9383
9393
|
/**
|
|
9384
|
-
*
|
|
9394
|
+
* <p>携带查询参数。</p>
|
|
9385
9395
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
9386
9396
|
*/
|
|
9387
9397
|
QueryString?: AccessURLRedirectQueryString;
|
|
@@ -14323,6 +14333,31 @@ export interface L4Proxy {
|
|
|
14323
14333
|
*/
|
|
14324
14334
|
UpdateTime?: string;
|
|
14325
14335
|
}
|
|
14336
|
+
/**
|
|
14337
|
+
* AWS S3 目的地信息。通过 IAM 角色 + External ID 授权 EdgeOne 将实时日志投递至客户的 AWS S3 桶,无需提供长期访问密钥,详情见 [推送至 AWS S3](https://cloud.tencent.com/document/product/1552/96007)。
|
|
14338
|
+
*/
|
|
14339
|
+
export interface AWSS3 {
|
|
14340
|
+
/**
|
|
14341
|
+
* <p>AWS S3 存储桶对应的服务端点域名,取值可参考 <a href="https://docs.aws.amazon.com/zh_cn/general/latest/gr/rande.html#regional-endpoints">AWS 服务端点</a>。例如:s3.us-west-2.amazonaws.com 。</p>
|
|
14342
|
+
*/
|
|
14343
|
+
Endpoint: string;
|
|
14344
|
+
/**
|
|
14345
|
+
* <p>AWS S3 存储桶名称。可在 AWS S3 控制台 Buckets(存储桶)列表中查看对应桶名。<br>长度须为 3–63 个字符,只能包含小写字母、数字、句点(.)和连字符(-),且必须以字母或数字开头和结尾。</p>
|
|
14346
|
+
*/
|
|
14347
|
+
BucketName: string;
|
|
14348
|
+
/**
|
|
14349
|
+
* <p>日志文件在 AWS S3 桶中的存储目录路径,以 <code>/</code> 分隔可创建多级目录,且不能包含 <code>./..</code> 等相对路径段,路径总长度不超过 1024 个字节。<br>当目录路径存在时直接使用该路径,当目录路径不存在时会自动创建。<br>目录名仅允许由字母、数字、 及 <code>!-_.*'()</code> 构成。<br>示例:<code>eo-logs/l7-access-logs</code> 。</p>
|
|
14350
|
+
*/
|
|
14351
|
+
Path: string;
|
|
14352
|
+
/**
|
|
14353
|
+
* <p>授权 EdgeOne 访问 AWS S3 桶的 IAM 角色的 ARN。<br>需先在 AWS 账号中创建一个授予 EdgeOne 写入权限的 IAM 角色(创建方式详情见 <a href="https://cloud.tencent.com/document/product/1552/96007">推送至 AWS S3</a>),创建后可在 AWS IAM 控制台的角色详情页顶部查看并复制该角色的 ARN。<br>例如:<code>arn:aws:iam::123456789012:role/eo-logs</code> 。</p>
|
|
14354
|
+
*/
|
|
14355
|
+
RoleARN: string;
|
|
14356
|
+
/**
|
|
14357
|
+
* <p>数据压缩类型,取值有: <ul><li> gzip:gzip压缩。</li></ul>不填表示不启用压缩。</p>
|
|
14358
|
+
*/
|
|
14359
|
+
CompressType?: string;
|
|
14360
|
+
}
|
|
14326
14361
|
/**
|
|
14327
14362
|
* 例外规则的跳过匹配条件,即在例外时根据本匹配条件,略过指定字段及内容。
|
|
14328
14363
|
*/
|
|
@@ -14943,8 +14978,8 @@ export interface L4ProxyRule {
|
|
|
14943
14978
|
/**
|
|
14944
14979
|
* 源站地址:
|
|
14945
14980
|
<li>当 OriginType 为 IP_DOMAIN 时,填写 IP 或域名,如 8.8.8.8 或 test.com ;</li>
|
|
14946
|
-
<li>当 OriginType 为 ORIGIN_GROUP 时,填写源站组 ID,如 og-537y24vf5b41;</li>
|
|
14947
|
-
<li>当 OriginType 为 LB 时,填写负载均衡实例 ID,如 lb-2qwk30xf7s9g。</li>
|
|
14981
|
+
<li>当 OriginType 为 ORIGIN_GROUP 时,填写源站组 ID,如 og-537y24vf5b41;如果引用了其它站点的源站组,格式为{源站组 ID}@{ZoneID}。例如:og-testorigin@zone-38moq1z10wwwy;</li>
|
|
14982
|
+
<li>当 OriginType 为 LB 时,填写负载均衡实例 ID,如 lb-2qwk30xf7s9g;如果引用了其它站点的负载均衡,格式为{负载均衡 ID}@{ZoneID}。例如:lb-2rxpamcyqfzg@zone-38moq1z10wwwy。</li>
|
|
14948
14983
|
注意:L4ProxyRule 在 CreateL4ProxyRules 作为入参使用时,该参数必填;在 ModifyL4ProxyRules 作为入参使用时,该参数选填,不填写时表示不修改。
|
|
14949
14984
|
|
|
14950
14985
|
*/
|