Domain name for API request: waf.intl.tencentcloudapi.com.
This API is used to query the keyword list.
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: DescribeLLMKeywordLibrary. |
| Version | Yes | String | Common Params. The value used for this API: 2018-01-25. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-singapore. |
| Type | Yes | String | Lexicon type filter. Valid values: custom: custom blacklist builtin: built-in lexicon all: all lexicons white: custom whitelist |
| Offset | No | Integer | Pagination offset Value range: [0, +∞) Default value: 0 |
| Limit | No | Integer | Number of entries returned per page Value range: [1, 1000] Default value: 10 |
| By | No | String | Sorting field Valid values: UpdateTime: sort by update time CreateTime: sort by creation time Name: sort by name Default value: UpdateTime |
| Order | No | String | Sorting order Valid values: ASC: ascending order DESC: descending order Default value: DESC |
| Parameter Name | Type | Description |
|---|---|---|
| LibList | Array of LLMKeywordLibrary | List of keyword libraries |
| Total | Integer | Total number of keyword libraries |
| 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. |
This example shows you how to query the list of custom keyword libraries in descending order by update time, with 10 entries per page.
POST / HTTP/1.1
Host: waf.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLLMKeywordLibrary
<Common request parameters>
{
"Type": "custom",
"Offset": 0,
"Limit": 10,
"By": "UpdateTime",
"Order": "DESC"
}
{
"Response": {
"RequestId": "feca6493-7c4a-4103-a868-cc394d72ae8e",
"LibList": [],
"Total": 0
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback