Configure and Validate Custom Check Items via VerifyCheckCustomConfig - Security Center - Alibaba Cloud - Security Center

Authenticates whether the configuration information entered by a user is compliant with the requirements of the corresponding parameter settings.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:VerityCheckCustomConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CheckId	integer	No	The ID of the check item.	76
CustomConfigs	array<object>	No	The list of custom parameter configuration items for the check item.
	object	No	The list of custom configuration items for the check item.
Name	string	No	The name of the custom configuration item for the check item. The name is unique within the check item.	IPList
Value	string	No	The user-configured value string of the custom configuration item for the check item.	10.12.4.XX
Operation	string	No	The operation type of the custom configuration item for the check item. Set this parameter to DELETE only for deletion operations. You do not need to specify this parameter for creation or update operations.	DELETE
RepairConfigs	array<object>	No	The repair parameters supported by the repair feature of the check item.
	object	No	The repair parameters supported by the repair feature of the check item.
Name	string	No	The name of the repair parameter for the check item. The name is unique within the check item.	IPLists
Value	string	No	The user-configured value string of the repair configuration item for the check item.	172.26.49.XX
FlowId	string	No	The ID of the repair flow that corresponds to the repair operation.	7fec0a3395b345c18f108ffc9fc0****
Operation	string	No	The operation type of the custom configuration item for the check item. Set this parameter to DELETE only for deletion operations. You do not need to specify this parameter for creation or update operations.	DELETE
Type	string	No	The validation type for Threat Detection Service parameters. Valid values: REPAIR_CONFIG: repair and custom parameter validation (default). CHECK_ITEM_CONFIG: custom check item validation.	REPAIR_CONFIG
CustomCheckConfig	object	No	The input parameters for custom check item validation.
Vendor	string	No	The cloud asset vendor. Valid values: ALIYUN: Alibaba Cloud Tencent: Tencent Cloud HUAWEICLOUD: Huawei Cloud Azure: Microsoft Azure AWS: Amazon Web Services (AWS).	ALIYUN
InstanceType	string	No	The asset type of the cloud service. Valid values: ECS: server SLB: load balancing RDS: ApsaraDB RDS database MONGODB: ApsaraDB for MongoDB database KVSTORE: ApsaraDB for Redis database ACR: ACR CSK: CSK VPC: VPC ACTIONTRAIL: ActionTrail CDN: CDN CAS: Certificate Management Service (formerly SSL Certificates Service) RDC: Apsara Devops RAM: RAM DDOS: distributed deny of service WAF: WAF OSS: access control POLARDB: POLARDB POSTGRESQL: PostgreSQL MSE: MSE NAS: NAS SDDP: SDDP EIP: EIP.	ECS
InstanceSubType	string	No	The asset subtype of the cloud service.	DISK
CheckRule	string	No	The definition rule of the custom check item.	{"AssociatedData":{"ToDataList":[{"DataName":"ACS_ECS_Instance","PropertyPath":"InstanceId","FromPropertyPath":"InstanceId"}]},"MatchProperty":{"Operator":"AND","MatchProperties":[{"DataName":"ACS_ECS_Disk","PropertyPath":"DiskId","MatchOperator":"EQ","MatchPropertyValue":"testId"}]}}
CloudAssetInstance	object	No	The asset instance on which you want to test the rule.
InstanceId	string	No	The instance ID of the asset.	i-0jl4mjgl261cfrz5****
RegionId	string	No	The region ID of the instance.	ap-southeast-1

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	7532B7EE-7CE7-5F4D-BF04-B12447DD****
ErrorCheckConfigs	array<object>	The list of check parameters that have configuration check errors.
	array<object>
Name	string	The name of the custom configuration item for the check item. The name is unique within the check item.	IpList
Value	string	The user-configured value string of the custom configuration item for the check item.	10.12.4.XX
Type	string	The type of the parameter that has an error. Valid values: custom: custom configuration parameter.	custom
ErrorCode	string	The error code.	ConfigEqualIllegal
ErrorMsg	string	The error message.	Custom parameter is not equal to corresponding check parameter
LinkErrorConfigs	array<object>	The related configurations that caused this error.
	object
Name	string	Name of the check item configuration, unique within the same check item.	IpLists
ShowName	string	Display name of the user's check configuration.	IP Lists
Type	string	The type of the parameter that caused the error: repair: Repair parameter custom: Custom configuration parameter	repair
ErrorRepairConfigs	array<object>	The list of repair parameters that have configuration check errors.
	array<object>
Name	string	The name of the repair configuration item for the check item. The name is unique within the check item.	IpLists
Value	string	The name of the repair parameter for the check item. The name is unique within the check item.	172.26.49.XX
Type	string	The type of the parameter that has an error. Valid values: repair: repair parameter.	repair
ErrorCode	string	The error code.	ConfigEqualIllegal
ErrorMsg	string	The error message.	Repair parameter is not equal to corresponding check parameter
LinkErrorConfigs	array<object>	The related configurations that caused this error.
	object
Name	string	Name of the check item's configuration, unique within the same check item.	IpList
ShowName	string	Display name of the user's check configuration.	Ip List
Type	string	The type of the parameter that caused the error: repair: Repair parameter custom: Custom configuration parameter	custom
ErrorCheckCustomConfig	object	The error code returned for the custom check item validation.
ErrorCode	string	The error code returned upon failure. This parameter is not returned upon success. Valid values: CspmVerifyCheckCustomItemNoPass: The asset did not pass the custom rule that was configured. CspmVerifyCheckCustomItemError: A validation error occurred because the input rule has issues.	CspmVerifyCheckCustomItemNoPass
ErrorMsg	string	The exception information.	Creation verification failed.

Examples

Success response

JSON format

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DD****",
  "ErrorCheckConfigs": [
    {
      "Name": "IpList",
      "Value": "10.12.4.XX",
      "Type": "custom",
      "ErrorCode": "ConfigEqualIllegal",
      "ErrorMsg": "Custom parameter is not equal to corresponding check parameter",
      "LinkErrorConfigs": [
        {
          "Name": "IpLists",
          "ShowName": "IP Lists",
          "Type": "repair"
        }
      ]
    }
  ],
  "ErrorRepairConfigs": [
    {
      "Name": "IpLists",
      "Value": "172.26.49.XX\n",
      "Type": "repair",
      "ErrorCode": "ConfigEqualIllegal",
      "ErrorMsg": "Repair parameter is not equal to corresponding check parameter",
      "LinkErrorConfigs": [
        {
          "Name": "IpList",
          "ShowName": "Ip List",
          "Type": "custom"
        }
      ]
    }
  ],
  "ErrorCheckCustomConfig": {
    "ErrorCode": "CspmVerifyCheckCustomItemNoPass",
    "ErrorMsg": "Creation verification failed."
  }
}

Error codes

HTTP status code	Error code	Error message
400	ParamIllegal.%s	The parameter %s is invalid, please fill it in again.
400	NoPurchase	The user did not purchase this product.
400	CspmVerifyItemRuleError.%s	Audit check item check rule error: %s.
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.