tencentcloud-sdk-nodejs-intl-en 3.0.1428 → 3.0.1430

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-intl-en",
-  "version": "3.0.1428",
+  "version": "3.0.1430",
   "description": "腾讯云 API NODEJS SDK",
   "main": "index.js",
   "scripts": {

package/tencentcloud/common/sdk_version.js

@@ -1,2 +1,2 @@
-const sdkVersion = "3.0.1428";
+const sdkVersion = "3.0.1430";
 module.exports = sdkVersion

package/tencentcloud/cvm/v20170312/cvm_client.js

@@ -153,6 +153,7 @@ const SpotMarketOptions = models.SpotMarketOptions;
 const ConfigureChcAssistVpcRequest = models.ConfigureChcAssistVpcRequest;
 const DescribeImportImageOsRequest = models.DescribeImportImageOsRequest;
 const CreateLaunchTemplateResponse = models.CreateLaunchTemplateResponse;
+const NetworkInterfaces = models.NetworkInterfaces;
 const CreateKeyPairRequest = models.CreateKeyPairRequest;
 const InstanceStatus = models.InstanceStatus;
 const InquiryPriceRenewInstancesResponse = models.InquiryPriceRenewInstancesResponse;

package/tencentcloud/cvm/v20170312/models.js

@@ -4317,6 +4317,12 @@ class InquiryPriceRunInstancesRequest extends  AbstractModel {
          */
         this.LaunchTemplate = null;
 
+        /**
+         * Network interface configuration for instance creation, including VPCs, subnets, and IP address allocation for primary and secondary network interfaces. This feature is in beta test in selected regions. To use this feature, [submit a ticket](https://console.tencentcloud.com/workorder/category).
+         * @type {Array.<NetworkInterfaces> || null}
+         */
+        this.NetworkInterfaces = null;
+
     }
 
     /**
@@ -4420,6 +4426,15 @@ class InquiryPriceRunInstancesRequest extends  AbstractModel {
             this.LaunchTemplate = obj;
         }
 
+        if (params.NetworkInterfaces) {
+            this.NetworkInterfaces = new Array();
+            for (let z in params.NetworkInterfaces) {
+                let obj = new NetworkInterfaces();
+                obj.deserialize(params.NetworkInterfaces[z]);
+                this.NetworkInterfaces.push(obj);
+            }
+        }
+
     }
 }
 
@@ -6594,6 +6609,12 @@ Note: this field is in beta test.
          */
         this.TemplateDataModifyAction = null;
 
+        /**
+         * Network interface configuration for instance creation, including VPCs, subnets, and IP address allocation for primary and secondary network interfaces. This feature is in beta test in selected regions. To use this feature, [submit a ticket](https://console.tencentcloud.com/workorder/category).
+         * @type {Array.<NetworkInterfaces> || null}
+         */
+        this.NetworkInterfaces = null;
+
     }
 
     /**
@@ -6701,6 +6722,15 @@ Note: this field is in beta test.
         }
         this.TemplateDataModifyAction = 'TemplateDataModifyAction' in params ? params.TemplateDataModifyAction : null;
 
+        if (params.NetworkInterfaces) {
+            this.NetworkInterfaces = new Array();
+            for (let z in params.NetworkInterfaces) {
+                let obj = new NetworkInterfaces();
+                obj.deserialize(params.NetworkInterfaces[z]);
+                this.NetworkInterfaces.push(obj);
+            }
+        }
+
     }
 }
 
@@ -7376,6 +7406,12 @@ Note: this field is in beta test.
          */
         this.TemplateDataModifyAction = null;
 
+        /**
+         * Network interface configuration for instance creation, including VPCs, subnets, and IP address allocation for primary and secondary network interfaces. This feature is in beta test in selected regions. To use this feature, [submit a ticket](https://console.tencentcloud.com/workorder/category).
+         * @type {Array.<NetworkInterfaces> || null}
+         */
+        this.NetworkInterfaces = null;
+
     }
 
     /**
@@ -7491,6 +7527,15 @@ Note: this field is in beta test.
         }
         this.TemplateDataModifyAction = 'TemplateDataModifyAction' in params ? params.TemplateDataModifyAction : null;
 
+        if (params.NetworkInterfaces) {
+            this.NetworkInterfaces = new Array();
+            for (let z in params.NetworkInterfaces) {
+                let obj = new NetworkInterfaces();
+                obj.deserialize(params.NetworkInterfaces[z]);
+                this.NetworkInterfaces.push(obj);
+            }
+        }
+
     }
 }
 
@@ -8114,6 +8159,76 @@ class CreateLaunchTemplateResponse extends  AbstractModel {
     }
 }
 
+/**
+ * Network interface configuration for instance creation, including VPCs, subnets, and IP address allocation for primary and secondary network interfaces. This feature is in beta test in selected regions. To use this feature, [submit a ticket](https://console.tencentcloud.com/workorder/category).
+ * @class
+ */
+class NetworkInterfaces extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * Specifies whether the network interface is primary or secondary. Valid values must be uppercase. The `NetworkInterfaces` array must contain exactly one `PRIMARY` network interface and can contain multiple `SECONDARY` network interfaces. Valid values:<li>`PRIMARY`: Primary network interface.</li><li>`SECONDARY`: Secondary network interface.</li>
+         * @type {string || null}
+         */
+        this.InterfaceType = null;
+
+        /**
+         * VPC ID in the format of `vpc-xxx`. You can obtain a valid VPC ID from the [VPC console](https://console.tencentcloud.com/vpc/vpc?rid=1) or from the `VpcId` field returned by the [DescribeVpcs](https://www.tencentcloud.com/document/product/215/15778) API. If both `VpcId` and `SubnetId` are set to `DEFAULT` when creating an instance, the default VPC is used.
+         * @type {string || null}
+         */
+        this.VpcId = null;
+
+        /**
+         * VPC subnet ID in the format of `subnet-xxx`. You can obtain a valid subnet ID from the [subnet console](https://console.tencentcloud.com/vpc/subnet) or from the `SubnetId` field returned by the [DescribeSubnets](https://www.tencentcloud.com/document/product/215/15784) API. If both `SubnetId` and `VpcId` are set to `DEFAULT` when creating an instance, the default VPC is used.
+         * @type {string || null}
+         */
+        this.SubnetId = null;
+
+        /**
+         * Required. Specifies the number of private IPv4 addresses automatically assigned to each network interface. Manually specifying IP addresses and automatically assigning IP addresses at the same time is not supported. Valid range: [1, 50].
+         * @type {number || null}
+         */
+        this.PrivateIpv4AddressCount = null;
+
+        /**
+         * ID of an existing elastic network interface (ENI) to be attached. This parameter applies only to secondary network interfaces. The primary network interface is created automatically through the existing process and cannot be specified using this parameter. When an existing ENI is specified, `InstanceCount` must be set to 1.
+         * @type {string || null}
+         */
+        this.NetworkInterfaceId = null;
+
+        /**
+         * Security groups associated with the instance. You can obtain the security group IDs from the `SecurityGroupId` field returned by the [DescribeSecurityGroups](https://www.tencentcloud.com/document/api/215/15808) API. If this parameter is not specified, the default security group of the specified project is associated. If no default security group exists, one is automatically created. Each user can configure up to 50 security groups per project in each region.
+         * @type {Array.<string> || null}
+         */
+        this.SecurityGroupIds = null;
+
+        /**
+         * Specifies whether the associated elastic network interface (ENI) is deleted when the CVM instance is terminated. This parameter applies only to secondary network interfaces. By default, secondary network interfaces are retained to preserve the existing behavior. This parameter does not apply to the primary network interface, which is always deleted when the instance is terminated. Default value: `false`.
+         * @type {boolean || null}
+         */
+        this.DeleteWithInstance = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.InterfaceType = 'InterfaceType' in params ? params.InterfaceType : null;
+        this.VpcId = 'VpcId' in params ? params.VpcId : null;
+        this.SubnetId = 'SubnetId' in params ? params.SubnetId : null;
+        this.PrivateIpv4AddressCount = 'PrivateIpv4AddressCount' in params ? params.PrivateIpv4AddressCount : null;
+        this.NetworkInterfaceId = 'NetworkInterfaceId' in params ? params.NetworkInterfaceId : null;
+        this.SecurityGroupIds = 'SecurityGroupIds' in params ? params.SecurityGroupIds : null;
+        this.DeleteWithInstance = 'DeleteWithInstance' in params ? params.DeleteWithInstance : null;
+
+    }
+}
+
 /**
  * CreateKeyPair request structure.
  * @class
@@ -8663,6 +8778,12 @@ If the dry run succeeds, the RequestId will be returned.
          */
         this.ChcIds = null;
 
+        /**
+         * Partition number of the partition placement group. Valid values depend on the number of partitions in the selected placement group. If the selected placement group is a partition placement group and this parameter is not specified, a partition is randomly assigned. This feature is in beta test.
+         * @type {number || null}
+         */
+        this.PartitionNumber = null;
+
         /**
          * Instance termination protection flag, indicating whether an instance is allowed to be deleted through an API. Valid values:<br><li>true: Instance protection is enabled, and the instance is not allowed to be deleted through the API.</li><br><li>false: Instance protection is disabled, and the instance is allowed to be deleted through the API.</li><br><br>Default value: false.
          * @type {boolean || null}
@@ -8675,6 +8796,12 @@ If the dry run succeeds, the RequestId will be returned.
          */
         this.EnableJumboFrame = null;
 
