tencent cloud

APIs

DescribeDspmIdentifyRuleDetail

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:10:24

1. API Description

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

Queries the dspm data identification data item details

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

Data item id

MemberId.N No Array of String

Group account member id

OperationSource No String

Operation source: empty/dspm=database risk monitoring entry, cos=object storage risk monitoring entry

3. Output Parameters

Parameter Name Type Description
Id Integer

Data item id

Name String

Data item name

Description String

Data item description.

Status Integer

Whether to enable the data item

Enumeration values:

  • 0: No
  • 1: Yes

Default value: 0

Type Integer

Data item type

Enumeration values:

  • 0: Built-in
  • 1: Custom
StructuredRule String

Structured rule

UnStructuredRule String

Unstructured rule

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 the identification data item details of dspm data

Input Example

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

{
    "Id": 10000,
    "MemberId": [
        "mem-12e1w112"
    ]
}

Output Example

{
    "Response": {
        "Description": "1",
        "Id": 10000,
"Name": "kyrie test",
        "Status": 1,
"StructuredRule": "{\n  \"NodeType\": \"operator\",\n  \"OptType\": \"or\",\n  \"RuleInfos\": [],\n  \"Nodes\": [\n    {\n      \"NodeType\": \"operator\",\n      \"OptType\": \"or\",\n      \"RuleInfos\": [\n        {\n          \"DataSourceType\": \"field_comment\",\n          \"RuleMethod\": \"match\",\n          \"RuleType\": \"regex\",\n          \"RuleContent\": \"(Country| Country Code)$\",\n          \"Parameters\": {\n            \"IsFullWordMatch\": \"false\",\n            \"IsIgnoreCase\": \"true\"\n          }\n        }\n      ],\n      \"Nodes\": []\n    },\n    {\n      \"NodeType\": \"operator\",\n      \"OptType\": \"and\",\n      \"RuleInfos\": [\n        {\n          \"DataSourceType\": \"field_name\",\n          \"RuleMethod\": \"match\",\n          \"RuleType\": \"keyword\",\n          \"RuleContent\": \"country\\nCountry\",\n          \"Parameters\": {\n            \"IsFullWordMatch\": \"false\",\n            \"IsIgnoreCase\": \"true\"\n          }\n        },\n        {\n          \"DataSourceType\": \"field_name\",\n          \"RuleMethod\": \"match\",\n          \"RuleType\": \"keywordNotMatch\",\n          \"RuleContent\": \"side\\nmusic\\nroad\\nlife\\nstyle\\nfolk\\nhouse\\nyard\\nwide\",\n          \"Parameters\": {\n            \"IsFullWordMatch\": \"false\",\n            \"IsIgnoreCase\": \"true\"\n          }\n        }\n      ],\n      \"Nodes\": []\n    }\n  ]\n}",
        "Type": 1,
"UnStructuredRule": "{\n  \"RegexRule\": {\n    \"Operator\": \"or\",\n    \"Contents\": [\n      {\n        \"RuleContent\": \"(?<=\\\\W)(China|Japan|South Korea|North Korea|Mongolia|Vietnam|Cambodia|Laos|Thailand|Myanmar|Philippines|Brunei|Malaysia|Singapore|Indonesia|Timor-Leste|Nepal|Bhutan|Pakistan|India|Bangladesh|Maldives|Sri Lanka|Kazakhstan|Kyrgyzstan|Tajikistan|Uzbekistan|Turkmenistan|Afghanistan|Iran|Iraq|Syria|Lebanon|Israel|Palestine|Jordan|Saudi Arabia|Bahrain|Qatar|Kuwait|United Arab Emirates|Oman|Yemen|Georgia|Armenia|Azerbaijan|Türkiye|Iceland|Denmark|Norway|Sweden|Finland|UK|Ireland|France|Monaco|Netherlands|Belgium|Luxembourg|Germany|Switzerland|Liechtenstein|Poland|Czech|Slovakia|Austria|Hungary|Estonia|Latvia|Lithuania|Belarus|Ukraine|Moldova|Russia|Portugal|Spain|Andorra|Italy|San Marino|Vatican|Malta|Slovenia|Croatia|Bosnia and Herzegovina|Montenegro|Serbia|Albania|North Macedonia|Bulgaria|Greece|Romania|Cyprus|Egypt|Libya|Tunisia|Algeria|Morocco|Niger|Burkina Faso|Mali|Mauritania|Nigeria|Benin|Togo|Ghana|Côte d'Ivoire|Liberia|Sierra Leone|Guinea|Guinea-Bissau|Senegal|Gambia|Cape Verde|Chad|Central Africa|Cameroon|Democratic Republic of The Congo|Republic of The Congo|Gabon|Equatorial Guinea|Sao Tome and Principe|Djibouti|Somalia|Eritrea|Ethiopia|Sudan|South Sudan|Kenya|Tanzania|Uganda|Rwanda|Burundi|Seychelles|Angola|Zambia|Malawi|Mozambique|Namibia|Botswana|Zimbabwe|South Africa|Eswatini|Lesotho|Madagascar|Mauritius|Comoros|Australia|New Zealand|Palau|Federated States of Micronesia|Marshall Islands|Nauru|Kiribati|Papua New Guinea|Solomon Islands|Vanuatu|Fiji|Tuvalu|Samoa|Tonga|Niue|Cook Islands|Canada|United States|Mexico|Guatemala|Belize|El Salvador|Honduras|Nicaragua|Costa Rica|Panama|Bahamas|Cuba|Jamaica|Haiti|Dominican|Saint Kitts and Nevis|Antigua and Barbuda|Dominica|Saint Lucia|Barbados|Saint Vincent and The Grenadines|Grenada|Trinidad and Tobago|Colombia|Venezuela|Guyana|Suriname|Ecuador|Peru|Bolivia|Brazil|Chile|Argentina|Uruguay|Paraguay|Curaçao|China|Japan|South Korea|North Korea|Mongolia|Vietnam|Cambodia|Laos|Thailand|Myanmar|Philippines|Brunei|Malaysia|Singapore|Indonesia|Timor-Leste|Nepal|Bhutan|Pakistan|India|Bangladesh|Maldives|Sri Lanka|Kazakhstan|Kyrgyzstan|Tajikistan|Uzbekistan|Turkmenistan|Afghanistan|Iran|Iraq|Syria|Lebanon|Israel|Palestine|Jordan|Saudi Arabia|Bahrain|Qatar|Kuwait|United Arab Emirates|Oman|Yemen|Georgia|Armenia|Azerbaijan|Türkiye|Iceland|Denmark|Norway|Sweden|Finland|UK|Ireland|France|Monaco|Netherlands|Belgium|Luxembourg|Germany|Switzerland|Liechtenstein|Poland|Czech|Slovakia|Austria|Hungary|Estonia|Latvia|Lithuania|Belarus|Ukraine|Moldova|Russia|Portugal|Spain|Andorra|Italy|San Marino|Vatican|Malta|Slovenia|Croatia|Bosnia and Herzegovina|Montenegro|Serbia|Albania|North Macedonia|Bulgaria|Greece|Romania|Cyprus|Egypt|Libya|Tunisia|Algeria|Morocco|Niger|Burkina Faso|Mali|Mauritania|Nigeria|Benin|Togo|Ghana|Côte d'Ivoire|Liberia|Sierra Leone|Guinea|Guinea-Bissau|Senegal|Gambia|Cape Verde|Chad|Central Africa|Cameroon|Democratic Republic of The Congo|Republic of The Congo|Gabon|Equatorial Guinea|Sao Tome and Principe|Djibouti|Somalia|Eritrea|Ethiopia|Sudan|South Sudan|Kenya|Tanzania|Uganda|Rwanda|Burundi|Seychelles|Angola|Zambia|Malawi|Mozambique|Namibia|Botswana|Zimbabwe|South Africa|Eswatini|Lesotho|Madagascar|Mauritius|Comoros|Australia|New Zealand|Palau|Federated States of Micronesia|Marshall Islands|Nauru|Kiribati|Papua New Guinea|Solomon Islands|Vanuatu|Fiji|Tuvalu|Samoa|Tonga|Niue|Cook Islands|Canada|United States|Mexico|Guatemala|Belize|El Salvador|Honduras|Nicaragua|Costa Rica|Panama|Bahamas|Cuba|Jamaica|Haiti|Dominican|Saint Kitts and Nevis|Antigua and Barbuda|Dominica|Saint Lucia|Barbados|Saint Vincent and The Grenadines|Grenada|Trinidad and Tobago|Colombia|Venezuela|Guyana|Suriname|Ecuador|Peru|Bolivia|Brazil|Chile|Argentina|Uruguay|Paraguay|Curaçao)(?=\\\\W)\"\n      }\n    ]\n  }\n}"Guinea|Solomon Islands|Vanuatu|Fiji|Tuvalu|Samoa|Tonga|Niue|Cook Islands|Canada|United States of America|Mexico|Guatemala|Belize|El Salvador|Honduras|Nicaragua|Costa Rica|Panama|Bahamas|Cuba|Jamaica|Haiti|Dominican Republic|Saint Kitts and Nevis|Antigua and Barbuda|Dominica|Saint Lucia|Barbados|Saint Vincent and the Grenadines|Grenada|Trinidad and Tobago|Colombia|Venezuela|Guyana|Suriname|Ecuador|Peru|Bolivia|Brazil|Chile|Argentina|Uruguay|Paraguay|Curaçao)(?=\\\\W)|(?i)(?<=((country|country code|country_?code)\\\\W{1,7}))(\\\\d{2,3}|[A-Z]{2,3})(?=\\\\W)\",\n        \"IsIgnoreCase\": false\n      }\n    ]\n  },\n  \"AlgorithmRule\": {\n    \"Operator\": \"or\",\n    \"Contents\": []\n  },\n  \"KeywordRule\": {\n    \"Operator\": \"or\",\n    \"Contents\": [\n      {\n        \"RuleContent\": \"country\",\n        \"IsIgnoreCase\": false\n      },\n      {\n        \"RuleContent\": \"country\",\n        \"IsIgnoreCase\": true\n      }\n    ]\n  },\n  \"IgnoreStringRule\": {\n    \"Operator\": \"or\",\n    \"Contents\": []\n  },\n  \"MaxMatchRule\": {\n    \"Length\": 20\n  },\n  \"GlobalKeywordRule\": {\n    \"Contents\": [],\n    \"IsIgnoreCase\": true\n  }\n}"
        "RequestId": "8667abd2-8e7e-4a9a-b30b-712a2e66d3b1"
    }
}

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.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
LimitExceeded The quota limit is exceeded.
MissingParameter Parameters are missing.
OperationDenied Operation denied.
RequestLimitExceeded Number of requests exceeds the frequency limit.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resources are unavailable.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation The operation is not supported.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback