tencentcloud-sdk-nodejs-intl-en 3.0.1429 → 3.0.1430
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,2 +1,2 @@
|
|
|
1
|
-
const sdkVersion = "3.0.
|
|
1
|
+
const sdkVersion = "3.0.1430";
|
|
2
2
|
module.exports = sdkVersion
|
|
@@ -6833,7 +6833,7 @@ class DeleteTriggerResponse extends AbstractModel {
|
|
|
6833
6833
|
super();
|
|
6834
6834
|
|
|
6835
6835
|
/**
|
|
6836
|
-
* The unique request ID,
|
|
6836
|
+
* 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.
|
|
6837
6837
|
* @type {string || null}
|
|
6838
6838
|
*/
|
|
6839
6839
|
this.RequestId = null;
|
|
@@ -6926,7 +6926,7 @@ class DeleteTriggerRequest extends AbstractModel {
|
|
|
6926
6926
|
this.TriggerDesc = null;
|
|
6927
6927
|
|
|
6928
6928
|
/**
|
|
6929
|
-
* Function version. It defaults to `$LATEST`. It
|
|
6929
|
+
* Function version. It defaults to `$LATEST`. It's recommended to use `[$DEFAULT](https://www.tencentcloud.com/document/product/583/37458#glossary)` for canary release.
|
|
6930
6930
|
* @type {string || null}
|
|
6931
6931
|
*/
|
|
6932
6932
|
this.Qualifier = null;
|
|
@@ -928,6 +928,73 @@ class RenewTokenPlanTeamOrderResponse extends AbstractModel {
|
|
|
928
928
|
}
|
|
929
929
|
}
|
|
930
930
|
|
|
931
|
+
/**
|
|
932
|
+
* 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).
|
|
933
|
+
* @class
|
|
934
|
+
*/
|
|
935
|
+
class UsageRankItem extends AbstractModel {
|
|
936
|
+
constructor(){
|
|
937
|
+
super();
|
|
938
|
+
|
|
939
|
+
/**
|
|
940
|
+
* 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.
|
|
941
|
+
* @type {number || null}
|
|
942
|
+
*/
|
|
943
|
+
this.Rank = null;
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* Object identifier. The apikey dimension is the APIKey ID; the endpoint dimension is the access point; the model dimension is the model name.
|
|
947
|
+
* @type {string || null}
|
|
948
|
+
*/
|
|
949
|
+
this.Key = null;
|
|
950
|
+
|
|
951
|
+
/**
|
|
952
|
+
* Display name of the object. In the apikey dimension, return the APIKey name (deleted APIKeys retain their original names);
|
|
953
|
+
Key whose endpoint and model dimensions are equal.
|
|
954
|
+
* @type {string || null}
|
|
955
|
+
*/
|
|
956
|
+
this.Name = null;
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
* Statistical value within a time period
|
|
960
|
+
* @type {UsageStats || null}
|
|
961
|
+
*/
|
|
962
|
+
this.Stats = null;
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* List of time series points within a time period
|
|
966
|
+
* @type {UsageSeries || null}
|
|
967
|
+
*/
|
|
968
|
+
this.Series = null;
|
|
969
|
+
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* @private
|
|
974
|
+
*/
|
|
975
|
+
deserialize(params) {
|
|
976
|
+
if (!params) {
|
|
977
|
+
return;
|
|
978
|
+
}
|
|
979
|
+
this.Rank = 'Rank' in params ? params.Rank : null;
|
|
980
|
+
this.Key = 'Key' in params ? params.Key : null;
|
|
981
|
+
this.Name = 'Name' in params ? params.Name : null;
|
|
982
|
+
|
|
983
|
+
if (params.Stats) {
|
|
984
|
+
let obj = new UsageStats();
|
|
985
|
+
obj.deserialize(params.Stats)
|
|
986
|
+
this.Stats = obj;
|
|
987
|
+
}
|
|
988
|
+
|
|
989
|
+
if (params.Series) {
|
|
990
|
+
let obj = new UsageSeries();
|
|
991
|
+
obj.deserialize(params.Series)
|
|
992
|
+
this.Series = obj;
|
|
993
|
+
}
|
|
994
|
+
|
|
995
|
+
}
|
|
996
|
+
}
|
|
997
|
+
|
|
931
998
|
/**
|
|
932
999
|
* Token Plan API Key details
|
|
933
1000
|
* @class
|
|
@@ -1196,6 +1263,69 @@ class DescribeApiKeyListRequest extends AbstractModel {
|
|
|
1196
1263
|
}
|
|
1197
1264
|
}
|
|
1198
1265
|
|
|
1266
|
+
/**
|
|
1267
|
+
* 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.
|
|
1268
|
+
* @class
|
|
1269
|
+
*/
|
|
1270
|
+
class UsageSeries extends AbstractModel {
|
|
1271
|
+
constructor(){
|
|
1272
|
+
super();
|
|
1273
|
+
|
|
1274
|
+
/**
|
|
1275
|
+
* <p>Amount of total tokens used within a time period in JSON string form, for example, <code>"[12,null,15]"</code>.</p>
|
|
1276
|
+
* @type {string || null}
|
|
1277
|
+
*/
|
|
1278
|
+
this.TotalToken = null;
|
|
1279
|
+
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>Amount of input tokens used within a time period in JSON string form, for example, <code>"[7,null,9]"</code>.</p>
|
|
1282
|
+
* @type {string || null}
|
|
1283
|
+
*/
|
|
1284
|
+
this.InputTotalToken = null;
|
|
1285
|
+
|
|
1286
|
+
/**
|
|
1287
|
+
* <p>Amount of output tokens used within a time period in JSON string form, for example, <code>"[5,null,6]"</code>.</p>
|
|
1288
|
+
* @type {string || null}
|
|
1289
|
+
*/
|
|
1290
|
+
this.OutputTotalToken = null;
|
|
1291
|
+
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>Read cache token count usage of the tokens family in JSON string form within a time period, for example, <code>"[5,null,6]"</code>.</p>
|
|
1294
|
+
* @type {string || null}
|
|
1295
|
+
*/
|
|
1296
|
+
this.CacheTotalToken = null;
|
|
1297
|
+
|
|
1298
|
+
/**
|
|
1299
|
+
* <p>Usage of search requests in JSON string form within a time period, for example, <code>"[5,null,6]"</code>.</p>
|
|
1300
|
+
* @type {string || null}
|
|
1301
|
+
*/
|
|
1302
|
+
this.SearchRequestCount = null;
|
|
1303
|
+
|
|
1304
|
+
/**
|
|
1305
|
+
* <p>Usage of search engine call count in JSON string form within a time period, for example, <code>"[5,null,6]"</code>.</p>
|
|
1306
|
+
* @type {string || null}
|
|
1307
|
+
*/
|
|
1308
|
+
this.SearchCount = null;
|
|
1309
|
+
|
|
1310
|
+
}
|
|
1311
|
+
|
|
1312
|
+
/**
|
|
1313
|
+
* @private
|
|
1314
|
+
*/
|
|
1315
|
+
deserialize(params) {
|
|
1316
|
+
if (!params) {
|
|
1317
|
+
return;
|
|
1318
|
+
}
|
|
1319
|
+
this.TotalToken = 'TotalToken' in params ? params.TotalToken : null;
|
|
1320
|
+
this.InputTotalToken = 'InputTotalToken' in params ? params.InputTotalToken : null;
|
|
1321
|
+
this.OutputTotalToken = 'OutputTotalToken' in params ? params.OutputTotalToken : null;
|
|
1322
|
+
this.CacheTotalToken = 'CacheTotalToken' in params ? params.CacheTotalToken : null;
|
|
1323
|
+
this.SearchRequestCount = 'SearchRequestCount' in params ? params.SearchRequestCount : null;
|
|
1324
|
+
this.SearchCount = 'SearchCount' in params ? params.SearchCount : null;
|
|
1325
|
+
|
|
1326
|
+
}
|
|
1327
|
+
}
|
|
1328
|
+
|
|
1199
1329
|
/**
|
|
1200
1330
|
* CreateGlossary request structure.
|
|
1201
1331
|
* @class
|
|
@@ -1738,25 +1868,13 @@ class ModifyTokenPlanApiKeyRequest extends AbstractModel {
|
|
|
1738
1868
|
}
|
|
1739
1869
|
|
|
1740
1870
|
/**
|
|
1741
|
-
*
|
|
1871
|
+
* ModifyApiKeyStatus request structure.
|
|
1742
1872
|
* @class
|
|
1743
1873
|
*/
|
|
1744
|
-
class
|
|
1874
|
+
class ModifyApiKeyStatusRequest extends AbstractModel {
|
|
1745
1875
|
constructor(){
|
|
1746
1876
|
super();
|
|
1747
1877
|
|
|
1748
|
-
/**
|
|
1749
|
-
* Billing item. Values: input (input Token), output (output Token), cache (cache Token), call_count (call count).
|
|
1750
|
-
* @type {string || null}
|
|
1751
|
-
*/
|
|
1752
|
-
this.BillingItem = null;
|
|
1753
|
-
|
|
1754
|
-
/**
|
|
1755
|
-
* Aggregated raw usage of this billing item during a period. Unit: tokens.
|
|
1756
|
-
* @type {number || null}
|
|
1757
|
-
*/
|
|
1758
|
-
this.TotalQty = null;
|
|
1759
|
-
|
|
1760
1878
|
}
|
|
1761
1879
|
|
|
1762
1880
|
/**
|
|
@@ -1766,8 +1884,6 @@ class TokenSummaryBillingItem extends AbstractModel {
|
|
|
1766
1884
|
if (!params) {
|
|
1767
1885
|
return;
|
|
1768
1886
|
}
|
|
1769
|
-
this.BillingItem = 'BillingItem' in params ? params.BillingItem : null;
|
|
1770
|
-
this.TotalQty = 'TotalQty' in params ? params.TotalQty : null;
|
|
1771
1887
|
|
|
1772
1888
|
}
|
|
1773
1889
|
}
|
|
@@ -2291,6 +2407,41 @@ class DescribeTokenPlanApiKeyUsageDetailRequest extends AbstractModel {
|
|
|
2291
2407
|
}
|
|
2292
2408
|
}
|
|
2293
2409
|
|
|
2410
|
+
/**
|
|
2411
|
+
* Billing item for Token aggregation
|
|
2412
|
+
* @class
|
|
2413
|
+
*/
|
|
2414
|
+
class TokenSummaryBillingItem extends AbstractModel {
|
|
2415
|
+
constructor(){
|
|
2416
|
+
super();
|
|
2417
|
+
|
|
2418
|
+
/**
|
|
2419
|
+
* Billing item. Values: input (input Token), output (output Token), cache (cache Token), call_count (call count).
|
|
2420
|
+
* @type {string || null}
|
|
2421
|
+
*/
|
|
2422
|
+
this.BillingItem = null;
|
|
2423
|
+
|
|
2424
|
+
/**
|
|
2425
|
+
* Aggregated raw usage of this billing item during a period. Unit: tokens.
|
|
2426
|
+
* @type {number || null}
|
|
2427
|
+
*/
|
|
2428
|
+
this.TotalQty = null;
|
|
2429
|
+
|
|
2430
|
+
}
|
|
2431
|
+
|
|
2432
|
+
/**
|
|
2433
|
+
* @private
|
|
2434
|
+
*/
|
|
2435
|
+
deserialize(params) {
|
|
2436
|
+
if (!params) {
|
|
2437
|
+
return;
|
|
2438
|
+
}
|
|
2439
|
+
this.BillingItem = 'BillingItem' in params ? params.BillingItem : null;
|
|
2440
|
+
this.TotalQty = 'TotalQty' in params ? params.TotalQty : null;
|
|
2441
|
+
|
|
2442
|
+
}
|
|
2443
|
+
}
|
|
2444
|
+
|
|
2294
2445
|
/**
|
|
2295
2446
|
* UpgradeTokenPlanTeamOrder request structure.
|
|
2296
2447
|
* @class
|
|
@@ -2327,13 +2478,61 @@ class UpgradeTokenPlanTeamOrderRequest extends AbstractModel {
|
|
|
2327
2478
|
}
|
|
2328
2479
|
|
|
2329
2480
|
/**
|
|
2330
|
-
*
|
|
2481
|
+
* DescribeUsageRankList request structure.
|
|
2331
2482
|
* @class
|
|
2332
2483
|
*/
|
|
2333
|
-
class
|
|
2484
|
+
class DescribeUsageRankListRequest extends AbstractModel {
|
|
2334
2485
|
constructor(){
|
|
2335
2486
|
super();
|
|
2336
2487
|
|
|
2488
|
+
/**
|
|
2489
|
+
* <p>Statistical dimension. Values: apikey (statistics by APIKey), endpoint (statistics by access point), model (statistics by model).</p>
|
|
2490
|
+
* @type {string || null}
|
|
2491
|
+
*/
|
|
2492
|
+
this.Dimension = null;
|
|
2493
|
+
|
|
2494
|
+
/**
|
|
2495
|
+
* <p>Start time (inclusive interval), in RFC3339 format.</p>
|
|
2496
|
+
* @type {string || null}
|
|
2497
|
+
*/
|
|
2498
|
+
this.StartTime = null;
|
|
2499
|
+
|
|
2500
|
+
/**
|
|
2501
|
+
* <p>End time (open interval) in RFC3339 format. The maximum span from StartTime is 90 days.</p>
|
|
2502
|
+
* @type {string || null}
|
|
2503
|
+
*/
|
|
2504
|
+
this.EndTime = null;
|
|
2505
|
+
|
|
2506
|
+
/**
|
|
2507
|
+
* <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>
|
|
2508
|
+
* @type {string || null}
|
|
2509
|
+
*/
|
|
2510
|
+
this.MetricType = null;
|
|
2511
|
+
|
|
2512
|
+
/**
|
|
2513
|
+
* <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>
|
|
2514
|
+
* @type {string || null}
|
|
2515
|
+
*/
|
|
2516
|
+
this.Target = null;
|
|
2517
|
+
|
|
2518
|
+
/**
|
|
2519
|
+
* <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; > 10 days → 86400. Used only when ShowAll=false.</p>
|
|
2520
|
+
* @type {number || null}
|
|
2521
|
+
*/
|
|
2522
|
+
this.Period = null;
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* <p>Pagination starting point, starting from 0, default 0. Ignore timing when ShowAll=true. Page size fixed as 10.</p>
|
|
2526
|
+
* @type {number || null}
|
|
2527
|
+
*/
|
|
2528
|
+
this.Offset = null;
|
|
2529
|
+
|
|
2530
|
+
/**
|
|
2531
|
+
* <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>
|
|
2532
|
+
* @type {boolean || null}
|
|
2533
|
+
*/
|
|
2534
|
+
this.ShowAll = null;
|
|
2535
|
+
|
|
2337
2536
|
}
|
|
2338
2537
|
|
|
2339
2538
|
/**
|
|
@@ -2343,6 +2542,14 @@ class ModifyApiKeyStatusRequest extends AbstractModel {
|
|
|
2343
2542
|
if (!params) {
|
|
2344
2543
|
return;
|
|
2345
2544
|
}
|
|
2545
|
+
this.Dimension = 'Dimension' in params ? params.Dimension : null;
|
|
2546
|
+
this.StartTime = 'StartTime' in params ? params.StartTime : null;
|
|
2547
|
+
this.EndTime = 'EndTime' in params ? params.EndTime : null;
|
|
2548
|
+
this.MetricType = 'MetricType' in params ? params.MetricType : null;
|
|
2549
|
+
this.Target = 'Target' in params ? params.Target : null;
|
|
2550
|
+
this.Period = 'Period' in params ? params.Period : null;
|
|
2551
|
+
this.Offset = 'Offset' in params ? params.Offset : null;
|
|
2552
|
+
this.ShowAll = 'ShowAll' in params ? params.ShowAll : null;
|
|
2346
2553
|
|
|
2347
2554
|
}
|
|
2348
2555
|
}
|
|
@@ -3419,6 +3626,213 @@ class CreateTokenPlanApiKeysRequest extends AbstractModel {
|
|
|
3419
3626
|
}
|
|
3420
3627
|
}
|
|
3421
3628
|
|
|
3629
|
+
/**
|
|
3630
|
+
* 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.
|
|
3631
|
+
* @class
|
|
3632
|
+
*/
|
|
3633
|
+
class UsageStats extends AbstractModel {
|
|
3634
|
+
constructor(){
|
|
3635
|
+
super();
|
|
3636
|
+
|
|
3637
|
+
/**
|
|
3638
|
+
* <p>Total tokens accumulated within a time period.</p>
|
|
3639
|
+
* @type {number || null}
|
|
3640
|
+
*/
|
|
3641
|
+
this.TotalToken = null;
|
|
3642
|
+
|
|
3643
|
+
/**
|
|
3644
|
+
* <p>[tokens family] Total input tokens within a time period.</p>
|
|
3645
|
+
* @type {number || null}
|
|
3646
|
+
*/
|
|
3647
|
+
this.InputTotalToken = null;
|
|
3648
|
+
|
|
3649
|
+
/**
|
|
3650
|
+
* <p>[tokens family] Total output tokens within a time period.</p>
|
|
3651
|
+
* @type {number || null}
|
|
3652
|
+
*/
|
|
3653
|
+
this.OutputTotalToken = null;
|
|
3654
|
+
|
|
3655
|
+
/**
|
|
3656
|
+
* <p>[token family] Cumulative number of tokens read from the cache within a time period (cache hit part)</p>
|
|
3657
|
+
* @type {number || null}
|
|
3658
|
+
*/
|
|
3659
|
+
this.CacheTotalToken = null;
|
|
3660
|
+
|
|
3661
|
+
/**
|
|
3662
|
+
* <p>Total online search requests in the [search group]</p>
|
|
3663
|
+
* @type {number || null}
|
|
3664
|
+
*/
|
|
3665
|
+
this.SearchRequestCount = null;
|
|
3666
|
+
|
|
3667
|
+
/**
|
|
3668
|
+
* <p>[search family] Total search engine calls</p>
|
|
3669
|
+
* @type {number || null}
|
|
3670
|
+
*/
|
|
3671
|
+
this.SearchCount = null;
|
|
3672
|
+
|
|
3673
|
+
}
|
|
3674
|
+
|
|
3675
|
+
/**
|
|
3676
|
+
* @private
|
|
3677
|
+
*/
|
|
3678
|
+
deserialize(params) {
|
|
3679
|
+
if (!params) {
|
|
3680
|
+
return;
|
|
3681
|
+
}
|
|
3682
|
+
this.TotalToken = 'TotalToken' in params ? params.TotalToken : null;
|
|
3683
|
+
this.InputTotalToken = 'InputTotalToken' in params ? params.InputTotalToken : null;
|
|
3684
|
+
this.OutputTotalToken = 'OutputTotalToken' in params ? params.OutputTotalToken : null;
|
|
3685
|
+
this.CacheTotalToken = 'CacheTotalToken' in params ? params.CacheTotalToken : null;
|
|
3686
|
+
this.SearchRequestCount = 'SearchRequestCount' in params ? params.SearchRequestCount : null;
|
|
3687
|
+
this.SearchCount = 'SearchCount' in params ? params.SearchCount : null;
|
|
3688
|
+
|
|
3689
|
+
}
|
|
3690
|
+
}
|
|
3691
|
+
|
|
3692
|
+
/**
|
|
3693
|
+
* DescribeUsageRankList response structure.
|
|
3694
|
+
* @class
|
|
3695
|
+
*/
|
|
3696
|
+
class DescribeUsageRankListResponse extends AbstractModel {
|
|
3697
|
+
constructor(){
|
|
3698
|
+
super();
|
|
3699
|
+
|
|
3700
|
+
/**
|
|
3701
|
+
* <p>Statistical dimension of the backfill request.</p>
|
|
3702
|
+
* @type {string || null}
|
|
3703
|
+
*/
|
|
3704
|
+
this.Dimension = null;
|
|
3705
|
+
|
|
3706
|
+
/**
|
|
3707
|
+
* <p>Metrics family of the backfill request: tokens / search.</p>
|
|
3708
|
+
* @type {string || null}
|
|
3709
|
+
*/
|
|
3710
|
+
this.MetricType = null;
|
|
3711
|
+
|
|
3712
|
+
/**
|
|
3713
|
+
* <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>
|
|
3714
|
+
* @type {Array.<string> || null}
|
|
3715
|
+
*/
|
|
3716
|
+
this.MetricKeys = null;
|
|
3717
|
+
|
|
3718
|
+
/**
|
|
3719
|
+
* <p>View (data source)</p>
|
|
3720
|
+
* @type {string || null}
|
|
3721
|
+
*/
|
|
3722
|
+
this.ViewName = null;
|
|
3723
|
+
|
|
3724
|
+
/**
|
|
3725
|
+
* <p>Statistical granularity (in seconds) of the backfill request. It is 0 when ShowAll=true.</p>
|
|
3726
|
+
* @type {number || null}
|
|
3727
|
+
*/
|
|
3728
|
+
this.Period = null;
|
|
3729
|
+
|
|
3730
|
+
/**
|
|
3731
|
+
* <p>Backfill the start time of the request.</p>
|
|
3732
|
+
* @type {string || null}
|
|
3733
|
+
*/
|
|
3734
|
+
this.StartTime = null;
|
|
3735
|
+
|
|
3736
|
+
/**
|
|
3737
|
+
* <p>End time of the backfill request.</p>
|
|
3738
|
+
* @type {string || null}
|
|
3739
|
+
*/
|
|
3740
|
+
this.EndTime = null;
|
|
3741
|
+
|
|
3742
|
+
/**
|
|
3743
|
+
* <p>Total number of objects.</p>
|
|
3744
|
+
* @type {number || null}
|
|
3745
|
+
*/
|
|
3746
|
+
this.Total = null;
|
|
3747
|
+
|
|
3748
|
+
/**
|
|
3749
|
+
* <p>Backfill the pagination starting point of the request. It is 0 when ShowAll=true.</p>
|
|
3750
|
+
* @type {number || null}
|
|
3751
|
+
*/
|
|
3752
|
+
this.Offset = null;
|
|
3753
|
+
|
|
3754
|
+
/**
|
|
3755
|
+
* <p>Page size. It is always 10. When ShowAll=true, it is Total.</p>
|
|
3756
|
+
* @type {number || null}
|
|
3757
|
+
*/
|
|
3758
|
+
this.Limit = null;
|
|
3759
|
+
|
|
3760
|
+
/**
|
|
3761
|
+
* <p>Timestamp sequence corresponding to the Series array (Unix seconds). Empty array when ShowAll=true.</p>
|
|
3762
|
+
* @type {Array.<number> || null}
|
|
3763
|
+
*/
|
|
3764
|
+
this.Timestamps = null;
|
|
3765
|
+
|
|
3766
|
+
/**
|
|
3767
|
+
* <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>
|
|
3768
|
+
* @type {Array.<UsageRankItem> || null}
|
|
3769
|
+
*/
|
|
3770
|
+
this.TopList = null;
|
|
3771
|
+
|
|
3772
|
+
/**
|
|
3773
|
+
* <p>Pagination statistics result</p>
|
|
3774
|
+
* @type {UsageStats || null}
|
|
3775
|
+
*/
|
|
3776
|
+
this.PageStats = null;
|
|
3777
|
+
|
|
3778
|
+
/**
|
|
3779
|
+
* <p>Total statistics result</p>
|
|
3780
|
+
* @type {UsageStats || null}
|
|
3781
|
+
*/
|
|
3782
|
+
this.TotalStats = null;
|
|
3783
|
+
|
|
3784
|
+
/**
|
|
3785
|
+
* 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.
|
|
3786
|
+
* @type {string || null}
|
|
3787
|
+
*/
|
|
3788
|
+
this.RequestId = null;
|
|
3789
|
+
|
|
3790
|
+
}
|
|
3791
|
+
|
|
3792
|
+
/**
|
|
3793
|
+
* @private
|
|
3794
|
+
*/
|
|
3795
|
+
deserialize(params) {
|
|
3796
|
+
if (!params) {
|
|
3797
|
+
return;
|
|
3798
|
+
}
|
|
3799
|
+
this.Dimension = 'Dimension' in params ? params.Dimension : null;
|
|
3800
|
+
this.MetricType = 'MetricType' in params ? params.MetricType : null;
|
|
3801
|
+
this.MetricKeys = 'MetricKeys' in params ? params.MetricKeys : null;
|
|
3802
|
+
this.ViewName = 'ViewName' in params ? params.ViewName : null;
|
|
3803
|
+
this.Period = 'Period' in params ? params.Period : null;
|
|
3804
|
+
this.StartTime = 'StartTime' in params ? params.StartTime : null;
|
|
3805
|
+
this.EndTime = 'EndTime' in params ? params.EndTime : null;
|
|
3806
|
+
this.Total = 'Total' in params ? params.Total : null;
|
|
3807
|
+
this.Offset = 'Offset' in params ? params.Offset : null;
|
|
3808
|
+
this.Limit = 'Limit' in params ? params.Limit : null;
|
|
3809
|
+
this.Timestamps = 'Timestamps' in params ? params.Timestamps : null;
|
|
3810
|
+
|
|
3811
|
+
if (params.TopList) {
|
|
3812
|
+
this.TopList = new Array();
|
|
3813
|
+
for (let z in params.TopList) {
|
|
3814
|
+
let obj = new UsageRankItem();
|
|
3815
|
+
obj.deserialize(params.TopList[z]);
|
|
3816
|
+
this.TopList.push(obj);
|
|
3817
|
+
}
|
|
3818
|
+
}
|
|
3819
|
+
|
|
3820
|
+
if (params.PageStats) {
|
|
3821
|
+
let obj = new UsageStats();
|
|
3822
|
+
obj.deserialize(params.PageStats)
|
|
3823
|
+
this.PageStats = obj;
|
|
3824
|
+
}
|
|
3825
|
+
|
|
3826
|
+
if (params.TotalStats) {
|
|
3827
|
+
let obj = new UsageStats();
|
|
3828
|
+
obj.deserialize(params.TotalStats)
|
|
3829
|
+
this.TotalStats = obj;
|
|
3830
|
+
}
|
|
3831
|
+
this.RequestId = 'RequestId' in params ? params.RequestId : null;
|
|
3832
|
+
|
|
3833
|
+
}
|
|
3834
|
+
}
|
|
3835
|
+
|
|
3422
3836
|
/**
|
|
3423
3837
|
* DeleteTokenPlanApiKey request structure.
|
|
3424
3838
|
* @class
|
|
@@ -3758,10 +4172,12 @@ module.exports = {
|
|
|
3758
4172
|
DeleteGlossaryEntriesResponse: DeleteGlossaryEntriesResponse,
|
|
3759
4173
|
DescribeApiKeyListResponse: DescribeApiKeyListResponse,
|
|
3760
4174
|
RenewTokenPlanTeamOrderResponse: RenewTokenPlanTeamOrderResponse,
|
|
4175
|
+
UsageRankItem: UsageRankItem,
|
|
3761
4176
|
TokenPlanApiKeyInfo: TokenPlanApiKeyInfo,
|
|
3762
4177
|
ModifyApiKeyInfoResponse: ModifyApiKeyInfoResponse,
|
|
3763
4178
|
ModifyTokenPlanApiKeyResponse: ModifyTokenPlanApiKeyResponse,
|
|
3764
4179
|
DescribeApiKeyListRequest: DescribeApiKeyListRequest,
|
|
4180
|
+
UsageSeries: UsageSeries,
|
|
3765
4181
|
CreateGlossaryRequest: CreateGlossaryRequest,
|
|
3766
4182
|
DescribeGlossaryEntriesResponse: DescribeGlossaryEntriesResponse,
|
|
3767
4183
|
DeleteGlossaryRequest: DeleteGlossaryRequest,
|
|
@@ -3774,7 +4190,7 @@ module.exports = {
|
|
|
3774
4190
|
DeleteApiKeyResponse: DeleteApiKeyResponse,
|
|
3775
4191
|
ModifyGlossaryEntryInput: ModifyGlossaryEntryInput,
|
|
3776
4192
|
ModifyTokenPlanApiKeyRequest: ModifyTokenPlanApiKeyRequest,
|
|
3777
|
-
|
|
4193
|
+
ModifyApiKeyStatusRequest: ModifyApiKeyStatusRequest,
|
|
3778
4194
|
DescribeTokenPlanApiKeyUsageDetailResponse: DescribeTokenPlanApiKeyUsageDetailResponse,
|
|
3779
4195
|
RequestSort: RequestSort,
|
|
3780
4196
|
ModifyApiKeyInfoRequest: ModifyApiKeyInfoRequest,
|
|
@@ -3786,8 +4202,9 @@ module.exports = {
|
|
|
3786
4202
|
DescribeGlossariesRequest: DescribeGlossariesRequest,
|
|
3787
4203
|
DeleteTokenPlanApiKeyResponse: DeleteTokenPlanApiKeyResponse,
|
|
3788
4204
|
DescribeTokenPlanApiKeyUsageDetailRequest: DescribeTokenPlanApiKeyUsageDetailRequest,
|
|
4205
|
+
TokenSummaryBillingItem: TokenSummaryBillingItem,
|
|
3789
4206
|
UpgradeTokenPlanTeamOrderRequest: UpgradeTokenPlanTeamOrderRequest,
|
|
3790
|
-
|
|
4207
|
+
DescribeUsageRankListRequest: DescribeUsageRankListRequest,
|
|
3791
4208
|
QuotaInfo: QuotaInfo,
|
|
3792
4209
|
CreateGlossaryEntriesRequest: CreateGlossaryEntriesRequest,
|
|
3793
4210
|
ApiKeyDetail: ApiKeyDetail,
|
|
@@ -3805,6 +4222,8 @@ module.exports = {
|
|
|
3805
4222
|
ModifyGlossaryEntriesResponse: ModifyGlossaryEntriesResponse,
|
|
3806
4223
|
DescribeTokenPlanResponse: DescribeTokenPlanResponse,
|
|
3807
4224
|
CreateTokenPlanApiKeysRequest: CreateTokenPlanApiKeysRequest,
|
|
4225
|
+
UsageStats: UsageStats,
|
|
4226
|
+
DescribeUsageRankListResponse: DescribeUsageRankListResponse,
|
|
3808
4227
|
DeleteTokenPlanApiKeyRequest: DeleteTokenPlanApiKeyRequest,
|
|
3809
4228
|
DescribeApiKeyResponse: DescribeApiKeyResponse,
|
|
3810
4229
|
DescribeTokenPlanApiKeyListRequest: DescribeTokenPlanApiKeyListRequest,
|
|
@@ -35,10 +35,12 @@ const SubPackageBalance = models.SubPackageBalance;
|
|
|
35
35
|
const DeleteGlossaryEntriesResponse = models.DeleteGlossaryEntriesResponse;
|
|
36
36
|
const DescribeApiKeyListResponse = models.DescribeApiKeyListResponse;
|
|
37
37
|
const RenewTokenPlanTeamOrderResponse = models.RenewTokenPlanTeamOrderResponse;
|
|
38
|
+
const UsageRankItem = models.UsageRankItem;
|
|
38
39
|
const TokenPlanApiKeyInfo = models.TokenPlanApiKeyInfo;
|
|
39
40
|
const ModifyApiKeyInfoResponse = models.ModifyApiKeyInfoResponse;
|
|
40
41
|
const ModifyTokenPlanApiKeyResponse = models.ModifyTokenPlanApiKeyResponse;
|
|
41
42
|
const DescribeApiKeyListRequest = models.DescribeApiKeyListRequest;
|
|
43
|
+
const UsageSeries = models.UsageSeries;
|
|
42
44
|
const CreateGlossaryRequest = models.CreateGlossaryRequest;
|
|
43
45
|
const DescribeGlossaryEntriesResponse = models.DescribeGlossaryEntriesResponse;
|
|
44
46
|
const DeleteGlossaryRequest = models.DeleteGlossaryRequest;
|
|
@@ -51,7 +53,7 @@ const DescribeApiKeyRequest = models.DescribeApiKeyRequest;
|
|
|
51
53
|
const DeleteApiKeyResponse = models.DeleteApiKeyResponse;
|
|
52
54
|
const ModifyGlossaryEntryInput = models.ModifyGlossaryEntryInput;
|
|
53
55
|
const ModifyTokenPlanApiKeyRequest = models.ModifyTokenPlanApiKeyRequest;
|
|
54
|
-
const
|
|
56
|
+
const ModifyApiKeyStatusRequest = models.ModifyApiKeyStatusRequest;
|
|
55
57
|
const DescribeTokenPlanApiKeyUsageDetailResponse = models.DescribeTokenPlanApiKeyUsageDetailResponse;
|
|
56
58
|
const RequestSort = models.RequestSort;
|
|
57
59
|
const ModifyApiKeyInfoRequest = models.ModifyApiKeyInfoRequest;
|
|
@@ -63,8 +65,9 @@ const RenewTokenPlanTeamOrderRequest = models.RenewTokenPlanTeamOrderRequest;
|
|
|
63
65
|
const DescribeGlossariesRequest = models.DescribeGlossariesRequest;
|
|
64
66
|
const DeleteTokenPlanApiKeyResponse = models.DeleteTokenPlanApiKeyResponse;
|
|
65
67
|
const DescribeTokenPlanApiKeyUsageDetailRequest = models.DescribeTokenPlanApiKeyUsageDetailRequest;
|
|
68
|
+
const TokenSummaryBillingItem = models.TokenSummaryBillingItem;
|
|
66
69
|
const UpgradeTokenPlanTeamOrderRequest = models.UpgradeTokenPlanTeamOrderRequest;
|
|
67
|
-
const
|
|
70
|
+
const DescribeUsageRankListRequest = models.DescribeUsageRankListRequest;
|
|
68
71
|
const QuotaInfo = models.QuotaInfo;
|
|
69
72
|
const CreateGlossaryEntriesRequest = models.CreateGlossaryEntriesRequest;
|
|
70
73
|
const ApiKeyDetail = models.ApiKeyDetail;
|
|
@@ -82,6 +85,8 @@ const UpgradeTokenPlanTeamOrderResponse = models.UpgradeTokenPlanTeamOrderRespon
|
|
|
82
85
|
const ModifyGlossaryEntriesResponse = models.ModifyGlossaryEntriesResponse;
|
|
83
86
|
const DescribeTokenPlanResponse = models.DescribeTokenPlanResponse;
|
|
84
87
|
const CreateTokenPlanApiKeysRequest = models.CreateTokenPlanApiKeysRequest;
|
|
88
|
+
const UsageStats = models.UsageStats;
|
|
89
|
+
const DescribeUsageRankListResponse = models.DescribeUsageRankListResponse;
|
|
85
90
|
const DeleteTokenPlanApiKeyRequest = models.DeleteTokenPlanApiKeyRequest;
|
|
86
91
|
const DescribeApiKeyResponse = models.DescribeApiKeyResponse;
|
|
87
92
|
const DescribeTokenPlanApiKeyListRequest = models.DescribeTokenPlanApiKeyListRequest;
|
|
@@ -242,6 +247,29 @@ Query specified entries in a Termbase. Support pagination.
|
|
|
242
247
|
this.request("DescribeGlossaryEntries", req, resp, cb);
|
|
243
248
|
}
|
|
244
249
|
|
|
250
|
+
/**
|
|
251
|
+
* Query the usage ranking list.
|
|
252
|
+
|
|
253
|
+
Metric family (MetricType)
|
|
254
|
+
- `tokens` (default): Token usage statistics. Supports Dimension = apikey / endpoint / model.
|
|
255
|
+
Metrics returned: TotalToken (total) / InputTotalToken (input) / OutputTotalToken (output) / CacheTotalToken (read cache).
|
|
256
|
+
- `search`: [To be launched] Online search usage statistics. Supports Dimension = apikey / endpoint / model.
|
|
257
|
+
Returns metrics: SearchRequestCount (search request count)/SearchCount (search engine call count).
|
|
258
|
+
|
|
259
|
+
content
|
|
260
|
+
-The MetricType field is used to switch metric families. The response echoes back MetricType and MetricKeys.
|
|
261
|
+
-TotalStats: The aggregated value of all objects over the entire time window.
|
|
262
|
+
-PageStats: The aggregated value of objects on the current page.
|
|
263
|
+
- 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.
|
|
264
|
+
* @param {DescribeUsageRankListRequest} req
|
|
265
|
+
* @param {function(string, DescribeUsageRankListResponse):void} cb
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
DescribeUsageRankList(req, cb) {
|
|
269
|
+
let resp = new DescribeUsageRankListResponse();
|
|
270
|
+
this.request("DescribeUsageRankList", req, resp, cb);
|
|
271
|
+
}
|
|
272
|
+
|
|
245
273
|
/**
|
|
246
274
|
* Delete terminology entries in batches.
|
|
247
275
|
|