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. |
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 |
Delete terminology entry
Used by actions: DeleteGlossaryEntries.
| Name | Type | Required | Description |
|---|---|---|---|
| EntryId | String | Yes | Terminology entry ID. Obtain through the API DescribeGlossaryEntries. |
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. |
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). |
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. |
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. |
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. |
Filter criteria
Used by actions: DescribeApiKeyList, DescribeGlossaries.
| 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. |
Sort criteria
Used by actions: DescribeApiKeyList, DescribeGlossaries.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Sorting field name. |
| Order | String | Yes | Sorting order. Value: ASC (ascending), DESC (descending). |
文档反馈