1. API Description
Domain name for API request: wedata.intl.tencentcloudapi.com.
Viewing Rule Template List
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.
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: DescribeRuleTemplates. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2021-08-20. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| Type |
No |
Integer |
Template Type 1. System Template 2. Custom Definition Template |
| SourceObjectType |
No |
Integer |
1. Constant 2. Offline Table Level 2. Offline Field Level |
| ProjectId |
No |
String |
Project ID |
| SourceEngineTypes.N |
No |
Array of Integer |
Corresponding Engine Type of the Source |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Data |
Array of RuleTemplate |
Rule Template List Note: This field may return null, indicating that no valid value can be obtained. |
| 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 Viewing Rule Template List
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRuleTemplates
<Common request parameters>
{
"Type": 1,
"SourceObjectType": 1
}
Output Example
{
"Response": {
"Data": [
{
"RuleTemplateId": 1,
"Name": "Number of table rows",
"Description": "Description",
"Type": 1,
"SourceObjectType": 1,
"SourceObjectDataType": 1,
"SourceContent": "",
"SourceEngineTypes": [
2
],
"QualityDim": 1,
"CompareType": 1,
"CitationCount": 1,
"UserId": 1,
"UserName": "zahgnsan",
"UpdateTime": "2023-10-01",
"WhereFlag": true,
"MultiSourceFlag": true,
"SqlExpression": "select count(*) from table",
"SubQualityDim": 1,
"ResolvedSqlExpression": {
"TableExpressions": [
{
"TableExpression": "table_2.column_2",
"ColumnExpression": [
"column_1"
]
}
],
"ParamExpressions": [
"param_1"
]
},
"DatasourceTypes": [
2
]
}
],
"RequestId": "0ff4e8ae-ebea-4a41-8aa2-1f6bc4b68e69"
}
}
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 Failure. |
| InternalError |
An internal error occurs. |
| InvalidParameter |
Parameter error. |