tencentcloud-sdk-nodejs-intl-en 3.0.1409 → 3.0.1411

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.
@@ -988,13 +988,13 @@ Valid values: Permanent Resident Identity Card, Non-permanent Resident Identity
988
988
  /**
989
989
  * Card Warning Information
990
990
 
991
- -9101 Alarm for covered certificate,
992
- -9102 Alarm for photocopied certificate,
993
- -9103 Alarm for photographed certificate,
994
- -9104 Alarm for PS certificate,
995
- -9107 Alarm for reflective certificate,
996
- -9108 Alarm for blurry image,
997
- -9109 This capability is not enabled.
991
+ -9101 Alarm for covered certificate
992
+ -9102 Alarm for photocopied certificate
993
+ -9103 Alarm for photographed certificate
994
+ -9104 Alarm for tamper certificate
995
+ -9107 Alarm for reflective certificate
996
+ -9108 Alarm for blurry certificate
997
+ -9109 This capability is not enabled. Please contact customer support to activate the alert service.
998
998
  * @type {Array.<number> || null}
999
999
  */
1000
1000
  this.WarnCardInfos = null;
@@ -4726,6 +4726,12 @@ If set to true, the image constraints are:
4726
4726
  */
4727
4727
  this.ReturnHeadImage = null;
4728
4728
 
4729
+ /**
4730
+ * Verification status callback URL. When set, this endpoint will be actively notified with the final verification result upon process completion. Leave blank to disable callbacks. Since callbacks are not fully reliable, a polling mechanism is advised to guarantee retrieval of the final status.
4731
+ * @type {string || null}
4732
+ */
4733
+ this.WebhookUrl = null;
4734
+
4729
4735
  }
4730
4736
 
4731
4737
  /**
@@ -4742,6 +4748,7 @@ If set to true, the image constraints are:
4742
4748
  this.ImageUrlFront = 'ImageUrlFront' in params ? params.ImageUrlFront : null;
4743
4749
  this.ImageUrlBack = 'ImageUrlBack' in params ? params.ImageUrlBack : null;
4744
4750
  this.ReturnHeadImage = 'ReturnHeadImage' in params ? params.ReturnHeadImage : null;
4751
+ this.WebhookUrl = 'WebhookUrl' in params ? params.WebhookUrl : null;
4745
4752
 
4746
4753
  }
4747
4754
  }
@@ -595,9 +595,7 @@ The following table lists the supported countries or regions, document types, an
595
595
  }
596
596
 
597
597
  /**
598
- * This API is used to recognize key fields on the photo side of a Hong Kong (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute.
599
-
600
- This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).
598
+ * This API is used to recognize key fields on the photo side of a Hong Kong (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute.
601
599
  * @param {HKIDCardOCRRequest} req
602
600
  * @param {function(string, HKIDCardOCRResponse):void} cb
603
601
  * @public
@@ -662,9 +660,7 @@ A maximum of 10 requests can be initiated per second for this API.
662
660
  }
663
661
 
664
662
  /**
665
- * This API is used to recognize key fields on the photo side of a Macao (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute.
666
-
667
- This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).
663
+ * This API is used to recognize key fields on the photo side of a Macao (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute.
668
664
  * @param {RecognizeMacaoIDCardOCRRequest} req
669
665
  * @param {function(string, RecognizeMacaoIDCardOCRResponse):void} cb
670
666
  * @public
@@ -5868,14 +5868,14 @@ class DescribeTimingL7AnalysisDataResponse extends AbstractModel {
5868
5868
  super();
5869
5869
 
5870
5870
  /**
5871
- * Total number of query results.
5871
+ * <p>The total number of records in the query result.</p>
5872
5872
  * @type {number || null}
5873
5873
  */
5874
5874
  this.TotalCount = null;
5875
5875
 
5876
5876
  /**
5877
- * The list of L7 traffic data recorded over time.
5878
- Note: This field may return null, indicating that no valid values can be obtained.
5877
+ * <p>Layer-7 time series traffic data list.<br>For different queried metrics, time series data will be returned from different parameters according to the value type.<br>Currently existing value types include the following two:</p><ul> <li><strong>Integer</strong>: Metrics with <code>Integer</code> value type will return corresponding time series data from <code>Data.N.TypeValue</code>.<br>Queried metrics <code>MetricName</code> include: <ul> <li><code>l7Flow_outFlux</code>: L7 EdgeOne response traffic, unit: Byte;</li> <li><code>l7Flow_inFlux</code>: L7 client request traffic, unit: Byte;</li> <li><code>l7Flow_flux</code>: L7 total access traffic (EdgeOne response + client requests), unit: Byte;</li> <li><code>l7Flow_outBandwidth</code>: L7 EdgeOne response bandwidth, unit: bps;</li> <li><code>l7Flow_inBandwidth</code>: L7 client request bandwidth, unit: bps;</li> <li><code>l7Flow_bandwidth</code>: L7 total access bandwidth (EdgeOne response + client requests), unit: bps;</li> <li><code>l7Flow_request</code>: L7 access request count, unit: count;</li> <li><code>l7Flow_avgResponseTime</code>: L7 average response time, unit: ms;</li> <li><code>l7Flow_avgFirstByteResponseTime</code>: L7 average first byte response time, unit: ms.</li> </ul> </li> <li><strong>Float</strong>: Metrics with <code>Float</code> value type will return corresponding time series data from <code>Data.N.FloatTypeValue</code>.<br>Queried metrics <code>MetricName</code> include: <ul> <li><code>l7Flow_requestRate</code>: L7 access request rate, unit: qps.</li> </ul> </li></ul>
5878
+ Note: This field may return null, which indicates a failure to obtain a valid value.
5879
5879
  * @type {Array.<TimingDataRecord> || null}
5880
5880
  */
5881
5881
  this.Data = null;
@@ -25783,49 +25783,43 @@ class DescribeTimingL7AnalysisDataRequest extends AbstractModel {
25783
25783
  super();
25784
25784
 
25785
25785
  /**
25786
- * The start time.
25786
+ * <p>Start time.</p>
25787
25787
  * @type {string || null}
25788
25788
  */
25789
25789
  this.StartTime = null;
25790
25790
 
25791
25791
  /**
25792
- * End time. The query time range (`EndTime` - `StartTime`) must be less than or equal to 31 days.
25792
+ * <p>End time. The query time range (<code>EndTime</code> - <code>StartTime</code>) must be less than or equal to 31 days.</p>
25793
25793
  * @type {string || null}
25794
25794
  */
25795
25795
  this.EndTime = null;
25796
25796
 
25797
25797
  /**
25798
- * Metric list. Valid values:
25799
- <Li>l7Flow_outFlux: L7 EdgeOne response traffic. Unit: byte;</li><Li>l7Flow_inFlux: L7 client request traffic. Unit: byte;</li><Li>l7Flow_flux: L7 total traffic (including EdgeOne response traffic and client request traffic). Unit: byte;</li><Li>l7Flow_outBandwidth: L7 EdgeOne response bandwidth. Unit: bps;</li><Li>l7Flow_inBandwidth: L7 client request bandwidth. Unit: bps;</li><Li>l7Flow_bandwidth: L7 total bandwidth (including EdgeOne response bandwidth and client request bandwidth). Unit: bps;</li><Li>l7Flow_request: L7 request count. Unit: times;</li><Li>l7Flow_avgResponseTime: Average L7 edge response time. Unit: ms (milliseconds);</li><Li>l7Flow_avgFirstByteResponseTime: Average L7 edge first byte response time. Unit: ms.</li>
25798
+ * <p>Metric list. Valid values:</p><li>l7Flow_outFlux: L7 EdgeOne response traffic. Measurement unit: Byte;</li><li>l7Flow_inFlux: L7 client request traffic. Measurement unit: Byte;</li><li>l7Flow_flux: L7 total access traffic (EdgeOne response + client request). Measurement unit: Byte;</li><li>l7Flow_outBandwidth: L7 EdgeOne response bandwidth. Measurement unit: bps;</li><li>l7Flow_inBandwidth: L7 client request bandwidth. Measurement unit: bps;</li><li>l7Flow_bandwidth: L7 total access bandwidth (EdgeOne response + client request). Measurement unit: bps;</li><li>l7Flow_request: L7 client request count. Measurement unit: count;</li><li>l7Flow_avgResponseTime: L7 average response time. Measurement unit: ms;</li><li>l7Flow_avgFirstByteResponseTime: L7 average first byte response time. Measurement unit: ms;</li><li>l7Flow_requestRate: L7 client request rate. Measurement unit: qps.</li>
25800
25799
  * @type {Array.<string> || null}
25801
25800
  */
25802
25801
  this.MetricNames = null;
25803
25802
 
25804
25803
  /**
25805
- * Site ID set. this parameter will change from option to required after may 30, 2024. for details, see the notice: [tencent cloud EdgeOne API change notification](https://www.tencentcloud.com/document/product/1145/59980). a maximum of 100 site ids can be imported. use `*` to query all site data under the tencent cloud root account. querying account-level data requires all resource permissions for all sites in this interface.
25804
+ * <p>Site ID set. This parameter will change from optional to required after May 30, 2024. For details, see the notice: <a href="https://www.tencentcloud.com/document/product/1552/104902?from_cn_redirect=1">[Tencent Cloud EdgeOne] Cloud API Change Notification</a>. A maximum of 100 site IDs can be imported. To query all site data under the Tencent Cloud root account, use <code>*</code> as a replacement. Querying account-level data requires permission to all site resources of this interface.</p>
25806
25805
  * @type {Array.<string> || null}
25807
25806
  */
25808
25807
  this.ZoneIds = null;
25809
25808
 
25810
25809
  /**
25811
- * Query period granularity. Valid values:
25812
- <li>min: 1 minute;</li>
25813
- <li>5min: 5 minutes;</li>
25814
- <li>hour: 1 hour;</li>
25815
- <li>day: 1 day.</li>If this parameter is not filled in, the granularity will be automatically calculated based on the interval between the start time and end time. Specifically, data will be queried with a granularity of min, 5min, hour, and day respectively when the period is no more than 2 hours, no more than 2 days, no more than 7 days, and over 7 days.
25810
+ * <p>Query time granularity.</p><p>Enumeration values:</p><ul><li>min: 1 minute</li><li>5min: 5 minutes</li><li>hour: 1 hour</li><li>day: 1 day</li></ul><p>If this parameter is not input, the granularity will be automatically calculated based on the interval between the start time and end time. Specifically, data will be queried with a granularity of min, 5min, hour, and day respectively when the period is no more than 2 hours, no more than 2 days, no more than 7 days, and over 7 days.</p>
25816
25811
  * @type {string || null}
25817
25812
  */
25818
25813
  this.Interval = null;
25819
25814
 
25820
25815
  /**
25821
- * Filter criteria used when filtering data. valid values refer to the available filter options for L7 access traffic, bandwidth, and request count in the [metric analysis filtering condition description](https://www.tencentcloud.com/document/product/1145/56985#1aaf1150-55a4-4b4d-b103-3a8317ac7945).
25822
- If needed, limit the site or content identifier by importing the corresponding value in the `ZoneIds.N` parameter.
25816
+ * <p>Filter conditions used when filtering data. For available filter options, refer to the <a href="https://www.tencentcloud.com/document/product/1552/98219?from_cn_redirect=1#1aaf1150-55a4-4b4d-b103-3a8317ac7945">Analytics Filter Options</a> for L7 client traffic, bandwidth, and request counts.<br>To limit the query to specific sites or content identifiers, pass the corresponding values in the <code>ZoneIds.N</code> parameter separately.</p>
25823
25817
  * @type {Array.<QueryCondition> || null}
25824
25818
  */
25825
25819
  this.Filters = null;
25826
25820
 
25827
25821
  /**
25828
- * Data ownership region. this parameter is deprecated. please filter data by client region in `Filters.country`.
25822
+ * <p>The region to which the data belongs. This parameter is deprecated. To filter data by client region, use <code>Filters.country</code> instead.</p>
25829
25823
  * @type {string || null}
25830
25824
  */
25831
25825
  this.Area = null;
@@ -1998,10 +1998,10 @@ This API is used to return post-protection traffic request data by default. User
1998
1998
  }
1999
1999
 
2000
2000
  /**
2001
- * This API is used to query time series data for L7 domain name business.
2002
- Create and bind policy Query instance Reset instance access password.
2003
- This API is used to query data with a delay of about 10 minutes. It is recommended to pull data from at least 10 minutes before the current time.
2004
- This API is used to return post-protection traffic request data by default. Users can query defended data in `Filters.mitigatedByWebSecurity`.
2001
+ * This API is used to query time-series data for Layer 7 domain services.
2002
+ Notes:
2003
+ 1. Data queried by this API has a latency of approximately 10 minutes. It is recommended to pull data from at least 10 minutes prior to the current time.
2004
+ 2. By default, this API returns post-protection traffic request data. Users can customize queries for mitigated data by using `Filters.mitigatedByWebSecurity`.
2005
2005
  * @param {DescribeTimingL7AnalysisDataRequest} req
2006
2006
  * @param {function(string, DescribeTimingL7AnalysisDataResponse):void} cb
2007
2007
  * @public