Domain name for API request: lighthouse.intl.tencentcloudapi.com.
This API is used to query the firewall rules of an instance.
A maximum of 10 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: DescribeFirewallRules. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible firewall rules. |
| FirewallRuleSet | Array of FirewallRuleInfo | Firewall rule details list. |
| FirewallVersion | Integer | Firewall version number. |
| 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. |
https://lighthouse.intl.tencentcloudapi.com/?Action=DescribeFirewallRules
&InstanceId=lhins-aglzynfg
&<Common request parameters>
{
"Response": {
"FirewallRuleSet": [
{
"Action": "DROP",
"AppType": "Custom",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "",
"Port": "22,88",
"Protocol": "TCP"
},
{
"Action": "ACCEPT",
"AppType": "Custom",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "test",
"Port": "88",
"Protocol": "TCP"
},
{
"Action": "ACCEPT",
"AppType": "HTTP(80)",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "test",
"Port": "80",
"Protocol": "TCP"
},
{
"Action": "ACCEPT",
"AppType": "HTTPS(443)",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "Allow web service HTTPS (443), such as Apache and Nginx",
"Port": "443",
"Protocol": "TCP"
}
],
"FirewallVersion": 1,
"RequestId": "afa0c876-336a-4ed6-ad01-89b3b2632207",
"TotalCount": 4
}
}
https://lighthouse.intl.tencentcloudapi.com/?Action=DescribeFirewallRules
&InstanceId=lhins-aglzynfg
&Offset=0
&Limit=1
&<Common request parameters>
{
"Response": {
"FirewallRuleSet": [
{
"Action": "DROP",
"AppType": "Custom",
"CidrBlock": "0.0.0.0/0",
"FirewallRuleDescription": "",
"Port": "22,88",
"Protocol": "TCP"
}
],
"FirewallVersion": 1,
"RequestId": "31522fb9-fef8-4190-9080-deba504c36ae",
"TotalCount": 4
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Operation failed. |
| InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
| InvalidParameterValue.Negative | Invalid parametric value: it cannot be negative. |
| InvalidParameterValue.OutOfRange | Invalid parametric value: it is not within the valid range. |
| ResourceNotFound.FirewallNotFound | The firewall does not exist. |
| ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
| UnauthorizedOperation.NoPermission | No permission. |
| UnauthorizedOperation.TokenInvalid | You do not have permission to perform this operation. The token in the request is invalid. |
文档反馈