Build Custom Security Checks with CreateCheckItem API - Security Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

User creates a custom check item

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SectionIds	array	Yes	Array of section IDs associated with the check item.
	long	Yes	Section ID associated with the check item. Note You can call the ListCheckPolicies API to get the check item ID.	1000000000001
Vendor	string	Yes	Cloud asset vendor. Note You can call the ListCloudAssetSchemas API to get the available vendors.	ALIYUN
InstanceType	string	Yes	Asset type of the cloud product. Note You can call the ListCloudAssetSchemas API to get this parameter.	ECS
InstanceSubType	string	Yes	Sub-asset type of the cloud product. Note You can call the ListCloudAssetSchemas API to get this parameter.	DISK
CheckShowName	string	Yes	Name of the custom check item.	testCheckItemName
RiskLevel	string	Yes	Risk level of the check item. Values: HIGH: High risk MEDIUM: Medium risk LOW: Low risk	LOW
Status	string	Yes	Status of the check item. Values: EDIT: In editing RELEASE: Released Note Changing from Released to In editing will clear all historical records Only the Released status allows the use of the check item for inspection.	EDIT
Remark	string	No	Remark information.	remark
Description	object	No	Description information of the check item.
Type	string	No	Type of the check item description information. Values: text: Text	text
Value	string	No	Specific content of the description.	custom description.
AssistInfo	object	No	Help information for the check item.
Type	string	No	Type of the help information for the check item risk. Values: text: Text	text
Value	string	No	Content of the help information for the check item risk.	custom assistInfo.
Solution	object	No	Solution information for the check item.
Type	string	No	Type of the solution information for the check item. Values: text: Text	text
Value	string	No	Content of the solution for the check item risk.	text
CheckRule	string	Yes	Definition rule for the custom check item.	{"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"}]}}

Response parameters

Parameter	Type	Description	Example
	object	Data structure returned by the interface.
RequestId	string	ID of the current request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.	F8B6F758-BCD4-597A-8A2C-DA5A552C****
Data	object	Data returned upon successful invocation.
CheckId	long	The ID of the inspection item returned upon successful creation.	100000000001

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	ParamIllegal.%s	The parameter %s is invalid, please fill it in again.	Invalid parameter, please fill in again
400	CspmParamOverSize	The parameter is too long.	The parameter is too long, please fill in again.
400	NoPurchase	The user did not purchase this product.	User has not purchased this product
400	CspmCreateCheckCustomItemExceedLimit	The number of custom check items created exceeds the limit.	The number of custom check items created exceeds the limit.
400	CspmCheckCustomItemSectionsError	The chapter associated with the custom check item does not exist.	The chapter associated with the custom check item does not exist.
400	CspmVerifyItemRuleError.%s	Audit check item check rule error: %s.	The format of the check item rule does not pass. For details, see the return error code.
400	CspmCreateCheckCustomItemError	Failed to create custom check item.	Failed to create custom check item.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-11-13	Add Operation	View Change Details