tencentcloud-sdk-nodejs 4.1.239 → 4.1.241

package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.d.ts

@@ -0,0 +1,106 @@
+import { AbstractClient } from "../../../common/abstract_client";
+import { ClientConfig } from "../../../common/interface";
+import { DescribeTokenPlanApiKeySecretResponse, ModifyTokenPlanApiKeySecretResponse, DescribeTokenPlanApiKeyListResponse, DescribeUsageRankListRequest, DescribeTokenPlanRequest, DescribeTokenPlanApiKeyResponse, ModifyTokenPlanApiKeySecretRequest, DescribeApiKeyListResponse, RenewTokenPlanTeamOrderResponse, ModifyTokenPlanApiKeyResponse, DescribeApiKeyListRequest, UpgradeTokenPlanTeamOrderRequest, DescribeTokenPlanListResponse, CreateTokenPlanApiKeysResponse, DescribeTokenPlanApiKeyRequest, DescribeApiKeyRequest, DescribeTokenPlanApiKeyUsageDetailResponse, DescribeTokenPlanApiKeyListRequest, CreateTokenPlanTeamOrderAndBuyRequest, ModifyTokenPlanApiKeyRequest, RenewTokenPlanTeamOrderRequest, DeleteTokenPlanApiKeyResponse, DescribeTokenPlanApiKeyUsageDetailRequest, CreateTokenPlanTeamOrderAndBuyResponse, DescribeTokenPlanListRequest, UpgradeTokenPlanTeamOrderResponse, DescribeTokenPlanResponse, CreateTokenPlanApiKeysRequest, DescribeUsageRankListResponse, DeleteTokenPlanApiKeyRequest, DescribeApiKeyResponse, DescribeTokenPlanApiKeySecretRequest } from "./tokenhub_models";
+/**
+ * tokenhub client
+ * @class
+ */
+export declare class Client extends AbstractClient {
+    constructor(clientConfig: ClientConfig);
+    /**
+     * 查询 API 密钥列表。
+
+查询当前用户的 API 密钥列表，密钥值脱敏展示。支持分页、过滤和排序。
+     */
+    DescribeApiKeyList(req: DescribeApiKeyListRequest, cb?: (error: string, rep: DescribeApiKeyListResponse) => void): Promise<DescribeApiKeyListResponse>;
+    /**
+     * 重置 TokenPlan APIKey 密钥。
+
+重新生成密钥值，密钥版本号递增，旧密钥立即失效。APIKey ID 不变。重置后需通过 DescribeTokenPlanApiKeySecret 查询新密钥。
+     */
+    ModifyTokenPlanApiKeySecret(req: ModifyTokenPlanApiKeySecretRequest, cb?: (error: string, rep: ModifyTokenPlanApiKeySecretResponse) => void): Promise<ModifyTokenPlanApiKeySecretResponse>;
+    /**
+     * 批量创建 TokenPlan APIKey。
+
+传入名称前缀和数量，自动按 {ApiKeyName}-{序号} 格式生成名称（如 aaa-1, aaa-2）。允许同名。支持部分成功，最多 100 条。
+     */
+    CreateTokenPlanApiKeys(req: CreateTokenPlanApiKeysRequest, cb?: (error: string, rep: CreateTokenPlanApiKeysResponse) => void): Promise<CreateTokenPlanApiKeysResponse>;
+    /**
+     * 查询 TokenPlan APIKey 列表。
+
+返回指定套餐下的 APIKey 列表，密钥已脱敏。主账号可查看全部，子账号仅可查看自己创建的。
+     */
+    DescribeTokenPlanApiKeyList(req: DescribeTokenPlanApiKeyListRequest, cb?: (error: string, rep: DescribeTokenPlanApiKeyListResponse) => void): Promise<DescribeTokenPlanApiKeyListResponse>;
+    /**
+     * 查询 TokenPlan 套餐详情。
+
+返回套餐基本信息及额度中心主额度包余量。
+     */
+    DescribeTokenPlan(req: DescribeTokenPlanRequest, cb?: (error: string, rep: DescribeTokenPlanResponse) => void): Promise<DescribeTokenPlanResponse>;
+    /**
+     * 续费套餐。
+
+对已有的 TokenPlan 套餐发起续费下单并完成支付，成功后返回大订单 ID 及关联的子订单、资源信息。
+     */
+    RenewTokenPlanTeamOrder(req: RenewTokenPlanTeamOrderRequest, cb?: (error: string, rep: RenewTokenPlanTeamOrderResponse) => void): Promise<RenewTokenPlanTeamOrderResponse>;
+    /**
+     * 购买套餐。
+
+发起 TokenPlan 套餐下单并完成支付，成功后返回大订单 ID 及关联的子订单、资源信息。
+     */
+    CreateTokenPlanTeamOrderAndBuy(req: CreateTokenPlanTeamOrderAndBuyRequest, cb?: (error: string, rep: CreateTokenPlanTeamOrderAndBuyResponse) => void): Promise<CreateTokenPlanTeamOrderAndBuyResponse>;
+    /**
+     * 查询 TokenPlan APIKey 调用明细。
+
+从 CLS 日志服务查询套餐下的调用明细，按 pkg_id 过滤，支持游标分页。
+     */
+    DescribeTokenPlanApiKeyUsageDetail(req?: DescribeTokenPlanApiKeyUsageDetailRequest, cb?: (error: string, rep: DescribeTokenPlanApiKeyUsageDetailResponse) => void): Promise<DescribeTokenPlanApiKeyUsageDetailResponse>;
+    /**
+     * 查询 TokenPlan 套餐列表。
+
+支持分页、过滤和排序。主账号可查看全部，子账号仅可查看自己创建的。返回结果包含每个套餐关联的额度中心主额度包详情。
+     */
+    DescribeTokenPlanList(req: DescribeTokenPlanListRequest, cb?: (error: string, rep: DescribeTokenPlanListResponse) => void): Promise<DescribeTokenPlanListResponse>;
+    /**
+     * 根据 API 密钥 ID 或密钥值查询 API 密钥详情，返回明文密钥。ApiKeyId 和 ApiKey 至少需传入其一，优先使用 ApiKeyId。
+     */
+    DescribeApiKey(req: DescribeApiKeyRequest, cb?: (error: string, rep: DescribeApiKeyResponse) => void): Promise<DescribeApiKeyResponse>;
+    /**
+     * 升配套餐。
+
+对已有的 TokenPlan 套餐发起升配下单并完成支付，扩容积分或 Token 额度，成功后返回大订单 ID 及关联的子订单、资源信息。新额度必须大于当前额度。
+     */
+    UpgradeTokenPlanTeamOrder(req: UpgradeTokenPlanTeamOrderRequest, cb?: (error: string, rep: UpgradeTokenPlanTeamOrderResponse) => void): Promise<UpgradeTokenPlanTeamOrderResponse>;
+    /**
+     * 删除 TokenPlan APIKey。
+
+同时删除额度中心子额度包并通知网关清除缓存。
+     */
+    DeleteTokenPlanApiKey(req: DeleteTokenPlanApiKeyRequest, cb?: (error: string, rep: DeleteTokenPlanApiKeyResponse) => void): Promise<DeleteTokenPlanApiKeyResponse>;
+    /**
+     * 查询用量排行列表。
+
+按 apikey、endpoint、model 三个维度统计指定时间窗内的用量排行，返回顶部数据卡所需的 PageStats/TotalStats、左侧 Top 列表（含每对象整段累计值）、右侧色块趋势图所需的逐点曲线。前端通过 Offset 翻页、ShowAll 切换 CSV 全量导出模式。
+
+MetricType 字段用于切换指标族，本期支持 tokens；接口预留以支持后续指标族扩展。响应回显 MetricType 与 MetricKeys（实际参与渲染的 metric key 列表，顺序固定 [Total, Input, Output]），前端按此渲染顶部数据卡与趋势图，无需硬编码 key 名。
+     */
+    DescribeUsageRankList(req: DescribeUsageRankListRequest, cb?: (error: string, rep: DescribeUsageRankListResponse) => void): Promise<DescribeUsageRankListResponse>;
+    /**
+     * 修改 TokenPlan APIKey 配置（网关关注字段）。
+
+修改后自动通知网关更新缓存并同步额度中心。
+     */
+    ModifyTokenPlanApiKey(req: ModifyTokenPlanApiKeyRequest, cb?: (error: string, rep: ModifyTokenPlanApiKeyResponse) => void): Promise<ModifyTokenPlanApiKeyResponse>;
+    /**
+     * 查询 TokenPlan APIKey 详情。
+
+返回 APIKey 完整信息（含明文密钥）及子额度包余量。
+     */
+    DescribeTokenPlanApiKey(req: DescribeTokenPlanApiKeyRequest, cb?: (error: string, rep: DescribeTokenPlanApiKeyResponse) => void): Promise<DescribeTokenPlanApiKeyResponse>;
+    /**
+     * 查询 TokenPlan APIKey 密钥（明文）。
+
+返回指定 APIKey 的明文密钥值，请妥善保管。
+     */
+    DescribeTokenPlanApiKeySecret(req: DescribeTokenPlanApiKeySecretRequest, cb?: (error: string, rep: DescribeTokenPlanApiKeySecretResponse) => void): Promise<DescribeTokenPlanApiKeySecretResponse>;
+}

