DescribeFunctionRules
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query the list of trigger rules for an edge function. It supports filtering by rule ID, function ID, rule description, and so on.
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: DescribeFunctionRules. |
Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
Region | No | String | Common Params. This parameter is not required. |
ZoneId | Yes | String | Zone ID. |
Filters.N | No | Array of Filter | Filter criteria list. There is an AND relationship between different criteria. The maximum number of Filters.Values is 20. The detailed filter criteria are as follows: |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
FunctionRules | Array of FunctionRule | Rule details 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 Querying the List of Trigger Rules for an Edge Function
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFunctionRules
<Common request parameters>
{
"ZoneId": "zone-293e7s5jne1i"
}
Output Example
{
"Response": {
"RequestId": "d7213f7f-a67b-4602-b630-ed6740e1a124",
"FunctionRules": [
{
"RuleId": "rule-53qpdadi",
"FunctionRuleConditions": [
{
"RuleConditions": [
{
"Operator": "equal",
"Target": "url",
"Values": [
"/test3"
],
"IgnoreCase": false,
"Name": ""
}
]
}
],
"FunctionId": "ef-n1j14wfm",
"FunctionName": "test",
"Priority": 2,
"Remark": "my function rule",
"CreateTime": "2023-04-19T07:32:09Z",
"UpdateTime": "2023-04-19T07:36:43Z"
}
]
}
}
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 |
---|---|
InternalError.SystemError | Internal system error. |
InvalidParameter.InvalidFilterName | Invalid filter field. |
InvalidParameter.TooManyFilterValues | Too many filter values. |
InvalidParameter.TooManyFilters | Too many filter items. |
ResourceUnavailable.ZoneNotFound | The site does not exist or is not belong to this account. |