+        /**
+         * Network interface configuration for instance creation, including VPCs, subnets, and IP address allocation for primary and secondary network interfaces. This feature is in beta test in selected regions. To use this feature, [submit a ticket](https://console.tencentcloud.com/workorder/category).
+         * @type {Array.<NetworkInterfaces> || null}
+         */
+        this.NetworkInterfaces = null;
+
     }
 
     /**
@@ -8790,9 +8917,19 @@ If the dry run succeeds, the RequestId will be returned.
         }
         this.DedicatedClusterId = 'DedicatedClusterId' in params ? params.DedicatedClusterId : null;
         this.ChcIds = 'ChcIds' in params ? params.ChcIds : null;
+        this.PartitionNumber = 'PartitionNumber' in params ? params.PartitionNumber : null;
         this.DisableApiTermination = 'DisableApiTermination' in params ? params.DisableApiTermination : null;
         this.EnableJumboFrame = 'EnableJumboFrame' in params ? params.EnableJumboFrame : null;
 
+        if (params.NetworkInterfaces) {
+            this.NetworkInterfaces = new Array();
+            for (let z in params.NetworkInterfaces) {
+                let obj = new NetworkInterfaces();
+                obj.deserialize(params.NetworkInterfaces[z]);
+                this.NetworkInterfaces.push(obj);
+            }
+        }
+
     }
 }
 
@@ -13118,6 +13255,7 @@ module.exports = {
     ConfigureChcAssistVpcRequest: ConfigureChcAssistVpcRequest,
     DescribeImportImageOsRequest: DescribeImportImageOsRequest,
     CreateLaunchTemplateResponse: CreateLaunchTemplateResponse,
+    NetworkInterfaces: NetworkInterfaces,
     CreateKeyPairRequest: CreateKeyPairRequest,
     InstanceStatus: InstanceStatus,
     InquiryPriceRenewInstancesResponse: InquiryPriceRenewInstancesResponse,

package/tencentcloud/mdp/v20200527/models.js

@@ -6340,6 +6340,12 @@ class CreateStreamPackageHarvestJobRequest extends  AbstractModel {
          */
         this.Manifest = null;
 
+        /**
+         * Callback address after recording completion
+         * @type {string || null}
+         */
+        this.CallbackURL = null;
+
     }
 
     /**
@@ -6357,6 +6363,7 @@ class CreateStreamPackageHarvestJobRequest extends  AbstractModel {
         this.EndTime = 'EndTime' in params ? params.EndTime : null;
         this.Destination = 'Destination' in params ? params.Destination : null;
         this.Manifest = 'Manifest' in params ? params.Manifest : null;
+        this.CallbackURL = 'CallbackURL' in params ? params.CallbackURL : null;
 
     }
 }

package/tencentcloud/scf/v20180416/models.js

@@ -6833,7 +6833,7 @@ class DeleteTriggerResponse extends  AbstractModel {
         super();
 
         /**
-         * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
+         * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
          * @type {string || null}
          */
         this.RequestId = null;
@@ -6926,7 +6926,7 @@ class DeleteTriggerRequest extends  AbstractModel {
         this.TriggerDesc = null;
 
         /**
-         * Function version. It defaults to `$LATEST`. It’s recommended to use `[$DEFAULT](https://intl.cloud.tencent.com/document/product/583/36149?from_cn_redirect=1#.E9.BB.98.E8.AE.A4.E5.88.AB.E5.90.8D)` for canary release.
+         * Function version. It defaults to `$LATEST`. It's recommended to use `[$DEFAULT](https://www.tencentcloud.com/document/product/583/37458#glossary)` for canary release.
          * @type {string || null}
          */
         this.Qualifier = null;

package/tencentcloud/tokenhub/v20260322/models.js

@@ -928,6 +928,73 @@ class RenewTokenPlanTeamOrderResponse extends  AbstractModel {
     }
 }
 
+/**
+ * Usage item of an individual object in the ranking list, including the object identifier, statistical values within a time period (Stats), and a list of time series points within a time period (Series, returned only when ShowAll=false).
+ * @class
+ */
+class UsageRankItem extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * Global ranking (starting from 1). In pagination scenarios, this is still the position in the full sorting order, not the serial number within the page.
+         * @type {number || null}
+         */
+        this.Rank = null;
+
+        /**
+         * Object identifier. The apikey dimension is the APIKey ID; the endpoint dimension is the access point; the model dimension is the model name.
+         * @type {string || null}
+         */
+        this.Key = null;
+
+        /**
+         * Display name of the object. In the apikey dimension, return the APIKey name (deleted APIKeys retain their original names);
+Key whose endpoint and model dimensions are equal.
+         * @type {string || null}
+         */
+        this.Name = null;
+
+        /**
+         * Statistical value within a time period
+         * @type {UsageStats || null}
+         */
+        this.Stats = null;
+
+        /**
+         * List of time series points within a time period
+         * @type {UsageSeries || null}
+         */
+        this.Series = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.Rank = 'Rank' in params ? params.Rank : null;
+        this.Key = 'Key' in params ? params.Key : null;
+        this.Name = 'Name' in params ? params.Name : null;
+
+        if (params.Stats) {
+            let obj = new UsageStats();
+            obj.deserialize(params.Stats)
+            this.Stats = obj;
+        }
+
+        if (params.Series) {
+            let obj = new UsageSeries();
+            obj.deserialize(params.Series)
+            this.Series = obj;
+        }
+
+    }
+}
+
 /**
  * Token Plan API Key details
  * @class
@@ -1196,6 +1263,69 @@ class DescribeApiKeyListRequest extends  AbstractModel {
     }
 }
 
+/**
+ * List of time series points within the usage time period (indexed by metric key). It is a JSON array in string form. The array length matches the response Timestamps, and null is used where there is no data point. The specific keys included are determined by the response MetricKeys.
+ * @class
+ */
+class UsageSeries extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Amount of total tokens used within a time period in JSON string form, for example, <code>&quot;[12,null,15]&quot;</code>.</p>
+         * @type {string || null}
+         */
+        this.TotalToken = null;
+
+        /**
+         * <p>Amount of input tokens used within a time period in JSON string form, for example, <code>&quot;[7,null,9]&quot;</code>.</p>
+         * @type {string || null}
+         */
+        this.InputTotalToken = null;
+
+        /**
+         * <p>Amount of output tokens used within a time period in JSON string form, for example, <code>&quot;[5,null,6]&quot;</code>.</p>
+         * @type {string || null}
+         */
+        this.OutputTotalToken = null;
+
+        /**
+         * <p>Read cache token count usage of the tokens family in JSON string form within a time period, for example, <code>&quot;[5,null,6]&quot;</code>.</p>
+         * @type {string || null}
+         */
+        this.CacheTotalToken = null;
+
+        /**
+         * <p>Usage of search requests in JSON string form within a time period, for example, <code>&quot;[5,null,6]&quot;</code>.</p>
+         * @type {string || null}
+         */
+        this.SearchRequestCount = null;
+
+        /**
+         * <p>Usage of search engine call count in JSON string form within a time period, for example, <code>&quot;[5,null,6]&quot;</code>.</p>
+         * @type {string || null}
+         */
+        this.SearchCount = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.TotalToken = 'TotalToken' in params ? params.TotalToken : null;
+        this.InputTotalToken = 'InputTotalToken' in params ? params.InputTotalToken : null;
+        this.OutputTotalToken = 'OutputTotalToken' in params ? params.OutputTotalToken : null;
+        this.CacheTotalToken = 'CacheTotalToken' in params ? params.CacheTotalToken : null;
+        this.SearchRequestCount = 'SearchRequestCount' in params ? params.SearchRequestCount : null;
+        this.SearchCount = 'SearchCount' in params ? params.SearchCount : null;
+
+    }
+}
+
 /**
  * CreateGlossary request structure.
  * @class
@@ -1738,25 +1868,13 @@ class ModifyTokenPlanApiKeyRequest extends  AbstractModel {
 }
 
 /**
- * Billing item for Token aggregation
+ * ModifyApiKeyStatus request structure.
  * @class
  */
-class TokenSummaryBillingItem extends  AbstractModel {
+class ModifyApiKeyStatusRequest extends  AbstractModel {
     constructor(){
         super();
 
-        /**
-         * Billing item. Values: input (input Token), output (output Token), cache (cache Token), call_count (call count).
-         * @type {string || null}
-         */
-        this.BillingItem = null;
-
-        /**
-         * Aggregated raw usage of this billing item during a period. Unit: tokens.
-         * @type {number || null}
-         */
-        this.TotalQty = null;
-
     }
 
     /**
@@ -1766,8 +1884,6 @@ class TokenSummaryBillingItem extends  AbstractModel {
         if (!params) {
             return;
         }
-        this.BillingItem = 'BillingItem' in params ? params.BillingItem : null;
-        this.TotalQty = 'TotalQty' in params ? params.TotalQty : null;
 
     }
 }
@@ -2291,6 +2407,41 @@ class DescribeTokenPlanApiKeyUsageDetailRequest extends  AbstractModel {
     }
 }
 
+/**
+ * Billing item for Token aggregation
+ * @class
+ */
+class TokenSummaryBillingItem extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * Billing item. Values: input (input Token), output (output Token), cache (cache Token), call_count (call count).
+         * @type {string || null}
+         */
+        this.BillingItem = null;
+
+        /**
+         * Aggregated raw usage of this billing item during a period. Unit: tokens.
+         * @type {number || null}
+         */
+        this.TotalQty = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.BillingItem = 'BillingItem' in params ? params.BillingItem : null;
+        this.TotalQty = 'TotalQty' in params ? params.TotalQty : null;
+
+    }
+}
+
 /**
  * UpgradeTokenPlanTeamOrder request structure.
  * @class
@@ -2327,13 +2478,61 @@ class UpgradeTokenPlanTeamOrderRequest extends  AbstractModel {
 }
 
 /**
- * ModifyApiKeyStatus request structure.
+ * DescribeUsageRankList request structure.
  * @class
  */
-class ModifyApiKeyStatusRequest extends  AbstractModel {
+class DescribeUsageRankListRequest extends  AbstractModel {
     constructor(){
         super();
 
+        /**
+         * <p>Statistical dimension. Values: apikey (statistics by APIKey), endpoint (statistics by access point), model (statistics by model).</p>
+         * @type {string || null}
+         */
+        this.Dimension = null;
+
+        /**
+         * <p>Start time (inclusive interval), in RFC3339 format.</p>
+         * @type {string || null}
+         */
+        this.StartTime = null;
+
+        /**
+         * <p>End time (open interval) in RFC3339 format. The maximum span from StartTime is 90 days.</p>
+         * @type {string || null}
+         */
+        this.EndTime = null;
+
+        /**
+         * <p>Metric family switch field.</p><ul><li>tokens (default): Token consumption chart (statistics=sum), supports Dimension = apikey/endpoint/model</li><li>search [to be launched]: Online search call count (statistics=sum), only supports Dimension = model</li><li>Other values return InvalidParameter.</li></ul><p>Enum values:</p><ul><li>tokens: tokens</li></ul>
+         * @type {string || null}
+         */
+        this.MetricType = null;
+
+        /**
+         * <p>Dimension filtering value. An empty string indicates querying all objects; a non-empty string indicates querying only the specified single object (for example, a designated APIKey ID). Maximum 256 characters.</p>
+         * @type {string || null}
+         */
+        this.Target = null;
+
+        /**
+         * <p>Statistical granularity (seconds). Value: 60, 300, 3600, 86400. Must not be less than the lower limit corresponding to the span: span ≤ 1 day → 60; 1–5 days → 300; 5–10 days → 3600; &gt; 10 days → 86400. Used only when ShowAll=false.</p>
+         * @type {number || null}
+         */
+        this.Period = null;
+
+        /**
+         * <p>Pagination starting point, starting from 0, default 0. Ignore timing when ShowAll=true. Page size fixed as 10.</p>
+         * @type {number || null}
+         */
+        this.Offset = null;
+
+        /**
+         * <p>Whether to return full result.</p><ul><li>false (default): Return TopList in pages by Offset (10 items per page). Each object contains <br>Series time series points for drawing curves.</li><li>true: Ignore Offset and return the full object list without Series (CSV export scenario).</li></ul>
+         * @type {boolean || null}
+         */
+        this.ShowAll = null;
+
     }
 
     /**
@@ -2343,6 +2542,14 @@ class ModifyApiKeyStatusRequest extends  AbstractModel {
         if (!params) {
             return;
         }
+        this.Dimension = 'Dimension' in params ? params.Dimension : null;
+        this.StartTime = 'StartTime' in params ? params.StartTime : null;
+        this.EndTime = 'EndTime' in params ? params.EndTime : null;
+        this.MetricType = 'MetricType' in params ? params.MetricType : null;
+        this.Target = 'Target' in params ? params.Target : null;
+        this.Period = 'Period' in params ? params.Period : null;
+        this.Offset = 'Offset' in params ? params.Offset : null;
+        this.ShowAll = 'ShowAll' in params ? params.ShowAll : null;
 
     }
 }
@@ -3419,6 +3626,213 @@ class CreateTokenPlanApiKeysRequest extends  AbstractModel {
     }
 }
 
+/**
+ * Statistical aggregate values within a time period (indexed by metric key). Declares that both the tokens and search field families are in this schema, with values obtained based on the actual MetricKeys returned. See the top-level `MetricKeys` field in the response.
+ * @class
+ */
+class UsageStats extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Total tokens accumulated within a time period.</p>
+         * @type {number || null}
+         */
+        this.TotalToken = null;
+
+        /**
+         * <p>[tokens family] Total input tokens within a time period.</p>
+         * @type {number || null}
+         */
+        this.InputTotalToken = null;
+
+        /**
+         * <p>[tokens family] Total output tokens within a time period.</p>
+         * @type {number || null}
+         */
+        this.OutputTotalToken = null;
+
+        /**
+         * <p>[token family] Cumulative number of tokens read from the cache within a time period (cache hit part)</p>
+         * @type {number || null}
+         */
+        this.CacheTotalToken = null;
+
+        /**
+         * <p>Total online search requests in the [search group]</p>
+         * @type {number || null}
+         */
+        this.SearchRequestCount = null;
+
+        /**
+         * <p>[search family] Total search engine calls</p>
+         * @type {number || null}
+         */
+        this.SearchCount = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.TotalToken = 'TotalToken' in params ? params.TotalToken : null;
+        this.InputTotalToken = 'InputTotalToken' in params ? params.InputTotalToken : null;
+        this.OutputTotalToken = 'OutputTotalToken' in params ? params.OutputTotalToken : null;
+        this.CacheTotalToken = 'CacheTotalToken' in params ? params.CacheTotalToken : null;
+        this.SearchRequestCount = 'SearchRequestCount' in params ? params.SearchRequestCount : null;
+        this.SearchCount = 'SearchCount' in params ? params.SearchCount : null;
+
+    }
+}
+
+/**
+ * DescribeUsageRankList response structure.
+ * @class
+ */
+class DescribeUsageRankListResponse extends  AbstractModel {
+    constructor(){
+        super();
+
+        /**
+         * <p>Statistical dimension of the backfill request.</p>
+         * @type {string || null}
+         */
+        this.Dimension = null;
+
+        /**
+         * <p>Metrics family of the backfill request: tokens / search.</p>
+         * @type {string || null}
+         */
+        this.MetricType = null;
+
+        /**
+         * <p>List of metric keys actually included in Stats / Series / PageStats / TotalStats in this response, case-sensitive by MetricType: tokens=[Total,Input,Output,Cache], search=[SearchRequestCount,SearchCount]</p>
+         * @type {Array.<string> || null}
+         */
+        this.MetricKeys = null;
+
+        /**
+         * <p>View (data source)</p>
+         * @type {string || null}
+         */
+        this.ViewName = null;
+
+        /**
+         * <p>Statistical granularity (in seconds) of the backfill request. It is 0 when ShowAll=true.</p>
+         * @type {number || null}
+         */
+        this.Period = null;
+
+        /**
+         * <p>Backfill the start time of the request.</p>
+         * @type {string || null}
+         */
+        this.StartTime = null;
+
+        /**
+         * <p>End time of the backfill request.</p>
+         * @type {string || null}
+         */
+        this.EndTime = null;
+
+        /**
+         * <p>Total number of objects.</p>
+         * @type {number || null}
+         */
+        this.Total = null;
+
+        /**
+         * <p>Backfill the pagination starting point of the request. It is 0 when ShowAll=true.</p>
+         * @type {number || null}
+         */
+        this.Offset = null;
+
+        /**
+         * <p>Page size. It is always 10. When ShowAll=true, it is Total.</p>
+         * @type {number || null}
+         */
+        this.Limit = null;
+
+        /**
+         * <p>Timestamp sequence corresponding to the Series array (Unix seconds). Empty array when ShowAll=true.</p>
+         * @type {Array.<number> || null}
+         */
+        this.Timestamps = null;
+
+        /**
+         * <p>Object ranking list, sorted by <code>MetricKeys[0]</code> in descending order. When ShowAll=false, it is the 10 objects on the current page (including Series); when ShowAll=true, it is all objects (excluding Series, used for CSV export).</p>
+         * @type {Array.<UsageRankItem> || null}
+         */
+        this.TopList = null;
+
+        /**
+         * <p>Pagination statistics result</p>
+         * @type {UsageStats || null}
+         */
+        this.PageStats = null;
+
+        /**
+         * <p>Total statistics result</p>
+         * @type {UsageStats || null}
+         */
+        this.TotalStats = null;
+
+        /**
+         * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
+         * @type {string || null}
+         */
+        this.RequestId = null;
+
+    }
+
+    /**
+     * @private
+     */
+    deserialize(params) {
+        if (!params) {
+            return;
+        }
+        this.Dimension = 'Dimension' in params ? params.Dimension : null;
+        this.MetricType = 'MetricType' in params ? params.MetricType : null;
+        this.MetricKeys = 'MetricKeys' in params ? params.MetricKeys : null;
+        this.ViewName = 'ViewName' in params ? params.ViewName : null;
+        this.Period = 'Period' in params ? params.Period : null;
+        this.StartTime = 'StartTime' in params ? params.StartTime : null;
+        this.EndTime = 'EndTime' in params ? params.EndTime : null;
+        this.Total = 'Total' in params ? params.Total : null;
+        this.Offset = 'Offset' in params ? params.Offset : null;
+        this.Limit = 'Limit' in params ? params.Limit : null;
+        this.Timestamps = 'Timestamps' in params ? params.Timestamps : null;
+
+        if (params.TopList) {
+            this.TopList = new Array();
+            for (let z in params.TopList) {
+                let obj = new UsageRankItem();
+                obj.deserialize(params.TopList[z]);
+                this.TopList.push(obj);
+            }
+        }
+
+        if (params.PageStats) {
+            let obj = new UsageStats();
+            obj.deserialize(params.PageStats)
+            this.PageStats = obj;
+        }
+
+        if (params.TotalStats) {
+            let obj = new UsageStats();
+            obj.deserialize(params.TotalStats)
+            this.TotalStats = obj;
+        }
+        this.RequestId = 'RequestId' in params ? params.RequestId : null;
+
+    }
+}
+
 /**
  * DeleteTokenPlanApiKey request structure.
  * @class
@@ -3758,10 +4172,12 @@ module.exports = {
     DeleteGlossaryEntriesResponse: DeleteGlossaryEntriesResponse,
     DescribeApiKeyListResponse: DescribeApiKeyListResponse,
     RenewTokenPlanTeamOrderResponse: RenewTokenPlanTeamOrderResponse,
+    UsageRankItem: UsageRankItem,
     TokenPlanApiKeyInfo: TokenPlanApiKeyInfo,
     ModifyApiKeyInfoResponse: ModifyApiKeyInfoResponse,
     ModifyTokenPlanApiKeyResponse: ModifyTokenPlanApiKeyResponse,
     DescribeApiKeyListRequest: DescribeApiKeyListRequest,
+    UsageSeries: UsageSeries,
     CreateGlossaryRequest: CreateGlossaryRequest,
     DescribeGlossaryEntriesResponse: DescribeGlossaryEntriesResponse,
     DeleteGlossaryRequest: DeleteGlossaryRequest,
@@ -3774,7 +4190,7 @@ module.exports = {
     DeleteApiKeyResponse: DeleteApiKeyResponse,
     ModifyGlossaryEntryInput: ModifyGlossaryEntryInput,
     ModifyTokenPlanApiKeyRequest: ModifyTokenPlanApiKeyRequest,
-    TokenSummaryBillingItem: TokenSummaryBillingItem,
+    ModifyApiKeyStatusRequest: ModifyApiKeyStatusRequest,
     DescribeTokenPlanApiKeyUsageDetailResponse: DescribeTokenPlanApiKeyUsageDetailResponse,
     RequestSort: RequestSort,
     ModifyApiKeyInfoRequest: ModifyApiKeyInfoRequest,
@@ -3786,8 +4202,9 @@ module.exports = {
     DescribeGlossariesRequest: DescribeGlossariesRequest,
     DeleteTokenPlanApiKeyResponse: DeleteTokenPlanApiKeyResponse,
     DescribeTokenPlanApiKeyUsageDetailRequest: DescribeTokenPlanApiKeyUsageDetailRequest,
+    TokenSummaryBillingItem: TokenSummaryBillingItem,
     UpgradeTokenPlanTeamOrderRequest: UpgradeTokenPlanTeamOrderRequest,
-    ModifyApiKeyStatusRequest: ModifyApiKeyStatusRequest,
+    DescribeUsageRankListRequest: DescribeUsageRankListRequest,
     QuotaInfo: QuotaInfo,
     CreateGlossaryEntriesRequest: CreateGlossaryEntriesRequest,
     ApiKeyDetail: ApiKeyDetail,
@@ -3805,6 +4222,8 @@ module.exports = {
     ModifyGlossaryEntriesResponse: ModifyGlossaryEntriesResponse,
     DescribeTokenPlanResponse: DescribeTokenPlanResponse,
     CreateTokenPlanApiKeysRequest: CreateTokenPlanApiKeysRequest,
+    UsageStats: UsageStats,
+    DescribeUsageRankListResponse: DescribeUsageRankListResponse,
     DeleteTokenPlanApiKeyRequest: DeleteTokenPlanApiKeyRequest,
     DescribeApiKeyResponse: DescribeApiKeyResponse,
     DescribeTokenPlanApiKeyListRequest: DescribeTokenPlanApiKeyListRequest,

package/tencentcloud/tokenhub/v20260322/tokenhub_client.js

@@ -35,10 +35,12 @@ const SubPackageBalance = models.SubPackageBalance;
 const DeleteGlossaryEntriesResponse = models.DeleteGlossaryEntriesResponse;
 const DescribeApiKeyListResponse = models.DescribeApiKeyListResponse;
 const RenewTokenPlanTeamOrderResponse = models.RenewTokenPlanTeamOrderResponse;
+const UsageRankItem = models.UsageRankItem;
 const TokenPlanApiKeyInfo = models.TokenPlanApiKeyInfo;
 const ModifyApiKeyInfoResponse = models.ModifyApiKeyInfoResponse;
 const ModifyTokenPlanApiKeyResponse = models.ModifyTokenPlanApiKeyResponse;
 const DescribeApiKeyListRequest = models.DescribeApiKeyListRequest;
+const UsageSeries = models.UsageSeries;
 const CreateGlossaryRequest = models.CreateGlossaryRequest;
 const DescribeGlossaryEntriesResponse = models.DescribeGlossaryEntriesResponse;
 const DeleteGlossaryRequest = models.DeleteGlossaryRequest;
@@ -51,7 +53,7 @@ const DescribeApiKeyRequest = models.DescribeApiKeyRequest;
 const DeleteApiKeyResponse = models.DeleteApiKeyResponse;
 const ModifyGlossaryEntryInput = models.ModifyGlossaryEntryInput;
 const ModifyTokenPlanApiKeyRequest = models.ModifyTokenPlanApiKeyRequest;
-const TokenSummaryBillingItem = models.TokenSummaryBillingItem;
+const ModifyApiKeyStatusRequest = models.ModifyApiKeyStatusRequest;
 const DescribeTokenPlanApiKeyUsageDetailResponse = models.DescribeTokenPlanApiKeyUsageDetailResponse;
 const RequestSort = models.RequestSort;
 const ModifyApiKeyInfoRequest = models.ModifyApiKeyInfoRequest;
@@ -63,8 +65,9 @@ const RenewTokenPlanTeamOrderRequest = models.RenewTokenPlanTeamOrderRequest;
 const DescribeGlossariesRequest = models.DescribeGlossariesRequest;
 const DeleteTokenPlanApiKeyResponse = models.DeleteTokenPlanApiKeyResponse;
 const DescribeTokenPlanApiKeyUsageDetailRequest = models.DescribeTokenPlanApiKeyUsageDetailRequest;
+const TokenSummaryBillingItem = models.TokenSummaryBillingItem;
 const UpgradeTokenPlanTeamOrderRequest = models.UpgradeTokenPlanTeamOrderRequest;
-const ModifyApiKeyStatusRequest = models.ModifyApiKeyStatusRequest;
+const DescribeUsageRankListRequest = models.DescribeUsageRankListRequest;
 const QuotaInfo = models.QuotaInfo;
 const CreateGlossaryEntriesRequest = models.CreateGlossaryEntriesRequest;
 const ApiKeyDetail = models.ApiKeyDetail;
@@ -82,6 +85,8 @@ const UpgradeTokenPlanTeamOrderResponse = models.UpgradeTokenPlanTeamOrderRespon
 const ModifyGlossaryEntriesResponse = models.ModifyGlossaryEntriesResponse;
 const DescribeTokenPlanResponse = models.DescribeTokenPlanResponse;
 const CreateTokenPlanApiKeysRequest = models.CreateTokenPlanApiKeysRequest;
+const UsageStats = models.UsageStats;
+const DescribeUsageRankListResponse = models.DescribeUsageRankListResponse;
 const DeleteTokenPlanApiKeyRequest = models.DeleteTokenPlanApiKeyRequest;
 const DescribeApiKeyResponse = models.DescribeApiKeyResponse;
 const DescribeTokenPlanApiKeyListRequest = models.DescribeTokenPlanApiKeyListRequest;
@@ -242,6 +247,29 @@ Query specified entries in a Termbase. Support pagination.
         this.request("DescribeGlossaryEntries", req, resp, cb);
     }
 
+    /**
+     * Query the usage ranking list.
+
+Metric family (MetricType)
+- `tokens` (default): Token usage statistics. Supports Dimension = apikey / endpoint / model.
+Metrics returned: TotalToken (total) / InputTotalToken (input) / OutputTotalToken (output) / CacheTotalToken (read cache).
+- `search`: [To be launched] Online search usage statistics. Supports Dimension = apikey / endpoint / model.
+Returns metrics: SearchRequestCount (search request count)/SearchCount (search engine call count).
+
+content
+-The MetricType field is used to switch metric families. The response echoes back MetricType and MetricKeys.
+-TotalStats: The aggregated value of all objects over the entire time window.
+-PageStats: The aggregated value of objects on the current page.
+- TopList: A list of objects sorted by MetricKeys[0] in descending order, including the aggregated value over the entire period and point-in-time curves.
+     * @param {DescribeUsageRankListRequest} req
+     * @param {function(string, DescribeUsageRankListResponse):void} cb
+     * @public
+     */
+    DescribeUsageRankList(req, cb) {
+        let resp = new DescribeUsageRankListResponse();
+        this.request("DescribeUsageRankList", req, resp, cb);
+    }
+
     /**
      * Delete terminology entries in batches.