tencent cloud

APIs

DocumentationAPIsLLM Service TokenHubData Types

Data Types

Download
Focus Mode
Font Size
Last updated: 2026-08-26 20:54:59

ApiKeyDetail

Details of the specified API key

Used by actions: DescribeApiKeyList.

Name Type Description
ApiKeyId String API Key ID.
Name String Name
ApiKey String API key value. The API response contains the masking value.
Remark String Remarks.
Platform String Platform type. Currently supported values: maas.
Uin String Root account.
SubUin String Sub-account.
Status String Status. Valid values: enable, disable.
BindType String Binding type. Value: all (all models and services), model_all_endpoint_custom (all models + custom service), model_custom_endpoint_all (custom model + all services), model_custom_endpoint_custom (custom model + custom service).
CreateTime String Creation time. Format: YYYY-MM-DD HH:mm:ss.
UpdateTime String Last update time. Format: YYYY-MM-DD HH:mm:ss.
AppId String App ID.
Editable Boolean Whether it is editable. true means editable, false means non-editable.
BindingItems Array of BindingItem List of bound resources, case-sensitive for endpoint and model kind.
IpWhitelist Array of String IP allowlist. Supports IPv4 and CIDR format. Empty array indicates no restriction.
Creator String This field is empty when Platform is maas.
QuotaSet Array of QuotaInfo Multi-dimensional list of Token quota information. This field is not returned when unconfigured.
QuotaStatus String Token quota status. An empty string means no configuration. active means configured with current availability. inactive means configured but quota exhausted.

BatchCreateFailedItem

Batch create failed items

Used by actions: CreateTokenPlanApiKeys.

Name Type Description
Index Integer Serial number of the failed item (starting from 1, corresponding to the suffix number).
Name String Name of the failed item.
Reason String Failure reason.

BindingItem

Bind Resource

Used by actions: DescribeApiKey, DescribeApiKeyList.

Name Type Required Description
ResourceId String Yes Resource ID (model ID or service ID).
ResourceType String Yes Resource type. Value: endpoint (service), model (model).
Status String No Resource status

CreateApiKeysResultItem

Batch create succeeded items

Used by actions: CreateTokenPlanApiKeys.

Name Type Description
ApiKeyId String APIKey ID.

DeleteGlossaryEntryInput

Delete terminology entry

Used by actions: DeleteGlossaryEntries.

Name Type Required Description
EntryId String Yes Terminology entry ID. Obtain through the API DescribeGlossaryEntries.

GlossaryEntryInput

Create terminology entry

Used by actions: CreateGlossaryEntries.

Name Type Required Description
SourceTerm String Yes Source language terminology. Maximum 1000 characters.
TargetTerm String Yes Target language terminology. Maximum 1000 characters.

GlossaryEntryItem

Terminology entry detail

Used by actions: CreateGlossaryEntries, DescribeGlossaryEntries, ModifyGlossaryEntries.

Name Type Description
EntryId String Terminology entry ID.
SourceTerm String Source language terminology.
TargetTerm String Target language terminology.
UpdatedAt Integer Last update time. Unix timestamp (ms).

GlossaryItem

Termbase detail

Used by actions: DescribeGlossaries.

Name Type Description
GlossaryId String Termbase ID.
Name String Terminology repository name.
Description String Repository description.
Source String Source language code.
Target String Target language code.
CreatedTime Timestamp ISO8601 Creation time.
UpdatedTime Timestamp ISO8601 Update time.

ModifyGlossaryEntryInput

Modify terminology entry

Used by actions: ModifyGlossaryEntries.

Name Type Required Description
EntryId String Yes Terminology entry ID. Obtain through the API DescribeGlossaryEntries.
SourceTerm String No Source language terminology. Maximum 1000 characters. If not passed, remain unchanged.
TargetTerm String No Target language terminology. Maximum 1000 characters. Remain unchanged if not passed.

QuotaInfo

Token quota information

Used by actions: DescribeApiKey, DescribeApiKeyList.

Name Type Description
PkgId String Quota package ID.
Status Integer Package status. Value: 1 (normal), 3 (exhausted), 4 (terminated).
CycleUnit String Quota period. Value: d (by day), m (monthly), lifetime (total quota, no reset).
CycleCredits String Dimensional quota total amount (number of tokens). Use string to avoid precision loss.
CycleUsed String Dimensional used amount (number of tokens). Use string literal to avoid precision loss.
StartTime Timestamp ISO8601 Quota effective start time.
ExpireTime Timestamp ISO8601 Quota expiration time.

RequestFilter

Filter criteria

Used by actions: DescribeApiKeyList, DescribeGlossaries, DescribeTokenPlanApiKeyList, DescribeTokenPlanList.

Name Type Required Description
Name String Yes Filter field name.
Op String Yes Filter operator. Values: EXACT (exact match), FUZZY (fuzzy matching), NOT (exclusion).
Values Array of String Yes Filter value list. Supports up to 10.

RequestSort

Sort criteria

Used by actions: DescribeApiKeyList, DescribeGlossaries, DescribeTokenPlanApiKeyList, DescribeTokenPlanList.

Name Type Required Description
Name String Yes Sorting field name.
Order String Yes Sorting order. Value: ASC (ascending), DESC (descending).

SubPackageBalance

API Key limit and usage information

Used by actions: DescribeTokenPlanApiKey, DescribeTokenPlanApiKeyList.

Name Type Description
ExclusiveQuota String Dedicated limit. Units are as follows:
-Package type: professional. Measurement unit: point.
- Package type is lite package, and the measurement unit is token.
ExclusiveUsed String Used amount of the dedicated limit. The measurement units are as follows:
-Package type: professional. Measurement unit: point.
- Package type is lite package, and the measurement unit is token.
ExclusiveRemain String Remaining exclusive quota. Units are as follows:
-Package type: professional. Measurement unit: point.
-Package type: lite package. Measurement unit: token.
SharedQuota String Shared credit limit. -1 means unlimited. Measurement units are as follows:
-Package type is professional package, measurement unit value is point;
-Package type: lite package. Measurement unit: token.
SharedUsed String Used amount of the shared quota. Measurement units are as follows:
-Package type is professional package, measurement unit value is point;
-Package type: lite package. Measurement unit: token.
SharedRemain String Remaining shared quota. Units are described as follows:
-Package type is professional package, measurement unit value is point;
-Package type: lite package. Measurement unit: token.
Status Integer API Key package status. Valid values: 0 (normal), 1 (exhausted).

TokenPlanApiKeyInfo

Token Plan API Key details

Used by actions: DescribeTokenPlanApiKey.

Name Type Description
ApiKeyId String API Key ID.
ApiKey String API Key secret key value (masked).
Name String API Key name.
TeamId String Bundle ID.
AppId String Account APP ID.
Uin String Main account UIN.
AllowedModels String API Key available model list (JSON array string).
Status String Whether the API Key is available. Values: enable (enable), disable (disable).
StopReason String Reason for disabling the API Key. Valid values: NORMAL (normal, default value), QUOTA_EXHAUSTED (API Key quota package exhausted), ABNORMAL (exception, human intervention required)
UseStatus String User-side switch. Valid values: enable, disable.
KeyVersion Integer Key version.
LastRotatedAt Timestamp ISO8601 Last reset time (ISO 8601).
Creator String Creator. If it is created by a sub-account, this value is the sub-account UIN.
CreatedAt Timestamp ISO8601 Creation time.
UpdatedAt Timestamp ISO8601 Update time.
TPM Integer TPM limit (Tokens Per Minute).
ProductType String Package type. Values: enterprise (Enterprise Professional package), enterprise-auto (Enterprise Light package)

TokenPlanApiKeyListItem

Token Plan API Key list item

Used by actions: DescribeTokenPlanApiKeyList.

Name Type Description
ApiKeyId String API Key ID.
ApiKey String API Key secret key value (masking).
Name String API Key name.
TeamId String Bundle ID
AppId String Account APP ID.
Uin String Main account UIN. Maximum 128 characters.
AllowedModels String API Key available model list (JSON array string).
Status String Whether the API Key is available. Values: enable (enable), disable (disable).
StopReason String Reason for disabling the API Key. Value: NORMAL (normal, default value), QUOTA_EXHAUSTED (API Key quota package exhausted), ABNORMAL (abnormal, requires human intervention)
UseStatus String User-side switch. Valid values: enable, disable.
KeyVersion Integer Key version.
LastRotatedAt Timestamp ISO8601 Last reset time (ISO 8601).
Creator String Creator. If it is created by a sub-account, this value is the sub-account UIN.
CreatedAt Timestamp ISO8601 Creation time.
UpdatedAt Timestamp ISO8601 Update time.
Balance SubPackageBalance API Key limit usage information
ProductType String Package type. Values: enterprise (Enterprise Professional package), enterprise-auto (Enterprise Light package).

TokenPlanListItem

Token Plan package option

Used by actions: DescribeTokenPlanList.

Name Type Description
TeamId String

Package ID.
ProductType String

Package type. Values: enterprise (Enterprise Professional package), enterprise-auto (Enterprise Light package)
Name String

Package name. Maximum 128 characters.
AppId String

Account APP ID.
Uin String

Main account UIN.
Status String

Package status. Valid values: enable, disable.
StopReason String

Reason for package disablement. Value: NORMAL, ISOLATED, FROZEN, EXHAUSTED, DESTROYED
ApiKeyMax Integer

Maximum number of API Keys that can be created.
ApiKeyCount Integer

Number of API Keys currently created
PrepayResourceID String

Cloud billing prepaid resource package ID.
Creator String

Creator. If the package is created by a sub-account, this value is the sub-account UIN.
CreatedAt Timestamp ISO8601

Creation time.
UpdatedAt Timestamp ISO8601

Update time.
PackageInfo TokenPlanPackageInfo

Basic information of the package.
AutoRenewFlag Integer

Whether to enable auto-renewal. Value: 0 (not enabled), 1 (enabled)

TokenPlanPackageInfo

Main limit package info

Used by actions: DescribeTokenPlan, DescribeTokenPlanList.

Name Type Description
TotalQuota String Total quota. The unit is determined by the package type: credits for the Enterprise Professional package and tokens for the Enterprise auto package.
TotalUsed String Total used quota. The unit varies by package type: credits (enterprise edition professional package), tokens (enterprise edition auto package)
TotalCycles Integer Total number of periods.
CycleUnit String Period unit. Value: month
StartTime Timestamp ISO8601 Package effective time.
ExpireTime Timestamp ISO8601 Package expiration time.
ExclusiveAllocated String Allocated quota for dedicated pool. The unit varies by package type: credits (enterprise edition professional package), tokens (enterprise edition auto package)
ExclusiveUsed String Used credit of the dedicated pool. The unit varies based on the package type: credits for the enterprise professional package, and tokens for the enterprise auto package.
SharedPool String Total shared pool quota. The measurement unit varies based on the package type: credits (enterprise edition professional package), tokens (enterprise edition auto package).
SharedUsed String Shared used credit. The unit varies by package type: credits (enterprise edition professional package), tokens (enterprise edition auto package)
CycleQuota String Current period limit. The unit varies by package type: credits (Enterprise Edition Professional), tokens (Enterprise Edition auto).
CurrentCycle Integer Current cycle.
RemainCycles Integer Remaining cycle.

TokenSummary

Main package Token summary

Used by actions: DescribeTokenPlan.

Name Type Description
CycleSeq Integer Package serial number of the current billing cycle
CycleStartTime String Package billing cycle start time (RFC3339)
CycleEndTime String Package billing cycle end time (RFC3339)
BillingItems Array of TokenSummaryBillingItem Summary list of tokens grouped by billing item

TokenSummaryBillingItem

Billing item for Token aggregation

Used by actions: DescribeTokenPlan.

Name Type Description
BillingItem String Billing item. Values: input (input Token), output (output Token), cache (cache Token), call_count (call count).
TotalQty Integer Aggregated raw usage of this billing item during a period. Unit: tokens.

UsageRankItem

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).

Used by actions: DescribeUsageRankList.

Name Type Description
Rank Integer 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.
Key String Object identifier. The apikey dimension is the APIKey ID; the endpoint dimension is the access point; the model dimension is the model name.
Name String 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.
Stats UsageStats Statistical value within a time period
Series UsageSeries List of time series points within a time period

UsageSeries

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.

Used by actions: DescribeUsageRankList.

Name Type Description
TotalToken String

Amount of total tokens used within a time period in JSON string form, for example, "[12,null,15]".
InputTotalToken String

Amount of input tokens used within a time period in JSON string form, for example, "[7,null,9]".
OutputTotalToken String

Amount of output tokens used within a time period in JSON string form, for example, "[5,null,6]".
CacheTotalToken String

Read cache token count usage of the tokens family in JSON string form within a time period, for example, "[5,null,6]".
SearchRequestCount String

Usage of search requests in JSON string form within a time period, for example, "[5,null,6]".
SearchCount String

Usage of search engine call count in JSON string form within a time period, for example, "[5,null,6]".

UsageStats

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.

Used by actions: DescribeUsageRankList.

Name Type Description
TotalToken Integer

Total tokens accumulated within a time period.
InputTotalToken Integer

[tokens family] Total input tokens within a time period.
OutputTotalToken Integer

[tokens family] Total output tokens within a time period.
CacheTotalToken Integer

[token family] Cumulative number of tokens read from the cache within a time period (cache hit part)
SearchRequestCount Integer

Total online search requests in the [search group]
SearchCount Integer

[search family] Total search engine calls
Previous Topic: DescribeUsageRankListNext Topic: Error Codes

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback