Domain name for API request: csip.intl.tencentcloudapi.com.
Query the DLP user rule list of the current tenant. Input Filter.Name=RuleID to query an individual rule for the details page scenario.
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 Params. The value used for this API: DescribeSandboxDLPRuleList. |
| 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: 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: The asset type to which it belongs. Available values: HOST (host) / CONTAINER (container) |
| MemberId.N | No | Array of String | Group account member id. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of TrafficSandboxDLPRuleInfo | List of rules |
| TotalCount | Integer | Total 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSandboxDLPRuleList
<Common request parameters>
{}{
"Response": {
"Data": [
{
"ID": 4001,
"RuleName": "Border exit sensitive data protection",
"Level": "HIGH",
"Status": "ON",
"BelongAssetType": "CONTAINER",
"SystemRuleContent": [
{
"RuleName": "Identity card number",
"RuleContent": "[1-9]\\d{5}(19|20)\\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01])\\d{3}[0-9Xx]"
}
],
"UserRuleContent": [
{
"RuleName": "Identity card number",
"RuleContent": "[1-9]\\d{5}(19|20)\\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01])\\d{3}[0-9Xx]"
}
],
"UserRuleInfo": {
"FileName": [
"*.pem",
"*.key"
],
"FileSize": {
"Min": 1024,
"Max": 1048576
},
"FileType": [
".pdf",
".zip"
],
"URLRule": {
"URL": [
"http://*.cos.*.myqcloud.com/*"
],
"URLExcept": []
},
"TrafficRule": [
{
"RuleName": "Identity card number",
"RuleContent": "[1-9]\\d{5}(19|20)\\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\\d|3[01])\\d{3}[0-9Xx]"
}
]
},
"EffectScope": {
"EffectType": "INCLUDE",
"EffectAssets": [
{
"InstanceId": "ins-a1b2c3d4",
"ContainerId": "docker-container-abc123"
}
]
},
"InactiveAssets": [
{
"InstanceId": "",
"ContainerId": "docker-container-abc123",
"TrafficPluginState": {
"InstallStatus": "INSTALL_FAIL",
"Status": "IPTABLE_FAILED",
"Message": "iptables rules delivery fail"
"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": 12,
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}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?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback