获取规则字段及类型

最近更新时间: 2026-10-10 00:08:39

1. 接口描述

接口请求域名： cds.api3.fincloud.tencent.com。

获取规则字段及类型

默认接口请求频率限制：20次/秒。

接口更新时间：2026-01-28 15:13:36。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeFieldConfig
Version	是	否	String	公共参数，本接口取值：2018-04-20
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。

3. 输出参数

参数名称	类型	描述
FieldTypes	RuleConfigFieldTypes	字段类型示例值：查看
Fields	RuleConfigFields	字段信息示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DasbErrorCode	Dasb产品操作失败错误码。
FailedOperation.DasbInvalidSecretId	SecretId错误，操作失败。
FailedOperation.DasbInvalidSecretKey	SecretKey错误，操作失败。
FailedOperation.DasbAmountNotEnough	账户余额不足，操作失败。
InvalidParameter.ResourceId	无效的资源ID，用于资源不存在或已过期。
UnauthorizedOperation.NoPermission	无操作权限。
UnsupportedOperation	操作不支持。
ResourceInUse	资源被占用。
UnauthorizedOperation	未授权操作。
MissingParameter	缺少参数错误。
InvalidParameter	参数错误。
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceInsufficient	资源不足。
LimitExceeded	超过配额限制。
ResourceUnavailable	资源不可用。
ResourceNotFound	资源不存在。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
OperationDenied	操作被拒绝。
ResourcesSoldOut	资源售罄。
InvalidParameterValue	参数取值错误。
FailedOperation	操作失败。
UnknownParameter	未知参数错误。

5. 示例

示例1 获取规则字段及类型

输入示例

POST / HTTP/1.1
Host: cds.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeFieldConfig
<Common Parameters>

{
}

输出示例

{
  "Response": {
    "RequestId": "d0f51893-e15f-44ac-be6d-900450a6b8c1",
    "FieldTypes": {
      "Double": [
        {
          "TypeName": "greater_equal",
          "Name": "Greater than or equal to"
        },
        {
          "TypeName": "less_equal",
          "Name": "Less than or equal to"
        },
        {
          "TypeName": "greater",
          "Name": "Greater than"
        },
        {
          "TypeName": "less",
          "Name": "Less than"
        },
        {
          "TypeName": "equal",
          "Name": "Equal"
        }
      ],
      "Int": [
        {
          "TypeName": "greater_equal",
          "Name": "Greater than or equal to"
        },
        {
          "TypeName": "less_equal",
          "Name": "Less than or equal to"
        },
        {
          "TypeName": "greater",
          "Name": "Greater than"
        },
        {
          "TypeName": "less",
          "Name": "Less than"
        },
        {
          "TypeName": "equal",
          "Name": "Equal"
        }
      ],
      "String": [
        {
          "TypeName": "include",
          "Name": "Include"
        },
        {
          "TypeName": "exclude",
          "Name": "Exclude"
        },
        {
          "TypeName": "regex",
          "Name": "Regular expression"
        }
      ]
    },
    "Fields": {
      "ClientIp": {
        "TypeName": "string",
        "Name": "Client IP"
      },
      "DbIp": {
        "TypeName": "string",
        "Name": "Database IP"
      },
      "DbName": {
        "TypeName": "string",
        "Name": "Database name"
      },
      "DbPort": {
        "TypeName": "int",
        "Name": "Database port"
      },
      "DbUser": {
        "TypeName": "string",
        "Name": "Database user"
      },
      "EffectRow": {
        "TypeName": "int",
        "Name": "Effect row"
      },
      "ExecTime": {
        "TypeName": "double",
        "Name": "Execution time"
      },
      "OpSql": {
        "TypeName": "string",
        "Name": "Operation statement"
      },
      "OpTime": {
        "TypeName": "int",
        "Name": "Operation time"
      },
      "SqlType": {
        "TypeName": "string",
        "Name": "Operation type"
      },
      "TableName": {
        "TypeName": "string",
        "Name": "Table name"
      }
    }
  }
}