- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- API Documentation
- FAQs
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- API Documentation
- FAQs
- Glossary
DescribeTagKeys
Last updated: 2024-03-20 15:31:11
1. API Description
Domain name for API request: tag.tencentcloudapi.com.
This API is used to query tag keys in the list of created tags.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: DescribeTagKeys. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-13. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| CreateUin | No | Integer | Creator Uin. If not specified, Uin is only used as the query condition. |
| Offset | No | Integer | Data offset. The default value is 0. Must be an integral multiple of the Limit parameter. |
| Limit | No | Integer | Number of entries per page. Default: 15; maximum: 1,000. |
| ShowProject | No | Integer | Whether to show project |
| Category | No | String | Tag type. Valid values: Custom: custom tag; System: system tag; All: all tags. Default value: All. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of results. |
| Offset | Integer | Data offset. |
| Limit | Integer | Page size. |
| Tags | Array of String | Tag list. |
| 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. |
4. Example
Example1 Queries the tag key
Input Example
https://tag.tencentcloudapi.com/?Action=DescribeTagKeys
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 9,
"Offset": 0,
"Limit": 15,
"Tags": [
"test2",
"test1",
"0",
"String",
"test",
"abcbbbb",
"abcaaaaa",
"abc",
"Test"
],
"RequestId": "cec4f865-bc87-4858-994e-80771644094d"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | The operation failed. |
| InvalidParameterValue.UinInvalid | Uin parameter is invalid. |
Yes
No
Was this page helpful?