更新时间:2025-09-04 GMT+08:00
分享

查询规则集信息

功能介绍

查询规则集信息

调用方法

请参见如何调用API

URI

GET /v1/criterionsets/{set_id}

表1 路径参数

参数

是否必选

参数类型

描述

set_id

String

参数解释:

规则集ID,通过查询规则集列表接口查询。

约束限制:

不涉及。

取值范围:

32位规则集ID。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

operator

String

参数解释:

操作者。

约束限制:

不涉及。

取值范围:

用户名。

默认值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释:

HTTP响应状态,接口响应成功时为"OK",接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常,BAD_REQUEST是参数校验异常。

取值范围:

  • OK,接口响应成功。

  • ACCEPTED,接口响应成功。

  • INTERNAL_SERVER_ERROR,接口内部异常。

  • BAD_REQUEST,参数校验异常。

result

CriterionSetBody object

参数解释:

规则集信息。

取值范围:

不涉及。

status

String

参数解释:

接口响应状态。

取值范围:

  • success,接口响应成功。

  • error,接口响应失败。

表4 CriterionSetBody

参数

参数类型

描述

id

String

参数解释:

规则集id。

取值范围:

不涉及。

name

String

参数解释:

规则集中文名称。

取值范围:

不涉及。

nameEn

String

参数解释:

规则集英文名称。

取值范围:

不涉及。

comments

String

参数解释:

规则集中文描述。

取值范围:

不涉及。

commentsEn

String

参数解释:

规则集英文描述。

取值范围:

不涉及。

type

String

参数解释:

规则集类型。

取值范围:

  • system,系统规则集。

  • custom,自定义规则集。

creator

String

参数解释:

规则集创建者。

取值范围:

用户名。

createTime

String

参数解释:

规则集创建时间。

取值范围:

0时区标准时间。

lastReviser

String

参数解释:

规则集最近一次更新的操作人。

取值范围:

用户名。

lastUpdateTime

String

参数解释:

规则集最近一次更新的时间。

取值范围:

0时区标准时间。

language

String

参数解释:

规则集语言。

取值范围:

  • ARKTS

  • C#

  • C++

  • CSS

  • GO

  • HTML

  • JAVA

  • JAVASCRIPT

  • KOTLIN

  • LUA

  • PHP

  • PYTHON

  • RUST

  • SCALA

  • SHELL

  • SQL

  • TYPESCRIPT

parentId

String

参数解释:

祖先规则集id。

取值范围:

32位uuid组成的字符串。多个id之间用逗号分隔。

numCriterion

Integer

参数解释:

规则集中已启用的规则数量。

取值范围:

大于等于0。

canEdit

Boolean

参数解释:

当前用户是否具有修改该规则集的权限。

取值范围:

  • true,有编辑的权限。

  • false,没有编辑的权限。

canDelete

Boolean

参数解释:

当前用户是否具有删除该规则集的权限。

取值范围:

  • true,有删除的权限。

  • false,没有删除的权限。

managers

String

参数解释:

规则集管理员。

取值范围:

用户id。多个id由逗号分隔。

parentSetNames

String

参数解释:

祖先规则集的名称。

取值范围:

多个规则集名称之间用逗号分隔。

domainId

String

参数解释:

租户id。

取值范围:

32位uuid。

domainName

String

参数解释:

租户名称。

取值范围:

不涉及。

inheritMode

String

参数解释:

继承类型。

取值范围:

  • strong,继承。

  • null,非继承。

creatorId

String

参数解释:

创建者用户id。

取值范围:

32位uuid。

isSystemDefault

String

参数解释:

是否为系统默认规则集。

取值范围:

  • 0,否。

  • 1,是。

isProjectDefault

String

参数解释:

是否为项目默认规则集。

取值范围:

  • 0,否。

  • 1,是。

isSystemSet

String

参数解释:

是否为系统规则集。

取值范围:

  • 0,否。

  • 1,是。

ruleIds

String

参数解释:

规则集中已启用的能力规则unique_id。

取值范围:

unique_id为32位uuid。多个unique_id之间用逗号分隔。

region

String

参数解释:

规则集所在局点。

取值范围:

不涉及。

canSetDefault

Boolean

参数解释:

是否具有设置默认规则集的权限。

取值范围:

  • true,有权限。

  • false,没有权限。

isUsed

Boolean

参数解释:

规则集是否被使用。

取值范围:

  • true,是。

  • false,否。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/criterionsets/24b97exxxxxxxxfb91cc25b14cxxxxxx

响应示例

状态码:200

get criterionset by id

{
  "httpStatus" : "OK",
  "result" : {
    "businessId" : "23900138",
    "businessName" : "Cloud & AI common",
    "canDelete" : true,
    "canEdit" : true,
    "childSets" : [ ],
    "comments" : "到时再说",
    "createTime" : "2020-11-13 15:35:06.0",
    "creator" : "SYSTEM",
    "defaultSet" : "false",
    "deptId" : "公司",
    "deptName" : "公司",
    "detecteObjType" : "biz_code",
    "id" : "fd146b4f384d442191fe49200bfce00f",
    "isProjectDefault" : "0",
    "isRecommand" : "0",
    "isReliable" : true,
    "isSystemDefault" : "0",
    "isSystemSet" : "0",
    "language" : "C",
    "lastReviser" : "",
    "lastUpdateTime" : "2024-03-06 17:05:41",
    "managers" : "",
    "name" : "华为C规则最小集(编程规范)",
    "numCriterion" : 51,
    "parentFolderId" : "24519a31060141708a0c61c1ac75e672",
    "parentFolderName" : "三层运营规则集",
    "parentId" : "",
    "parentSetNames" : "",
    "recommandType" : "2",
    "reliableTag" : "",
    "remark" : "ass",
    "type" : "tool"
  },
  "status" : "success"
}

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试。"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期。"
}

状态码

状态码

描述

200

get criterionset by id

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档