Domain name for API request: tokenhub.intl.tencentcloudapi.com.
Query API key list.
Query the API key list of the current user with key values in masking display. Support pagination, filtering, and sorting.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeApiKeyList. |
| Version | Yes | String | Common Params. The value used for this API: 2026-03-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Platform | No | String | Platform type. Currently supported values: maas. |
| Limit | No | Integer | Number of returned results, defaults to 20, maximum value 100. |
| Offset | No | Integer | Offset. Default value: 0. |
| Filters.N | No | Array of RequestFilter | Filter condition list. Supported filter fields: apikeyId (API Key ID), apiKeyName (name), platform (platform type), status (status), bindType (binding type). |
| Sorts.N | No | Array of RequestSort | Sorting condition list. Supported sorting field: apiKeyName |
| Parameter Name | Type | Description |
|---|---|---|
| ApiKeySet | Array of ApiKeyDetail | API Key List. |
| TotalCount | Integer | Total number of eligible API keys. |
| RequestId | String | 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. |
Check current user API key list with secret key value masking display. Support paginate, filter and sort.
POST / HTTP/1.1
Host: tokenhub.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiKeyList
<Common request parameters>
{
"Platform": "maas",
"Filters": [
{
"Name": "apiKeyName",
"Op": "EXACT",
"Values": [
"my-apikey"
]
}
]
}
{
"Response": {
"ApiKeySet": [
{
"ApiKey": "sk-2b***3sQc",
"ApiKeyId": "ak-20260325-xxxxxx",
"AppId": "1300056794",
"BindType": "model_custom_endpoint_custom",
"BindingItems": [
{
"ResourceId": "deepseek-v3.2",
"ResourceType": "model"
}
],
"CreateTime": "2026-03-25 19:50:56",
"Creator": "",
"Editable": true,
"Name": "my-apikey",
"Platform": "maas",
"Remark": "for test use",
"Status": "enable",
"SubUin": "1234556",
"Uin": "1234556",
"UpdateTime": "2026-03-25 19:50:56"
}
],
"RequestId": "3ec32d91-3e21-40bf-8874-516fa9197d5b",
"TotalCount": 1
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.InternalError | InternalError.InternalError |
| InvalidParameter.InvalidParameter | InvalidParameter.InvalidParameter |
| InvalidParameterValue.InvalidParameterValue | InvalidParameterValue.InvalidParameterValue |
| UnauthorizedOperation.UnauthorizedOperation | UnauthorizedOperation.UnauthorizedOperation |
フィードバック