package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2018 Tencent. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+const abstract_client_1 = require("../../../common/abstract_client");
+/**
+ * tokenhub client
+ * @class
+ */
+class Client extends abstract_client_1.AbstractClient {
+    constructor(clientConfig) {
+        super("tokenhub.tencentcloudapi.com", "2026-03-22", clientConfig);
+    }
+    /**
+     * 查询 API 密钥列表。
+
+查询当前用户的 API 密钥列表，密钥值脱敏展示。支持分页、过滤和排序。
+     */
+    async DescribeApiKeyList(req, cb) {
+        return this.request("DescribeApiKeyList", req, cb);
+    }
+    /**
+     * 重置 TokenPlan APIKey 密钥。
+
+重新生成密钥值，密钥版本号递增，旧密钥立即失效。APIKey ID 不变。重置后需通过 DescribeTokenPlanApiKeySecret 查询新密钥。
+     */
+    async ModifyTokenPlanApiKeySecret(req, cb) {
+        return this.request("ModifyTokenPlanApiKeySecret", req, cb);
+    }
+    /**
+     * 批量创建 TokenPlan APIKey。
+
+传入名称前缀和数量，自动按 {ApiKeyName}-{序号} 格式生成名称（如 aaa-1, aaa-2）。允许同名。支持部分成功，最多 100 条。
+     */
+    async CreateTokenPlanApiKeys(req, cb) {
+        return this.request("CreateTokenPlanApiKeys", req, cb);
+    }
+    /**
+     * 查询 TokenPlan APIKey 列表。
+
+返回指定套餐下的 APIKey 列表，密钥已脱敏。主账号可查看全部，子账号仅可查看自己创建的。
+     */
+    async DescribeTokenPlanApiKeyList(req, cb) {
+        return this.request("DescribeTokenPlanApiKeyList", req, cb);
+    }
+    /**
+     * 查询 TokenPlan 套餐详情。
+
+返回套餐基本信息及额度中心主额度包余量。
+     */
+    async DescribeTokenPlan(req, cb) {
+        return this.request("DescribeTokenPlan", req, cb);
+    }
+    /**
+     * 续费套餐。
+
+对已有的 TokenPlan 套餐发起续费下单并完成支付，成功后返回大订单 ID 及关联的子订单、资源信息。
+     */
+    async RenewTokenPlanTeamOrder(req, cb) {
+        return this.request("RenewTokenPlanTeamOrder", req, cb);
+    }
+    /**
+     * 购买套餐。
+
+发起 TokenPlan 套餐下单并完成支付，成功后返回大订单 ID 及关联的子订单、资源信息。
+     */
+    async CreateTokenPlanTeamOrderAndBuy(req, cb) {
+        return this.request("CreateTokenPlanTeamOrderAndBuy", req, cb);
+    }
+    /**
+     * 查询 TokenPlan APIKey 调用明细。
+
+从 CLS 日志服务查询套餐下的调用明细，按 pkg_id 过滤，支持游标分页。
+     */
+    async DescribeTokenPlanApiKeyUsageDetail(req, cb) {
+        return this.request("DescribeTokenPlanApiKeyUsageDetail", req, cb);
+    }
+    /**
+     * 查询 TokenPlan 套餐列表。
+
+支持分页、过滤和排序。主账号可查看全部，子账号仅可查看自己创建的。返回结果包含每个套餐关联的额度中心主额度包详情。
+     */
+    async DescribeTokenPlanList(req, cb) {
+        return this.request("DescribeTokenPlanList", req, cb);
+    }
+    /**
+     * 根据 API 密钥 ID 或密钥值查询 API 密钥详情，返回明文密钥。ApiKeyId 和 ApiKey 至少需传入其一，优先使用 ApiKeyId。
+     */
+    async DescribeApiKey(req, cb) {
+        return this.request("DescribeApiKey", req, cb);
+    }
+    /**
+     * 升配套餐。
+
+对已有的 TokenPlan 套餐发起升配下单并完成支付，扩容积分或 Token 额度，成功后返回大订单 ID 及关联的子订单、资源信息。新额度必须大于当前额度。
+     */
+    async UpgradeTokenPlanTeamOrder(req, cb) {
+        return this.request("UpgradeTokenPlanTeamOrder", req, cb);
+    }
+    /**
+     * 删除 TokenPlan APIKey。
+
+同时删除额度中心子额度包并通知网关清除缓存。
+     */
+    async DeleteTokenPlanApiKey(req, cb) {
+        return this.request("DeleteTokenPlanApiKey", req, cb);
+    }
+    /**
+     * 查询用量排行列表。
+
+按 apikey、endpoint、model 三个维度统计指定时间窗内的用量排行，返回顶部数据卡所需的 PageStats/TotalStats、左侧 Top 列表（含每对象整段累计值）、右侧色块趋势图所需的逐点曲线。前端通过 Offset 翻页、ShowAll 切换 CSV 全量导出模式。
+
+MetricType 字段用于切换指标族，本期支持 tokens；接口预留以支持后续指标族扩展。响应回显 MetricType 与 MetricKeys（实际参与渲染的 metric key 列表，顺序固定 [Total, Input, Output]），前端按此渲染顶部数据卡与趋势图，无需硬编码 key 名。
+     */
+    async DescribeUsageRankList(req, cb) {
+        return this.request("DescribeUsageRankList", req, cb);
+    }
+    /**
+     * 修改 TokenPlan APIKey 配置（网关关注字段）。
+
+修改后自动通知网关更新缓存并同步额度中心。
+     */
+    async ModifyTokenPlanApiKey(req, cb) {
+        return this.request("ModifyTokenPlanApiKey", req, cb);
+    }
+    /**
+     * 查询 TokenPlan APIKey 详情。
+
+返回 APIKey 完整信息（含明文密钥）及子额度包余量。
+     */
+    async DescribeTokenPlanApiKey(req, cb) {
+        return this.request("DescribeTokenPlanApiKey", req, cb);
+    }
+    /**
+     * 查询 TokenPlan APIKey 密钥（明文）。
+
+返回指定 APIKey 的明文密钥值，请妥善保管。
+     */
+    async DescribeTokenPlanApiKeySecret(req, cb) {
+        return this.request("DescribeTokenPlanApiKeySecret", req, cb);
+    }
+}
+exports.Client = Client;