Domain name for API request: dayu.tencentcloudapi.com.
This API is used to get a layer-7 forwarding rule.
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 parameter. The value used for this API: DescribleL7Rules. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-09. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| Business | Yes | String | Anti-DDoS service type. bgpip: Anti-DDoS Advanced; net: Anti-DDoS Ultimate |
| Id | Yes | String | Anti-DDoS instance ID |
| RuleIdList.N | No | Array of String | Rule ID, which is optional. If this field is entered, the specified rule will be obtained |
| Limit | No | Integer | Number of entries per page. A value of 0 means no pagination |
| Offset | No | Integer | Page start offset, whose value is (page number - 1) * number of entries per page |
| Domain | No | String | Domain name search, which is optional. Enter it if you need to search for domain names |
| ProtocolList.N | No | Array of String | Forwarding protocol search, which is optional. Valid values: [http, https, http/https] |
| StatusList.N | No | Array of Integer | Status search, which is optional. Valid values: [0 (successfully configured rule), 1 (rule configuration taking effect), 2 (rule configuration failed), 3 (rule deletion taking effect), 5 (rule deletion failed), 6 (rule waiting for configuration), 7 (rule waiting for deletion), 8 (rule waiting for certificate configuration)] |
| Parameter Name | Type | Description |
|---|---|---|
| Rules | Array of L7RuleEntry | Forwarding rule list |
| Total | Integer | Total number of rules |
| Healths | Array of L7RuleHealth | Health check configuration list |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dayu.tencentcloudapi.com/?Action=DescribleL7Rules
&Business=bgpip
&Id=bgpip-000000xe
&RuleIdList.0=rule-00000002
&<Common request parameters>{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"Total": 1,
"Rules": [
{
"RuleId": "rule-00000002",
"RuleName": "test",
"Protocol": "http",
"VirtualPort": 80,
"SourcePort": 80,
"SourceType": 2,
"LbType": 1,
"KeepTime": 300,
"SourceList": [
{
"Source": "2.1.1.1",
"Weight": 50
},
{
"Source": "2.1.1.2",
"Weight": 50
}
]
}
]
},
"Healths": [
{
"RuleId": "rule-00000001",
"Enable": 1,
"Interval": 300,
"KickNum": 2,
"AliveNum": 2,
"Method": "HEAD",
"StatusCode": 15,
"Url": "/index.php",
"Status": 1
}
]
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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?