ListRulesV4 - 获取规则列表(新版质检)

对应前端功能位置:质检规则配置-列表。专有云URL:ip:port/api/rule/GetRulesCountList.json。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sca:ListRulesV4
*全部资源
*

请求参数

名称类型必填描述示例值
Ridlong

按规则 ID 搜索。

895EAD5312634F5AA708E3B3FA79662E
RuleIdOrRuleNamestring

按规则 ID 或者规则名称搜索。

xx
BusinessNamestring

规则所属业务名称。

所有业务
Typeinteger

规则所属的规则类型的 type 值。

1
TypeNamestring

规则所属的规则类型的名称。

所有类型
BusinessRangeinteger

大的业务分类。

CreateEmpidstring

规则创建者 ID,同 CreateUserId。二选一即可。

1
CreateUserIdlong

规则创建者 ID,同 CreateEmpId。二选一即可。

1
UpdateUserIdlong

规则更新者 ID,同 LastUpdateEmpId。二选一即可。

1
LastUpdateEmpidstring

规则更新者 ID,同 UpdateUserId。二选一即可。

1
Statusinteger

规则状态。

2
CategoryNamestring

分类名称。

分类名称A
SourceTypeinteger

来源类型

0
RuleTypeinteger

规则类别

1
UpdateStartTimestring

按照更新时间筛选(左区间)。

2021-11-29 16:11:09
UpdateEndTimestring

按照更新时间筛选(右区间)。

2021-11-29 18:11:09
SchemeIdlong

质检方案 ID。

1000000090
RequireInfosarray

需要字段

RequireInfostring

需要字段

xx
RuleScoreSingleTypeinteger

评分类型。

1
PageNumberinteger

当前页。

1
CurrentPageinteger

当前页码。

1
PageSizeinteger

每页显示条数。

10
CountTotalboolean

是否统计总数

false
StartTimestring

按照创建时间筛选(左区间)。

2021-11-29 18:11:09
EndTimestring

按照创建时间筛选(右区间)。

2021-11-29 19:11:09
BaseMeAgentIdlong

业务空间 Id

返回参数

名称类型描述示例值
object

RulePageResult

TotalCountinteger

数据总数。

219
BusinessTypeinteger

业务类型,无实际意义,忽略。

Dataarray

返回结果

DataRuleCountInfo

规则信息。

Countinteger

总条数。

219
CurrentPageinteger

当前页码。

10
PageSizeinteger

每页行数。

10
PageNumberinteger

当前页。

1
RequestIdstring

请求 ID

96138D8D-8D26-4E41-BFF4-77AED1088BBD
Successboolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null表示失败。

true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情,成功时为 successful

successful
Messagesarray

出错时表示出错详情,当输出多条信息时使用。

Messagestring

出错时表示出错详情,当输出多条信息时使用。

HttpStatusCodeinteger

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "TotalCount": 219,
  "BusinessType": 0,
  "Data": [
    {
      "Rid": 123,
      "Name": "0801转封装测试",
      "Type": 1,
      "Status": 1,
      "CheckNumber": 1,
      "HitNumber": 1,
      "HitRate": 1,
      "ReviewAccuracyRate": 1,
      "ReviewRate": 1,
      "PreReviewNumber": 1,
      "ReviewNumber": 1,
      "UnReviewNumber": 1,
      "ProblemNumber": 1,
      "StartTime": "1662685868850",
      "EndTime": "1650092585176",
      "CreateTime": "1615133575000",
      "CreateEmpid": "1",
      "CreateEmpName": "张三",
      "LastUpdateEmpid": "1",
      "LastUpdateEmpName": "张三",
      "LastUpdateTime": "1648200901000",
      "BusinessRange": [
        1
      ],
      "BusinessCategoryBasicInfoList": [
        {
          "Bid": 1,
          "ServiceType": 1,
          "Name": "全部",
          "OriginalId": 1
        }
      ],
      "BusinessCategoryNameList": [
        ""
      ],
      "IsDelete": 1,
      "TypeName": "全部类别",
      "JobName": "job-1-20221012-105943",
      "Comments": "测试",
      "RealViolationNumber": 1,
      "HitRealViolationRate": 1,
      "ReviewStatusName": "通过",
      "Deny": 1,
      "ScoreSubId": 1,
      "AutoReview": 1,
      "RuleScoreType": 1,
      "UserGroup": "xxxx",
      "OperationMode": 1,
      "IsSelect": true,
      "RuleType": 1,
      "Effective": 1,
      "FullCycle": 1,
      "EffectiveStartTime": "1662685868850",
      "EffectiveEndTime": "1662685868850",
      "QualityCheckType": 1,
      "GraphFlow": "较复杂,忽略",
      "RuleScoreSingleType": 1,
      "TargetType": 10
    }
  ],
  "Count": 219,
  "CurrentPage": 10,
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "96138D8D-8D26-4E41-BFF4-77AED1088BBD",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Messages": [
    "无"
  ],
  "HttpStatusCode": 200
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情
2023-08-01API 内部配置变更,不影响调用查看变更详情