/** * Token Plan API Key 列表项 */ export interface TokenPlanApiKeyListItem { /** * API Key ID。 */ ApiKeyId?: string; /** * API Key 密钥值(脱敏)。 */ ApiKey?: string; /** * API Key 名称。 */ Name?: string; /** * 所属套餐 ID。 */ TeamId?: string; /** * 账号APP ID。 */ AppId?: string; /** * 主账号 UIN。最大 128 字符。 */ Uin?: string; /** * API Key 可用模型列表(JSON 数组字符串)。 */ AllowedModels?: string; /** * API Key 是否可用。取值:enable(启用)、disable(停用)。 */ Status?: string; /** * API Key 停用原因。取值:NORMAL(正常,默认值),QUOTA_EXHAUSTED(API Key额度包耗尽),ABNORMAL(异常,需人工介入) */ StopReason?: string; /** * 用户侧开关。取值:enable(启用)、disable(停用)。 */ UseStatus?: string; /** * 密钥版本号。 */ KeyVersion?: number; /** * 最近一次重置时间。(ISO 8601) */ LastRotatedAt?: string; /** * 创建人,如果是子账号创建,则该值为子账号UIN。 */ Creator?: string; /** * 创建时间。 */ CreatedAt?: string; /** * 更新时间。 */ UpdatedAt?: string; /** * API Key 额度用量信息 */ Balance?: SubPackageBalance; /** * 套餐类型。取值:enterprise(企业版专业套餐)、enterprise-auto(企业版轻享套餐)。 */ ProductType?: string; } /** * 绑定资源项 */ export interface BindingItem { /** *
资源 ID(模型 ID 或服务 ID)。
*/ ResourceId: string; /** *资源类型。取值:endpoint(推理服务)、model(模型)。推荐绑定endpoint,绑定model即将下线。已绑定model的apikey仍可使用,但控制台回显将不会展示模型绑定列表。
枚举值:
资源状态
*/ Status?: string; } /** * 批量创建成功项 */ export interface CreateApiKeysResultItem { /** * APIKey ID。 */ ApiKeyId?: string; } /** * DescribeTokenPlanApiKeyList返回参数结构体 */ export interface DescribeTokenPlanApiKeyListResponse { /** * API Key 列表。 */ ApiKeySet?: Array限额周期,必填。取值:d(按日)、m(按月)、lifetime(总额度)。
*/ CycleUnit: string; /** *单周期额度(Token 数),必填,不能大于10万亿。使用字符串避免大数精度丢失。同维度若与现网不同视为升配/降配。
*/ CycleCredits: string; /** *月度限额起始日。CycleUnit=m 时可选,1~31,默认 1。小月(如 2 月)由下游自动取该月最后一天。已有月度限额包时,更新月起始日视为周期窗口切换,会 delete 旧包后 add 新包,累计额度会重置
*/ MonthStartDay?: number; } /** * DeleteGlossary返回参数结构体 */ export interface DeleteGlossaryResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlossaryEntries返回参数结构体 */ export interface DeleteGlossaryEntriesResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RenewTokenPlanTeamOrder返回参数结构体 */ export interface RenewTokenPlanTeamOrderResponse { /** * 腾讯云订单 ID。用于关联一次续费操作下的所有子订单。 */ BigOrderId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模型图标信息 */ export interface ModelImage { /** * 图标 URL。 */ Url?: string; } /** * 用量时间周期内的时序点列表(按 metric key 索引)。为 JSON 数组的字符串形式,数组长度与响应 Timestamps 一致,无数据点处为 null。具体包含哪些 key 由响应 MetricKeys 决定。 */ export interface UsageSeries { /** *[tokens 族]总 token 数用量时间周期内的 JSON 字符串形式,如 "[12,null,15]"。
[tokens 族]输入 token 数用量时间周期内的 JSON 字符串形式,如 "[7,null,9]"。
[tokens 族]输出 token 数用量时间周期内的 JSON 字符串形式,如 "[5,null,6]"。
[tokens 族]读缓存 token 数用量时间周期内的 JSON 字符串形式,如"[5,null,6]"。
[search 族] 搜索请求数用量时间周期内的 JSON 字符串形式,如"[5,null,6]"。
[search 族] 搜索引擎调用次数用量时间周期内的 JSON 字符串形式,如"[5,null,6]"。
模型接入点列表。
*/ ModelEndpointSet?: Array符合条件的总数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGlossaryEntries请求参数结构体 */ export interface DeleteGlossaryEntriesRequest { /** * 术语库 ID。可通过 DescribeGlossaries 接口获取。 */ GlossaryId: string; /** * 待删除的术语条目列表。单次最多 200 个。 */ Entries: Array模型列表。
*/ ModelSet?: Array符合条件的模型总数。
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteEndpoint返回参数结构体 */ export interface DeleteEndpointResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTokenPlanTeamOrderAndBuy请求参数结构体 */ export interface CreateTokenPlanTeamOrderAndBuyRequest { /** *套餐类型。取值:enterprise(企业版专业套餐)、enterprise-auto(企业版轻享套餐)。
*/ ProductType: string; /** *套餐名称。只能包含中文、字母、数字、下划线、连字符,以中文或者字母开头,以中文或字母或数字结尾,2~50个字符
*/ TeamName: string; /** *购买时长。单位:月。必须大于 0,支持1个月~12个月。
*/ TimeSpan: number; /** *购买的套餐规格。套餐类型为专业套餐(enterprise),单位取值为积分;轻享套餐(enterprise-auto),单位取值为 tokens。
*/ CreditOrToken: number; /** *是否开启自动续费。默认不开启。
*/ EnableAutoRenew?: boolean; /** *已有套餐 ID(非空时走过期续费,空时走新购)
*/ TeamId?: string; } /** * CreateEndpoint请求参数结构体 */ export interface CreateEndpointRequest { /** *服务名称。最大 64 字符。
*/ EndpointName: string; /** *模型 ID。可通过 DescribeModelList 接口获取。
*/ ModelId: string; /** *计费方式。取值:FREE(免费体验)、TOKEN(按 Token 计费)、TPM(TPM 保障)、COMPUTE_UNIT(按算力单元计费)。
*/ ChargeType: string; /** *RPM(每分钟请求数)限流上限。可选。必须大于 0,且不能超过用户在该模型上的 RPM 上限。不传则使用默认值(60)。
*/ RPM?: number; /** *TPM(每分钟 Token 数)限流上限,单位为 tokens/min。可选。必须大于 0,且不能超过用户在该模型上的 TPM 上限。设置后会同时作用于输入 TPM 和输出 TPM。不传则使用默认值(0 表示不限流)。
*/ TPM?: number; /** *自动调整配额
*/ AutoAdjustQuota?: number; /** *自定义推理服务 id
*/ EndpointId?: string; } /** * DeleteTokenPlanApiKey返回参数结构体 */ export interface DeleteTokenPlanApiKeyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 创建推理服务返回的详情信息 */ export interface EndpointCreateDetail { /** * 预付费包 id */ PreResourceId?: string; } /** * 术语条目详情 */ export interface GlossaryEntryItem { /** * 术语条目 ID。 */ EntryId?: string; /** * 源语言术语。 */ SourceTerm?: string; /** * 目标语言术语。 */ TargetTerm?: string; /** * 更新时间。Unix 时间戳(毫秒)。 */ UpdatedAt?: number; } /** * Token 限额配置项(创建 API 密钥时用) */ export interface QuotaCreateItem { /** *限额周期。取值:d(按日)、m(按月)、lifetime(总额度,不重置)。
*/ CycleUnit: string; /** *维度当期限额总量(Token 数),不能大于10万亿。使用字符串避免大数精度丢失。
*/ CycleCredits: string; /** *月度限额起始日。CycleUnit 为 m 时可选,1~31,默认 1。小月(如 2 月)由下游自动取该月最后一天。
*/ MonthStartDay?: number; } /** * ModifyGlossaryEntries返回参数结构体 */ export interface ModifyGlossaryEntriesResponse { /** * 修改后的术语条目列表。 */ Entries?: Array推理服务 ID。
*/ EndpointId?: string; /** *服务名称。
*/ EndpointName?: string; /** *模型名称。
*/ ModelName?: string; /** *模型 ID。
*/ ModelId?: string; /** *状态。取值:ACTIVE(使用中)、INACTIVE(停止中)。
*/ Status?: string; /** *服务类型。取值:TEXT_GENERATION(文本生成)、IMAGE_GENERATION(图片生成)、VIDEO_GENERATION(视频生成)。
*/ ServiceType?: string; /** *计费方式。取值:FREE(免费体验)、TOKEN(按 Token 计费)
枚举值:
是否开启付费计费。true 表示已开启付费资源包,false 表示仅使用免费额度。
*/ PaymentEnabled?: boolean; /** *计费详情信息,JSON 格式字符串。不同 ChargeType 对应不同的 JSON 结构:
停止原因。当状态为 INACTIVE 时返回。取值:FREE_QUOTA_EXHAUSTED(免费额度已用尽)、NO_FREE_PACKAGE(无可用免费包)、INSUFFICIENT_BALANCE(余额不足,格式为 INSUFFICIENT_BALANCE:<待支付资源ID>)、BILLING_ISOLATED(账户欠费隔离)、INTERNAL_ERROR(内部错误)。当值为 INSUFFICIENT_BALANCE 时,冒号后附带待支付的 TPM 包资源 ID,前端可据此引导用户前往对应订单页完成支付。
*/ StopReason?: string; /** *TPM(每分钟 Token 限流)。当推理服务未单独设置时,回退为关联模型的默认 TPM 值。
*/ TPM?: number; /** *自动调整配额
*/ AutoAdjustQuota?: number; /** *RPM(每分钟请求数限流)。当推理服务未单独设置时,回退为关联模型的默认 RPM 值。
*/ RPM?: number; /** *模型状态
枚举值:
模型 ID 列表。最多支持 10 个,不支持重复。
*/ ModelIds?: Array模型名称列表。最多支持 10 个,不支持重复。
*/ ModelNames?: Array模型类型列表,筛选指定类型的模型。最多支持 10 个,不支持重复。取值:Text(文本)、Vision(视觉)、Multimodal(多模态)、Speech(语音)、Embedding(向量)。
*/ ModelTypes?: Array模型标签
*/ Tags?: Array返回数量,默认为 20,最大值为 100。
*/ Limit?: number; /** *偏移量,默认为 0。
*/ Offset?: number; } /** * DescribeTokenPlanApiKeySecret返回参数结构体 */ export interface DescribeTokenPlanApiKeySecretResponse { /** * APIKey ID。 */ ApiKeyId?: string; /** * APIKey 密钥值(明文)。请妥善保管。 */ ApiKey?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 新建术语条目项 */ export interface GlossaryEntryInput { /** * 源语言术语。最大 1000 字符。 */ SourceTerm: string; /** * 目标语言术语。最大 1000 字符。 */ TargetTerm: string; } /** * ModifyTokenPlanApiKeySecret返回参数结构体 */ export interface ModifyTokenPlanApiKeySecretResponse { /** * API Key ID。 */ ApiKeyId?: string; /** * 重置后的密钥版本号。 */ KeyVersion?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 删除术语条目项 */ export interface DeleteGlossaryEntryInput { /** * 术语条目 ID。可通过 DescribeGlossaryEntries 接口获取。 */ EntryId: string; } /** * Token 限额信息 */ export interface QuotaInfo { /** * 限额包 ID。 */ PkgId?: string; /** * 限额包状态。取值:1(正常)、3(已耗尽)、4(已销毁)。 */ Status?: number; /** * 限额周期。取值:d(按日)、m(按月)、lifetime(总额度,不重置)。 */ CycleUnit?: string; /** * 维度当期限额总量(Token 数)。使用字符串避免大数精度丢失。 */ CycleCredits?: string; /** * 维度当期已使用量(Token 数)。使用字符串避免大数精度丢失。 */ CycleUsed?: string; /** * 限额生效起始时间。 */ StartTime?: string; /** * 限额过期时间。 */ ExpireTime?: string; } /** * DescribeApiKeyList返回参数结构体 */ export interface DescribeApiKeyListResponse { /** * API 密钥列表。 */ ApiKeySet?: Array推理服务 ID。
*/ EndpointId?: string; /** *推理服务详情信息。
*/ Endpoint?: EndpointCreateDetail; /** *停止原因。当推理服务状态为已停止时返回。取值:FREE_QUOTA_EXHAUSTED(免费额度已用尽)、NO_FREE_PACKAGE(无可用免费包)、INSUFFICIENT_BALANCE(余额不足)、BILLING_ISOLATED(账户欠费隔离)、INTERNAL_ERROR(内部错误)。
*/ StopReason?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTokenPlanApiKeyList请求参数结构体 */ export interface DescribeTokenPlanApiKeyListRequest { /** * 套餐 ID。可通过DescribeTokenPlanList接口获取。 */ TeamId: string; /** * 分页查询偏移量,默认为 0。 */ Offset?: number; /** * 分页查询返回数量,默认为 20,最大值为 100。 */ Limit?: number; /** * 分页查询过滤条件列表。支持的过滤字段:ApiKeyId (API Key ID)、Name (API Key 名称)、Status (API Key是否可用)、StopReason (API Key停用原因)、UseStatus (API Key用户侧开关)。 */ Filters?: ArrayAPI 密钥 ID。
*/ ApiKeyId: string; /** *平台类型。取值:maas。
*/ Platform: string; } /** * UpgradeTokenPlanTeamOrder返回参数结构体 */ export interface UpgradeTokenPlanTeamOrderResponse { /** * 腾讯云订单 ID。用于关联一次升配操作下的所有子订单。 */ BigOrderId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 主额度包信息 */ export interface TokenPlanPackageInfo { /** * 总额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ TotalQuota?: string; /** * 总已使用额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ TotalUsed?: string; /** * 总周期数。 */ TotalCycles?: number; /** * 周期单位。取值:month(月) */ CycleUnit?: string; /** * 套餐包生效时间。 */ StartTime?: string; /** * 套餐包到期时间。 */ ExpireTime?: string; /** * 独占池已分配额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ ExclusiveAllocated?: string; /** * 独占池已用额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ ExclusiveUsed?: string; /** * 共享池总额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ SharedPool?: string; /** * 共享已用额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ SharedUsed?: string; /** * 当期额度。根据套餐类型区分单位:credits(企业版专业套餐),tokens(企业版auto套餐) */ CycleQuota?: string; /** * 当前周期。 */ CurrentCycle?: number; /** * 剩余周期。 */ RemainCycles?: number; } /** * 时间周期内的统计聚合值(按 metric key 索引)。声明 tokens / search 两族字段都在本 schema 中,按 MetricKeys 实际返回取值,参见响应顶层 `MetricKeys` 字段。 */ export interface UsageStats { /** *[tokens 族] 时间周期内的累计总 token 数。
*/ TotalToken?: number; /** *[tokens 族] 时间周期内的累计输入 token 数。
*/ InputTotalToken?: number; /** *[tokens 族] 时间周期内的累计输出 token 数。
*/ OutputTotalToken?: number; /** *[tokens 族] 时间周期内的累计读缓存 token 数(命中缓存部分)
*/ CacheTotalToken?: number; /** *[search 族] 整段累计联网搜索请求数
*/ SearchRequestCount?: number; /** *[search 族] 整段累计搜索引擎调用次数
*/ SearchCount?: number; } /** * DescribeUsageRankList返回参数结构体 */ export interface DescribeUsageRankListResponse { /** *回填请求的统计维度。
*/ Dimension?: string; /** *回填请求的指标族:tokens / search 。
*/ MetricType?: string; /** *本次响应中 Stats / Series / PageStats / TotalStats 实际包含的 metric key 列表,按MetricType 区分:tokens=[Total,Input,Output,Cache]、search=[SearchRequestCount,SearchCount]
*/ MetricKeys?: Array视图(数据来源)
*/ ViewName?: string; /** *回填请求的统计粒度(秒)。ShowAll=true 时为 0。
*/ Period?: number; /** *回填请求的起始时间。
*/ StartTime?: string; /** *回填请求的结束时间。
*/ EndTime?: string; /** *全量对象数。
*/ Total?: number; /** *回填请求的翻页起点。ShowAll=true 时为 0。
*/ Offset?: number; /** *页大小,恒为 10。ShowAll=true 时为 Total。
*/ Limit?: number; /** *Series 数组对应的时间戳序列(Unix 秒)。ShowAll=true 时为空数组。
*/ Timestamps?: Array对象排行列表,按MetricKeys[0]降序排序。ShowAll=false 时为当前页 10 个对象(含 Series);ShowAll=true 时为全量对象(不含 Series,用于 CSV 导出)。
分页统计结果
*/ PageStats?: UsageStats; /** *总统计结果
*/ TotalStats?: UsageStats; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeModelQuota返回参数结构体 */ export interface DescribeModelQuotaResponse { /** *模型 ID。
*/ ModelId?: string; /** *TPM 限制(Tokens Per Minute)。模型无配额配置时不返回此字段。
*/ TPMLimit?: number; /** *RPM 限制(Request Per Minute)。模型无配额配置时不返回此字段。
*/ RPMLimit?: number; /** *TPM 保障包 input 配额
*/ TPMInputQuotaLimit?: number; /** *TPM 保障包 output 配额
*/ TPMOutputQuotaLimit?: number; /** *TPM 预留 input 配额
*/ TPMInputReserveLimit?: number; /** *TPM 预留 output 配额
*/ TPMOutputReserveLimit?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTokenPlanApiKeySecret请求参数结构体 */ export interface DescribeTokenPlanApiKeySecretRequest { /** * API Key ID。可通过DescribeTokenPlanApiKeyList接口获取。 */ ApiKeyId: string; } /** * DescribeModelQuota请求参数结构体 */ export interface DescribeModelQuotaRequest { /** *模型 ID。可通过 DescribeModelList 获取。
*/ ModelId: string; } /** * 模型计费信息 */ export interface ModelChargingInfo { /** * 计费类型。取值:Uniform(统一计费)、Tiered(阶梯计费)。 */ Type?: string; /** * 计费名称,阶梯计费时表示区间标识,统一计费为空。 */ Name?: string; /** * 计费场景,用于区分同一产品不同功能的计费。 */ Scenario?: string; /** * 计费条目列表,顺序即前端展示顺序。 */ ChargingItems?: ArrayAPI 密钥 ID。
*/ ApiKeyId: string; /** *平台类型。取值:maas。
*/ Platform: string; /** *状态。取值:enable(启用)、disable(禁用)。
*/ Status: string; } /** * DescribeTokenPlan请求参数结构体 */ export interface DescribeTokenPlanRequest { /** * 套餐 ID。可通过 DescribeTokenPlanList 接口获取。 */ TeamId: string; } /** * 术语库详情 */ export interface GlossaryItem { /** * 术语库 ID。 */ GlossaryId?: string; /** * 术语库名称。 */ Name?: string; /** * 术语库描述。 */ Description?: string; /** * 源语言代码。 */ Source?: string; /** * 目标语言代码。 */ Target?: string; /** * 创建时间。 */ CreatedTime?: string; /** * 更新时间。 */ UpdatedTime?: string; } /** * 模型信息 */ export interface Model { /** *模型名称
*/ ModelName?: string; /** *模型 ID。
*/ ModelId?: string; /** *模型id别名列表
*/ ExtraModelIds?: Array模型显示名称。
*/ DisplayName?: string; /** *模型描述。
*/ Description?: string; /** *模型概要。
*/ Summary?: string; /** *模型类型。取值:Text(文本)、Vision(视觉)、Multimodal(多模态)、Speech(语音)、Embedding(向量)。
枚举值:
模型品牌。
*/ Brand?: string; /** *模型图标。
*/ ModelImage?: ModelImage; /** *模型供应商。
*/ Provider?: string; /** *模型状态。取值:online(上线)、offline(下线)。
枚举值:
标签列表。
*/ Tags?: Array计费信息列表。
*/ ModelChargingInfo?: Array模型规格。
*/ ModelSpec?: ModelSpec; /** *发布时间。
*/ ReleaseAt?: string; /** *推荐顺序,值越小排序越靠前。
*/ RecommendWeight?: number; /** *模型访问信息。包含模型在各站点和地域的可用性配置。为空时表示未配置地域信息,模型不可用。
*/ ModelAccessInfo?: ModelAccessInfo; /** *体验包信息。
*/ FreeTrialInfo?: ModelFreeTrialInfo; /** *模型下线时间,Status=pre-offline 时,会配置模型下线时间
*/ OfflineAt?: string; /** *停止新购时间
*/ DiscontinuedAt?: string; } /** * ModifyTokenPlanApiKey返回参数结构体 */ export interface ModifyTokenPlanApiKeyResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeApiKeyList请求参数结构体 */ export interface DescribeApiKeyListRequest { /** * 平台类型。当前支持填值:maas */ Platform?: string; /** * 返回数量,默认为 20,最大值为 100。 */ Limit?: number; /** * 偏移量,默认为 0。 */ Offset?: number; /** * 过滤条件列表。支持的过滤字段:apikeyId(API 密钥 ID)、apiKeyName(名称)、platform(平台类型)、status(状态)、bindType(绑定类型)。 */ Filters?: Array自动调整配额
*/ AutoAdjustQuota?: number; } /** * UpgradeTokenPlanTeamOrder请求参数结构体 */ export interface UpgradeTokenPlanTeamOrderRequest { /** * 套餐 ID。可通过 DescribeTokenPlanList 接口获取。 */ TeamId: string; /** * 升配后的新规格额度。套餐类型为 enterprise 时表示积分额度,套餐类型为 enterprise-auto 时表示 Token 数。必须大于当前额度。 */ NewCreditOrToken: number; } /** * 模型接入点概览信息 */ export interface ModelEndpointView { /** *推理服务 ID。网关默认创建的 id 与模型 id 相同;控制台自定义推理服务以 ep- 开头。
*/ EndpointId?: string; /** *推理服务名称。未激活时与 ModelId 相同。
*/ EndpointName?: string; /** *模型 ID。
*/ ModelId?: string; /** *模型id别名列表
*/ ExtraModelIds?: Array模型名称。
*/ ModelName?: string; /** *状态。取值:ACTIVE(运行中)、INACTIVE(已停止)。
*/ Status?: string; /** *模型状态
枚举值:
服务类型。固定为 TEXT_GENERATION(文本生成)。
*/ ServiceType?: string; /** *计费方式。取值:FREE(免费体验)、TOKEN(按 Token 计费)。未激活时为空。
*/ ChargeType?: string; /** *是否已开启后付费。true 表示已开启,false 表示未开启。未激活时为 false。
*/ PaymentEnabled?: boolean; /** *计费详情信息,JSON 格式字符串,包含免费额度用量等信息。未激活时为空。
*/ ChargeDetail?: string; /** *停止原因。当状态为 INACTIVE 时返回。取值:FREE_QUOTA_EXHAUSTED(免费额度已用尽)、NO_FREE_PACKAGE(无可用免费包)、INSUFFICIENT_BALANCE(余额不足)、BILLING_ISOLATED(账户欠费隔离)、INTERNAL_ERROR(内部错误)。
*/ StopReason?: string; /** *推理服务的 rpm 限制,没设置就按模型维度 rpm 限制展示
*/ RPM?: number; /** *推理服务的tpm 限制,没设置就按模型维度 tpm 限制展示
*/ TPM?: number; } /** * Token 汇总计费项 */ export interface TokenSummaryBillingItem { /** * 计费项。取值:input(输入 Token)、output(输出 Token)、cache(缓存 Token)、call_count(调用次数)。 */ BillingItem?: string; /** * 该计费项在周期内的原始用量汇总,单位:tokens。 */ TotalQty?: number; } /** * DescribeTokenPlanApiKeyUsageDetail返回参数结构体 */ export interface DescribeTokenPlanApiKeyUsageDetailResponse { /** * 翻页上下文,传入下一次请求的 Context 参数继续翻页。 */ Context?: string; /** * 是否已到末尾,为 true 时无需继续翻页。 */ ListOver?: boolean; /** * 调用明细列表。 */ List?: ArrayAPI 密钥 ID。
*/ ApiKeyId: string; /** *平台类型。取值:maas。
*/ Platform: string; /** *API 密钥名称。最大 128 字符。不传表示不修改。
*/ ApiKeyName?: string; /** *备注。
*/ Remark?: string; /** *IP 白名单列表。支持 IPv4(如 1.2.3.4)、CIDR(如 10.0.0.0/24)格式,IPv6暂不支持。最多 50 个,不支持重复。传入空数组表示清空白名单(不限制 IP)。不传表示不修改。
*/ IpWhitelist?: Array【修改限额推荐使用QuotaDesired参数】Token 限额期望状态。可选,不传表示不修改,传入空数组表示清空。和 Quotas(Token限额配置)字段互斥,不支持同时传入
*/ QuotasDesired?: Array套餐 ID。
*/ TeamId?: string; /** *套餐类型。取值:enterprise(企业版专业套餐)、enterprise-auto(企业版轻享套餐)
*/ ProductType?: string; /** *套餐名称。最大 128 字符。
*/ Name?: string; /** *账号 APP ID。
*/ AppId?: string; /** *主账号 UIN。
*/ Uin?: string; /** *套餐状态。取值:enable(启用)、disable(停用)。
*/ Status?: string; /** *套餐关停原因。取值:NORMAL(正常)、ISOLATED(隔离/欠费)、FROZEN(冻结)、EXHAUSTED(额度耗尽)、DESTROYED(已销毁)
*/ StopReason?: string; /** *可创建 API Key 上限。
*/ ApiKeyMax?: number; /** *当前已创建的 APIKey 数量
*/ ApiKeyCount?: number; /** *云计费预付费资源包 ID。
*/ PrepayResourceID?: string; /** *创建人。若为子账号创建的套餐,则该值为子账号UIN。
*/ Creator?: string; /** *创建时间。
*/ CreatedAt?: string; /** *更新时间。
*/ UpdatedAt?: string; /** *套餐包基本信息。
*/ PackageInfo?: TokenPlanPackageInfo; /** *是否开启自动续费。取值:0(未开启),1(开启)
*/ AutoRenewFlag?: number; } /** * DescribeApiKey请求参数结构体 */ export interface DescribeApiKeyRequest { /** * 平台类型。当前支持填值:maas */ Platform: string; /** * API 密钥 ID,与 ApiKey 至少需传入其一,优先使用 ApiKeyId。 */ ApiKeyId?: string; /** * API 密钥明文,与 ApiKeyId 至少需传入其一。 */ ApiKey?: string; } /** * DescribeUsageRankList请求参数结构体 */ export interface DescribeUsageRankListRequest { /** *统计维度。取值:apikey(按 APIKey 统计)、endpoint(按接入点统计)、model(按模型统计)。
*/ Dimension: string; /** *起始时间(闭区间),RFC3339 格式。
*/ StartTime: string; /** *结束时间(开区间),RFC3339 格式。与 StartTime 的跨度最大 90 天。
*/ EndTime: string; /** *指标族切换字段。
枚举值:
维度过滤值。空字符串表示查询全部对象,非空时仅查询指定单个对象(如指定 APIKey ID)。最大 256 字符。
*/ Target?: string; /** *统计粒度(秒)。取值:60、300、3600、86400。必须不小于跨度对应下限:跨度 ≤ 1 天 → 60;1 ~ 5 天 → 300;5 ~ 10 天 → 3600;> 10 天 → 86400。仅 ShowAll=false 时使用。
*/ Period?: number; /** *翻页起点,从 0 起,默认 0。ShowAll=true 时忽略。页大小固定为 10。
*/ Offset?: number; /** *是否返回全量结果。
apikey id
*/ ApiKeyId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 模型规格信息 */ export interface ModelSpec { /** * 每分钟处理 Token 数(Tokens Per Minute)。 */ TPM?: string; /** * 每分钟请求数(Queries Per Minute)。 */ QPM?: string; /** * 最大输入 Token 长度。 */ MaxInputToken?: string; /** * 最大输出 Token 长度。 */ MaxOutputToken?: string; /** * 上下文窗口长度。 */ ContextLength?: string; /** * 并发数。 */ Concurrency?: string; /** * 输入要求描述。 */ InputDescription?: string; } /** * DescribeEndpoint请求参数结构体 */ export interface DescribeEndpointRequest { /** *推理服务 ID。可通过 DescribeEndpointList 接口获取。
*/ EndpointId: string; } /** * 主包Token总结 */ export interface TokenSummary { /** * 套餐包当前计费周期序号 */ CycleSeq?: number; /** * 套餐包计费周期开始时间(RFC3339) */ CycleStartTime?: string; /** * 套餐包当前计费周期结束时间(RFC3339) */ CycleEndTime?: string; /** * 按计费项分组的 token 汇总列表 */ BillingItems?: Array推理服务详情。
*/ Endpoint?: EndpointDetail; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTokenPlanApiKeys请求参数结构体 */ export interface CreateTokenPlanApiKeysRequest { /** * 套餐 ID。可通过DescribeTokenPlanList接口获取。 */ TeamId: string; /** * API Key 名称,最大 128 字符。如果创建 API Key 的数量超过1个,实际名称格式为 {ApiKeyName}-{序号}(如 mykey-1, mykey-2)。 */ ApiKeyName: string; /** * 创建数量。取值范围:1 ~ 10。 */ Count: number; /** * 可用模型列表。如果套餐类型为企业版专业套餐,可以指定模型,也可以传入“all”,传入 “all“表示可以使用套餐支持的所有模型,如果要指定具体模型,传入 Model ID,“all“和具体的 Model ID 不能同时传入,如果不传则表示该API Key不支持任何模型,从而影响API Key的正常使用。如果套餐类型为企业版轻享套餐,则无论是否传入该字段,以及该字段传入什么值,都会被强制覆盖为["auto"]。 */ AllowedModels?: Array价格维度标识。取值:Input(输入)、Output(输出)、Cache(缓存命中)、Thinking(思考)、BatchInput(批量输入)、BatchOutput(批量输出)、BatchCache(批量缓存命中)、ImageInput(输入图片)、ImageOutput(输出图片)、Search(搜索调用)。
*/ PriceName?: string; /** *价格维度展示名,后端直接提供当前语言文本(如 输入、Input),前端无需翻译。
*/ DisplayName?: string; /** *价格数值。
*/ Price?: string; /** *价格单位,后端直接提供当前语言文本(如 元/百万tokens、元/张、积分/次)。
*/ PriceUnit?: string; /** *高峰价格,为空表示无高峰定价
*/ PeakPrice?: string; /** *规格描述,例如视觉/语音类模型有值(如 有参考视频 540P、图生视频 首帧 720P、动作控制 1080P、有声-未指定音色),其他模型为空。
*/ Specification?: string; /** *Token 用量描述,例如视觉/语音类模型有值(如 第1秒 62,500 Tokens,后续每秒 15,625 Tokens),其他模型为空。
*/ Usage?: string; /** *参考费用/预估费用描述,例如视觉/语音类模型有值(如 第1秒 0.625 元,后续每秒 0.15625 元),其他模型为空。
*/ ReferencePrice?: string; } /** * DescribeModelEndpointList请求参数结构体 */ export interface DescribeModelEndpointListRequest { /** *偏移量,从 0 开始,默认为 0。
*/ Offset?: number; /** *每页返回数量,默认为 20,最大值为 100。
*/ Limit?: number; /** *过滤条件列表。支持的过滤字段:Status(状态,取值 ACTIVE/INACTIVE)、ChargeType(计费方式,取值 FREE/TOKEN)、RequestSource(创建来源,取值 MC/GW)、ModelName(模型名称)、ModelId(模型 ID)、PaymentEnabled(是否已开启后付费,取值 true/false)。
*/ Filters?: Array排序条件列表。支持的排序字段:CreatedTime、UpdatedTime。不传时使用默认排序规则。
*/ Sorts?: Array腾讯云订单 ID。用于关联一次购买操作下的所有子订单。
*/ BigOrderId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 过滤条件 */ export interface RequestFilter { /** * 过滤字段名称。 */ Name: string; /** * 过滤操作符。取值:EXACT(精确匹配)、FUZZY(模糊匹配)、NOT(排除匹配)。 */ Op: string; /** * 过滤值列表。最多支持 10 个。 */ Values: ArrayAPI 密钥名称,创建后不可修改。
*/ ApiKeyName: string; /** *平台类型。取值:maas
*/ Platform: string; /** *绑定类型。取值:all(全部模型和接入点)、model_custom_endpoint_custom(自定义模型+自定义接入点)。
枚举值:
备注信息
*/ Remark?: string; /** *初始状态。取值:enable(启用)、disable(禁用)。不传默认 enable。
*/ Status?: string; /** *资源绑定列表(model 和 endpoint 混合),每项需显式指定 ResourceType。BindType 为 all 时不填;BindType 为model_custom_endpoint_custom时必填。
*/ Bindings?: ArrayIP 白名单列表。支持 IPv4(如 1.2.3.4)和 CIDR(如 10.0.0.0/24)格式,IPv6暂不支持。最多 50 个条目,不支持重复。不传或传空数组表示不限制 IP。
*/ IpWhitelist?: ArrayToken 限额配置多维度列表。可选,不传表示不开启限额。
*/ Quotas?: Array