1. 接口描述
接口请求域名： cds.api3.fincloud.tencent.cn。
规则列表查询
默认接口请求频率限制：20次/秒。
接口更新时间：2024-05-17 17:53:07。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeRulesList |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-20 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| Limit | 否 | 否 | Int64 | 限制数目 示例值： 10 |
| Offset | 否 | 否 | Int64 | 偏移量 示例值： 0 |
| RuleType | 否 | 否 | Int64 | 规则类型 示例值： 1 |
| IsInner | 否 | 否 | Int64 | 规则属性 示例值： 1 |
| DangerLevel | 否 | 否 | Int64 | 风险等级 示例值： 1 |
| RuleClassify | 否 | 否 | Int64 | 规则分类 示例值： 0 |
| ConfigType | 否 | 否 | Int64 | 规则类别（全部 -1 默认 0 常规 1 宽松 2 严格 3 用户配置4 ） 示例值： -1 |
| RuleName | 否 | 否 | String | 规则名称 示例值： 无Where更新或删除 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 总数目 示例值： 100 |
| List | Array of AuditRules | 规则列表数据 示例值：查看 |
| 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.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeRulesList
<公共请求参数>
{
"RuleType": 1,
"DangerLevel": 1,
"RuleClassify":0,
"Limit": 10,
"Offset": 0,
"IsInner": 1,
"ConfigType":-1,
"RuleName":""
}
输出示例
{
"Response": {
"TotalCount": 100,
"List": [
{
"AlarmPhone": 1,
"ConfigType": 0,
"AlarmWx": 1,
"RuleType": 0,
"Receivers": "xx",
"InstanceId": "xx",
"IsDelete": 0,
"RuleReceiver": "xx",
"DangerLevel": 0,
"UpdateTime": 0,
"SaveToDb": 0,
"InstanceName": "xx",
"IsOpened": 0,
"RuleId": 0,
"RuleClassify": 0,
"RuleDesc": "xx",
"RuleName": "xx",
"RuleStatus": "xx",
"IsInner": 0,
"AssetsList": [
{
"Status": 1,
"AssetsType": "xx",
"UpdateTime": 1,
"VpcId": "xx",
"AssetsPort": 1,
"AssetsAddType": 1,
"UploadPem": 0,
"Permission": 0,
"InstanceId": "xx",
"AddTime": 1,
"RegionId": "xx",
"AssetSubnetId": "xx",
"InstanceName": "xx",
"AssetsVersion": "xx",
"AssetsIp": "xx",
"Aid": 1,
"AliveStatus": 0,
"AssetsName": "xx",
"AddType": 1
}
],
"AlarmSms": 1,
"AlarmEmail": 1
}
],
"RequestId": "xx"
}
}