CreateCheckItem - 创建自定义检查项

更新时间:
复制 MD 格式

在云安全态势管理自定义检查项功能中,用户创建自定义检查项。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:CreateCheckItem

create

*CustomCheckItem

acs:yundun-sas:{#regionId}:{#accountId}:customcheckitem/*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

SectionIds

array

检查项关联的章节 ID 数组。

integer

检查项关联章节 ID。

说明

您可调用 ListCheckPolicies 接口获取检查项 ID。

1000000000001

Vendor

string

云资产厂商。

说明

您可调用 ListCloudAssetSchemas 接口获取可填入的厂商。

ALIYUN

InstanceType

string

云产品的资产类型。

说明

您可调用 ListCloudAssetSchemas 接口获取该参数。

ECS

InstanceSubType

string

云产品的资产子类型。

说明

您可调用 ListCloudAssetSchemas 接口获取该参数。

DISK

CheckShowName

string

自定义检查项名称。

testCheckItemName

RiskLevel

string

检查项的风险等级。取值:

  • HIGH:高危

  • MEDIUM:中危

  • LOW:低危

LOW

Status

string

检查项状态。取值:

  • EDIT:编辑中

  • RELEASE:已发布

说明
  • 已发布改为编辑中会清除所有历史记录

  • 只有已发布状态才能使用检查项检查。

枚举值:

  • EDIT :

    编辑中

  • RELEASE :

    已发布

EDIT

Remark

string

备注信息。

remark

Description

object

检查项的描述信息。

Type

string

检查项描述信息类型。取值:

  • text:文本

text

Value

string

描述的具体内容信息。

custom description.

AssistInfo

object

检查项帮助信息。

Type

string

检查项风险的帮助信息类型。取值:

  • text:文本

text

Value

string

检查项风险的帮助信息的内容。

custom assistInfo.

Solution

object

检查项解决方案信息。

Type

string

检查项解决方案信息类型。取值:

  • text:文本

text

Value

string

检查项风险的解决方案内容。

text

CheckRule

string

自定义检查项定义规则。

{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testId"},{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","MatchOperator":"EQ","MatchPropertyValue":"testInstanceId"}]}}

返回参数

名称

类型

描述

示例值

object

接口返回的数据结构体。

RequestId

string

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

F8B6F758-BCD4-597A-8A2C-DA5A552C****

Data

object

调用成功时,返回的数据。

CheckId

integer

创建成功返回的检查项 ID。

100000000001

示例

正常返回示例

JSON格式

{
  "RequestId": "F8B6F758-BCD4-597A-8A2C-DA5A552C****",
  "Data": {
    "CheckId": 100000000001
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParamIllegal.%s The parameter %s is invalid, please fill it in again. 参数非法,请重新填写
400 CspmParamOverSize The parameter is too long. 参数过长,请重新填写。
400 NoPurchase The user did not purchase this product. 用户未购买本产品
400 CspmCreateCheckCustomItemExceedLimit The number of custom check items created exceeds the limit. 创建自定义检查项超出数量限制。
400 CspmCheckCustomItemSectionsError The chapter associated with the custom check item does not exist. 自定义检查项关联章节不存在
400 CspmVerifyItemRuleError.%s Audit check item check rule error: %s. 检查项规则检验格式不通过,详情请查看返回错误码。
400 CspmCreateCheckCustomItemError Failed to create custom check item. 创建自定义检查项失败。

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

变更历史

更多信息,参考变更详情