tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeEnterpriseSecurityGroupRule

Last updated: 2023-05-04 17:40:16

1. API Description

Domain name for API request: cfw.tencentcloudapi.com.

This API is used to get enterprise security group rules (new).

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: DescribeEnterpriseSecurityGroupRule.
Version Yes String Common Params. The value used for this API: 2019-09-04.
Region No String Common Params. This parameter is not required for this API.
PageNo Yes String Page number of the current page displayed for query by page number.

1 by default.
PageSize Yes String Maximum number of entries per page displayed for query by page number.

Maximum value: 50.
SourceContent No String Source example:
net: IP/CIDR (192.168.0.2)
template: parameter template (ipm-dyodhpby)
instance: asset instance (ins-123456)
resourcegroup: asset group (/all groups/group 1/subgroup 1)
tag: resource tag ({"Key":"tag key","Value":"tag value"})
region: region (ap-gaungzhou)
Wildcards are supported.
DestContent No String Destination example:
net: IP/CIDR (192.168.0.2)
template: parameter template (ipm-dyodhpby)
instance: asset instance (ins-123456)
resourcegroup: asset group (/all groups/group 1/subgroup 1)
tag: resource tag ({"Key":"tag key","Value":"tag value"})
region: region (ap-gaungzhou)
Wildcards are supported.
Description No String Rule description. Wildcards are supported.
RuleAction No String The action that Cloud Firewall performs on the traffic. Valid values:
accept: allow
drop: deny
Enable No String Indicates whether to enable the rules. Default: enable. Valid values:
true: enable; false: disable
Port No String The port to apply access control rules. Valid values:
-1/-1: all ports
80: port 80
Protocol No String Protocol. TCP/UDP/ICMP/ANY
ServiceTemplateId No String Parameter template ID of port and protocol type; mutually exclusive with Protocol and Port

3. Output Parameters

Parameter Name Type Description
PageNo String Page number of the current page displayed for query by page number.
PageSize String Maximum number of entries per page displayed for query by page number.
Rules Array of SecurityGroupRule Access control rule list
TotalCount String Total number of access control rules
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying enterprise security group rules (new)

This example shows you how to query enterprise security group rules.

Input Example

POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnterpriseSecurityGroupRule
<Common request parameters>

{
    "Enable": "xx",
    "Protocol": "xx",
    "Description": "xx",
    "PageNo": "xx",
    "SourceContent": "xx",
    "ServiceTemplateId": "xx",
    "PageSize": "xx",
    "DestContent": "xx",
    "RuleAction": "xx",
    "Port": "xx"
}

Output Example

{
    "Response": {
        "Rules": [
            {
                "Id": "xxx-xxx",
                "OrderIndex": "xx",
                "Protocol": "xx",
                "SourceType": "xx",
                "SourceContent": "xx",
                "DestType": "xx",
                "ServiceTemplateId": "xx",
                "DestContent": "xx",
                "RuleAction": "xx",
                "Port": "xx",
                "Enable": "true",
                "Description": "xx"
            }
        ],
        "TotalCount": "xx",
        "PageSize": "xx",
        "PageNo": "xx",
        "RequestId": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
AuthFailure CAM signature/authentication error.
DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit has been reached.
MissingParameter Missing parameter.
OperationDenied Operation denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is occupied.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy