用来验证用户输入的配置信息是否符合对应参数配置的要求。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:VerityCheckCustomConfig | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CheckId | long | 否 | 检查项 ID。 | 76 |
CustomConfigs | array<object> | 否 | 检查项自定义参数配置项列表。 | |
object | 否 | 检查项自定义配置项列表。 | ||
Name | string | 否 | 检查项自定义配置项名称,同检查项唯一。 | IPList |
Value | string | 否 | 检查项自定义配置项用户配置值字符串。 | 10.12.4.XX |
Operation | string | 否 | 检查项自定义配置项操作类型,只有删除时传 DELETE,创建和更新不用传。 | DELETE |
RepairConfigs | array<object> | 否 | 检查项修复功能支持的修复参数。 | |
object | 否 | 检查项修复功能支持的修复参数。 | ||
Name | string | 否 | 检查项修复参数名称,同检查项唯一。 | IPLists |
Value | string | 否 | 检查项修复配置项用户配置值字符串。 | 172.26.49.XX |
FlowId | string | 否 | 修复时对应修复流程的 ID。 | 7fec0a3395b345c18f108ffc9fc0**** |
Operation | string | 否 | 检查项自定义配置项操作类型,只有删除时传 DELETE,创建和更新不用传。 | DELETE |
Type | string | 否 | 态势感知参数验证类型:
| REPAIR_CONFIG |
CustomCheckConfig | object | 否 | 自定义检查项验证输入参数。 | |
Vendor | string | 否 | 云资产厂商。取值:
| ALIYUN |
InstanceType | string | 否 | 云产品的资产类型。取值:
| ECS |
InstanceSubType | string | 否 | 云产品的资产子类型。 | DISK |
CheckRule | string | 否 | 自定义检查项定义规则。 | {"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 | 否 | 需要测试规则的资产实例。 | |
InstanceId | string | 否 | 资产的实例 ID。 | i-0jl4mjgl261cfrz5**** |
RegionId | string | 否 | 实例的地域 ID。 | ap-southeast-1 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 检查项规则检验格式不通过,详情请查看返回错误码。 |
403 | NoPermission | caller has no permission | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。 |
500 | ServerError | ServerError | 服务故障,请稍后重试! |
访问错误中心查看更多错误码。