tencent cloud

All product documents
APIs
DocumentationAPIsTencent Cloud FirewallAccess Control APIsDescribeVpcAcRule
DescribeVpcAcRule
Last updated: 2025-02-18 16:49:35
DescribeVpcAcRule
Last updated: 2025-02-18 16:49:35

1. API Description

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

Query Inter-VPC rules

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: DescribeVpcAcRule.
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.
Limit Yes Integer Limit
Offset Yes Integer Offset
Index No String Index to be queried, used in specific scenarios, can be left blank
Filters.N No Array of CommonFilter Filter combinations
StartTime No String Search start time
EndTime No String Search end time
Order No String Order Type:desc,asc
By No String Order By FileName

3. Output Parameters

Parameter Name Type Description
Total Integer Total Data
Data Array of VpcRuleItem Data 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 Query Inter-VPC rules

Query Inter-VPC rules and filter IpVersion=0

Input Example

{
  "Filters": [
    {
      "Name": "IpVersion",
      "Values": [
        "0"
      ],
      "OperatorType": 1
    }
  ],
"Limit": 10,
"Offset": 0
}

Output Example

{
    "Response": {
        "Total": 1,
        "Data": [
            {
                "Uuid": 221579,
                "InternalUuid": 1729666998976364,
                "OrderIndex": 1,
                "SourceContent": "mb_1256532032_1666263807415",
                "SourceType": "template",
                "DestContent": "192.168.1.2",
                "DestType": "net",
                "Port": "-1/-1",
                "Protocol": "TCP",
                "RuleAction": "accept",
                "Description": "Internet grouping rule",
                "Enable": "true",
                "Deleted": 0,
                "EdgeId": "ALL",
                "EdgeName": "edge Name",
                "DetectedTimes": 0,
                "FwGroupId": "ALL",
                "FwGroupName": "Internet grouping",
                "BetaList": [
                    {
                        "TaskId": "9001",
                        "TaskName": "autotest",
                        "LastTime": "1999-01-01 00:00:01"
                    }
                ],
                "ParamTemplateId": "pp-ie03er",
                "ParamTemplateName": "Custom port parameter template",
                "TargetName": "Template Rule",
                "SourceName": "Template Rule",
                "IpVersion": 0
            }
        ],
        "RequestId": "9afc19d7-0036-4f3d-af1a-80088236f4ed"
    }
}

Example2 Query Inter-VPC rules Filter IP

Query Inter-VPC rules and filter SrcIp=192.168.1.10

Input Example

{
  "Filters": [
  {
    "Name": "SrcIP",
    "Values": [
      "192.168.1.10"
    ],
    "OperatorType": 9
  },
  {
    "Name": "IpVersion",
    "Values": [
      "0"
    ],
    "OperatorType": 1
  }
],
"Limit": 10,
"Offset": 0
}

Output Example

{
    "Response": {
        "Total": 1,
        "Data": [
            {
                "Uuid": 221579,
                "InternalUuid": 1729666998976364,
                "OrderIndex": 1,
                "SourceContent": "mb_1256532032_1666263807415",
                "SourceType": "template",
                "DestContent": "192.168.1.2",
                "DestType": "net",
                "Port": "-1/-1",
                "Protocol": "TCP",
                "RuleAction": "accept",
                "Description": "Internet grouping rule",
                "Enable": "true",
                "Deleted": 0,
                "EdgeId": "ALL",
                "EdgeName": "edge Name",
                "DetectedTimes": 0,
                "FwGroupId": "ALL",
                "FwGroupName": "Internet grouping",
                "BetaList": [
                    {
                        "TaskId": "9001",
                        "TaskName": "autotest",
                        "LastTime": "1999-01-01 00:00:01"
                    }
                ],
                "ParamTemplateId": "pp-ie03er",
                "ParamTemplateName": "Custom port parameter template",
                "TargetName": "Template Rule",
                "SourceName": "Template Rule",
                "IpVersion": 0
            }
        ],
        "RequestId": "9afc19d7-0036-4f3d-af1a-80088236f4ed"
    }
}

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
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
LimitExceeded The quota limit has been reached.
UnauthorizedOperation Unauthorized operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support