tencent cloud

APIs

DescribeSandboxACLRuleList

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-01 10:05:10

1. API Description

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

This API is used to query the access control rule list for ACL users under the current tenant. Import Filter.Name=RuleID to query an individual rule precisely.

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: DescribeSandboxACLRuleList.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Offset No Integer

Offset. Default value: 0.

Limit No Integer

Number of items per page. Default value: 10. Upper limit: 200.

Filters.N No Array of Filters

Filter criteria
Supported filter items:
RuleID: rule ID, used for querying an individual rule
RuleName: search by rule name
Status: rule status, available values: ON (enable) / OFF (disable)
Level: rule level, available values: INFO (notification) / LOW (low risk) / MEDIUM (medium risk) / HIGH (high risk) / CRITICAL (critical)
RuleAction: rule action, available values: PASS (allowlist) / BLOCK (block and alarm) / MONITOR (alarm)
BelongAssetType: asset type, available values: HOST (host) / CONTAINER (container)

MemberId.N No Array of String

Group account member id.

3. Output Parameters

Parameter Name Type Description
Data Array of TrafficSandboxACLRuleInfo

Rule list

TotalCount Integer

Total quantity.

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 Example of Querying the ACL Rule List

Input Example

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

{
    "Filters": [
        {
            "Name": "Status",
            "Values": [
                "ON"
            ]
        }
    ],
    "MemberId": [
        "mem-tencent-7*************ef"
    ]
}

Output Example

{
    "Response": {
        "Data": [
            {
                "ID": 2001,
"RuleName": "Forbid outbound access to unknown domain names"
                "Level": "HIGH",
                "Status": "ON",
                "BelongAssetType": "HOST",
                "SystemRuleContent": [
                    {
                        "DstRule": {
                            "DstIP": [
                                "10.10.20.30",
                                "172.16.0.0/16"
                            ],
                            "DstIPExcept": [
                                "10.10.20.100"
                            ],
                            "DstPort": [
                                "443",
                                "8080-8090"
                            ],
                            "DstPortExcept": [
                                "22"
                            ]
                        },
                        "URLRule": {
                            "URL": [
                                "*.example.com",
                                "api.example.com/v1/*"
                            ],
                            "URLExcept": [
                                "test.example.com"
                            ],
                            "Protocol": [
                                "http",
                                "https"
                            ],
                            "Method": [
                                "GET",
                                "POST"
                            ]
                        }
                    }
                ],
                "UserRuleContent": [
                    {
                        "DstRule": {
                            "DstIP": [
                                "10.10.20.30",
                                "172.16.0.0/16"
                            ],
                            "DstIPExcept": [
                                "10.10.20.100"
                            ],
                            "DstPort": [
                                "443",
                                "8080-8090"
                            ],
                            "DstPortExcept": [
                                "22"
                            ]
                        },
                        "URLRule": {
                            "URL": [
                                "*.example.com",
                                "api.example.com/v1/*"
                            ],
                            "URLExcept": [
                                "test.example.com"
                            ],
                            "Protocol": [
                                "http",
                                "https"
                            ],
                            "Method": [
                                "GET",
                                "POST"
                            ]
                        }
                    }
                ],
                "EffectScope": {
                    "EffectType": "INCLUDE",
                    "EffectAssets": [
                        {
                            "InstanceId": "ins-a1b2c3d4",
                            "ContainerId": "docker-container-abc123"
                        }
                    ]
                },
                "InactiveAssets": [
                    {
                        "InstanceId": "ins-a1b2c3d4",
                        "ContainerId": "",
                        "TrafficPluginState": {
                            "InstallStatus": "INSTALL_FAIL",
                            "Status": "IPTABLE_FAILED",
"Message": "iptables rules delivery failed"
                            "ActivityTime": "2025-03-19T10:35:00+08:00"
                        }
                    }
                ],
                "InsertTime": "2025-01-01T10:00:00+08:00",
                "UpdateTime": "2025-03-15T14:30:00+08:00",
                "RuleAction": "BLOCK"
            }
        ],
        "TotalCount": 15,
        "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan