DescribeRulesSetting
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to return the list of the settings of the rule engine that can be used for request match and their detailed recommended configuration information.
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: DescribeRulesSetting. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Actions | Array of RulesSettingAction | List of the settings of the rule engine that can be used for request match and their detailed recommended configuration information. |
| 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 DescribeRulesSetting
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRulesSetting
<Common request parameters>
{}
Output Example
{
"Response": {
"RequestId": "811d2583-310c-41f4-b5e7-abe4074047d4",
"Actions": [
{
"Action": "ErrorPage",
"Properties": [
{
"ChoiceProperties": [],
"ChoicesValue": [],
"ExtraParameter": {
"Choices": [
"403",
"404",
"404",
"405",
"414",
"416",
"451",
"500",
"501",
"502",
"503",
"504"
],
"Id": "StatusCode",
"Type": "CHOICE"
},
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "RedirectUrl",
"Type": "CUSTOM_STRING"
}
]
},
{
"Action": "Cache",
"Properties": [
{
"ChoiceProperties": [
{
"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "Switch",
"Type": "TOGGLE"
}
],
"ChoicesValue": [],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "FollowOrigin",
"Type": "OBJECT"
},
{
"ChoiceProperties": [
{
"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "Switch",
"Type": "TOGGLE"
},
{
"ChoicesValue": [],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "CacheTime",
"Type": "CUSTOM_NUM"
}
],
"ChoicesValue": [],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "Cache",
"Type": "OBJECT"
},
{
"ChoiceProperties": [
{
"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "Switch",
"Type": "TOGGLE"
}
],
"ChoicesValue": [],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "NoCache",
"Type": "OBJECT"
}
]
},
{
"Action": "MaxAge",
"Properties": [
{
"ChoiceProperties": [],
"ChoicesValue": [],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "MaxAgeTime",
"Type": "CUSTOM_NUM"
},
{
"ChoiceProperties": [],
"ChoicesValue": [
"on",
"off"
],
"ExtraParameter": null,
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "FollowOrigin",
"Type": "TOGGLE"
}
]
},
{
"Action": "StatusCodeCache",
"Properties": [
{
"ChoiceProperties": [],
"ChoicesValue": [],
"ExtraParameter": {
"Choices": [
"403",
"404",
"404",
"405",
"414",
"416",
"451",
"500",
"501",
"502",
"503",
"504"
],
"Id": "StatusCode",
"Type": "CHOICE"
},
"IsAllowEmpty": false,
"IsMultiple": false,
"Max": 0,
"Min": 0,
"Name": "CacheTime",
"Type": "CUSTOM_NUM"
}
]
}
]
}
}
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
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.