VerifyCheckCustomConfig - 验证态势感知自定义配置

用来验证用户输入的配置信息是否符合对应参数配置的要求。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:VerityCheckCustomConfigget
*全部资源
*

请求参数

名称类型必填描述示例值
CheckIdlong

检查项 ID。

76
CustomConfigsarray<object>

检查项自定义参数配置项列表。

object

检查项自定义配置项列表。

Namestring

检查项自定义配置项名称,同检查项唯一。

IPList
Valuestring

检查项自定义配置项用户配置值字符串。

10.12.4.XX
Operationstring

检查项自定义配置项操作类型,只有删除时传 DELETE,创建和更新不用传。

DELETE
RepairConfigsarray<object>

检查项修复功能支持的修复参数。

object

检查项修复功能支持的修复参数。

Namestring

检查项修复参数名称,同检查项唯一。

IPLists
Valuestring

检查项修复配置项用户配置值字符串。

172.26.49.XX
FlowIdstring

修复时对应修复流程的 ID。

7fec0a3395b345c18f108ffc9fc0****
Operationstring

检查项自定义配置项操作类型,只有删除时传 DELETE,创建和更新不用传。

DELETE
Typestring

态势感知参数验证类型:

  • REPAIR_CONFIG:修复与自定义参数验证(默认)
  • CHECK_ITEM_CONFIG:自定义检查项验证
REPAIR_CONFIG
CustomCheckConfigobject

自定义检查项验证输入参数。

Vendorstring

云资产厂商。取值:

  • ALIYUN:阿里云
  • Tencent:腾讯云
  • HUAWEICLOUD:华为云
  • Azure:微软
  • AWS:亚马逊云(AWS)
ALIYUN
InstanceTypestring

云产品的资产类型。取值:

  • ECS:云服务器
  • SLB:负载均衡
  • RDS:RDS 数据库
  • MONGODB:MongoDb 数据库
  • KVSTORE:Redis 数据库
  • ACR:ACR
  • CSK:CSK
  • VPC:VPC
  • ACTIONTRAIL:操作审计
  • CDN:CDN
  • CAS:数字证书管理服务[原 SSL 证书]
  • RDC:云效
  • RAM:RAM
  • DDOS:分布式拒绝服务
  • WAF:WAF
  • OSS:访问控制
  • POLARDB:POLARDB
  • POSTGRESQL:PostgreSQL
  • MSE:MSE
  • NAS:NAS
  • SDDP:SDDP
  • EIP:EIP
ECS
InstanceSubTypestring

云产品的资产子类型。

DISK
CheckRulestring

自定义检查项定义规则。

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

需要测试规则的资产实例。

InstanceIdstring

资产的实例 ID。

i-0jl4mjgl261cfrz5****
RegionIdstring

实例的地域 ID。

ap-southeast-1

返回参数

名称类型描述示例值
object

返回消息的结构体。

RequestIdstring

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

7532B7EE-7CE7-5F4D-BF04-B12447DD****
ErrorCheckConfigsarray<object>

配置检查错误的检查参数列表。

ErrorCheckConfigobject
Namestring

检查项自定义配置项名称,同检查项唯一。

IpList
Valuestring

检查项自定义配置项用户配置值字符串。

10.12.4.XX
Typestring

出错的参数类型:

  • custom:自定义配置参数
custom
ErrorCodestring

错误码。

ConfigEqualIllegal
ErrorMsgstring

错误消息。

Custom parameter is not equal to corresponding check parameter
LinkErrorConfigsarray<object>

导致此错误的相关配置。

LinkErrorConfigobject
Namestring

检查项配置项名称,同检查项唯一。

IpLists
ShowNamestring

用户检查配置展示名称。

IP Lists
Typestring

出错的参数类型:

  • repair:修复参数
  • custom:自定义配置参数
repair
ErrorRepairConfigsarray<object>

配置检查错误的修复参数列表。

ErrorRepairConfigobject
Namestring

检查项修复配置项名称,同检查项唯一。

IpLists
Valuestring

检查项修复参数名称,同检查项唯一。

172.26.49.XX
Typestring

出错的参数类型:

  • repair:修复参数
repair
ErrorCodestring

错误码。

ConfigEqualIllegal
ErrorMsgstring

错误消息。

Repair parameter is not equal to corresponding check parameter
LinkErrorConfigsarray<object>

导致此错误的相关配置。

LinkErrorConfigobject
Namestring

检查项配置项名称,同检查项唯一。

IpList
ShowNamestring

用户检查配置展示名称。

Ip List
Typestring

出错的参数类型:

  • repair:修复参数
  • custom:自定义配置参数
custom
ErrorCheckCustomConfigobject

检查自定义检查项返回的错误码。

ErrorCodestring

失败时错误码。成功时此参数不返回。

  • CspmVerifyCheckCustomItemNoPass:资产未通过设置的自定义规则。
  • CspmVerifyCheckCustomItemError:验证错误,输入规则存在问题。
CspmVerifyCheckCustomItemNoPass
ErrorMsgstring

异常信息

Creation verification failed.

示例

正常返回示例

JSON格式

{
  "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."
  }
}

错误码

HTTP status code错误码错误信息描述
400ParamIllegal.%sThe parameter %s is invalid, please fill it in again.参数非法,请重新填写
400NoPurchaseThe user did not purchase this product.用户未购买本产品
400CspmVerifyItemRuleError.%sAudit check item check rule error: %s.检查项规则检验格式不通过,详情请查看返回错误码。
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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