代码检查 CODEARTS CHECK-创建自定义规则集:请求参数

时间:2023-11-13 14:37:46

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

设置媒体类型和编码格式

X-Auth-Token

String

用户Token

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

最小长度:1

最大长度:100000

表2 请求Body参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:1

最大长度:50

template_name

String

新规则集名称

最小长度:1

最大长度:500

language

String

规则集语言

最小长度:1

最大长度:128

is_default

String

如果有基于的规则集则是1,没有基于的规则集则是0

最小长度:1

最大长度:1

rule_ids

String

新启用规则ids

最小长度:1

最大长度:4000

uncheck_ids

String

新关闭规则id

最小长度:1

最大长度:4000

template_id

String

规则集ID

最小长度:1

最大长度:50

custom_attributes

Array of CustomAttributes objects

自定义规则参数项,支持修改规则阈值

表3 CustomAttributes

参数

是否必选

参数类型

描述

attribute

String

配置项属性,severity:为问题级别

rules

Array of CustomAttributesRule objects

规则详细

表4 CustomAttributesRule

参数

是否必选

参数类型

描述

rule_id

String

规则ID

value

String

attribute的问题级别,0致命,1严重,2一般,3提示

rule_config_list

Array of RuleConfig objects

规则阈值详细

表5 RuleConfig

参数

是否必选

参数类型

描述

id

Integer

规则配置ID

rule_id

Integer

规则ID

default_value

String

默认值

option_value

String

当前

option_key

String

当前规则配置项key

option_name

String

当前规则配置项名称

template_id

String

规则集id

description

String

描述

support.huaweicloud.com/api-codecheck/CreateRuleset.html