跳至主内容

POST /cspm/vm/update

该API用于更新一个或多个检查项的属性。

请求

格式 

{
  "状态": "待处理",
  "状态备注": "字符串",
  "过期时间": "2024-01-08",
  "严重级别": "信息类",
  "严重级别备注": "字符串",
  "ID列表": [
    "字符串"
  ]
}

参数

参数

类型

可选性

描述

状态

字符串

是*

更改所选检查项的状态。

可选值： open , remediated , risk_accepted , false_positive , needs_review .

status_remarks

字符串

是

添加与状态变更相关的备注。

该字段最大长度为2000个字符。

注意

仅当请求中包含 status 参数时才能包含此参数。

expires_at

字符串

是

为新状态设置过期日期。过期后，检查项状态将变更为 needs_review .

该参数接受 yyyy-mm-dd 日期格式。

注意

该参数仅在请求中包含 status 参数且其值为 risk_accepted 时可用。

severity

字符串

必填*

修改所选检查项的严重级别。

可选值： 提示 , 低 , 中 , 高 , 严重 .

severity_remarks

字符串

必填

添加与严重级别变更相关的备注。

该字段最大长度为2000个字符。

注意

仅当请求中包含 severity 参数时方可使用此参数。

ids

字符串数组

否

需要修改的检查项ID。

每个请求最多可添加100个ID。

ID需符合RFC 4122格式，且必须对应云安全数据库中的检查项。

*请求中必须包含 status 和/或 severity 参数。

示例

更新检查记录状态 001ca9fe-7f34-4a43-9d9c-7d543badd802 , 00dff8ea-3bd9-447b-ba57-2da616357238 和 01e1706e-969f-42f9-9d27-4a5971251972 为 已修复 : 

{
    "status": "已修复",
    "status_remarks": "通过POST端点更新状态",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

更新检查记录状态 001ca9fe-7f34-4a43-9d9c-7d543badd802 , 00dff8ea-3bd9-447b-ba57-2da616357238 和 01e1706e-969f-42f9-9d27-4a5971251972 为 风险已接受 并将状态设置为在 2025-12-10 : 

{
    "status": "risk_accepted",
    "status_remarks": "通过POST端点更新状态",
    "expires_at": "2025-12-10",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

更新检查记录的严重性 001ca9fe-7f34-4a43-9d9c-7d543badd802 , 00dff8ea-3bd9-447b-ba57-2da616357238 和 01e1706e-969f-42f9-9d27-4a5971251972 为 高 : 

{
    "severity": "high",
    "severity_remarks": "通过POST端点更新严重性",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

更新检查记录的状态 001ca9fe-7f34-4a43-9d9c-7d543badd802 , 00dff8ea-3bd9-447b-ba57-2da616357238 和 01e1706e-969f-42f9-9d27-4a5971251972 为 risk_accepted ，将状态设置为在 2025-12-10 过期，并将其严重性更改为 高 : 

{
    "status": "risk_accepted",
    "status_remarks": "通过POST端点更新状态",
    "expires_at": "2022-12-10",
    "severity": "high",
    "severity_remarks": "通过POST端点更新严重性",
    "ids": [
        "001ca9fe-7f34-4a43-9d9c-7d543badd802",
        "00dff8ea-3bd9-447b-ba57-2da616357238",
        "01e1706e-969f-42f9-9d27-4a5971251972"
    ]
}

响应

格式 

{
  "statusCode": 0,
  "message": "字符串"
}

属性

属性

类型

描述

statusCode

整数

表示请求的状态。

message

字符串

提供状态的描述。

可能的值：

  • 200 - 成功

    请求成功。

  • 400 - 错误请求

    请求中提供的格式或值无效。

  • 504 - 网关超时 .

    请求失败。请稍后重试。

示例

请求成功： 

{
    "status_code": 200,
    "message": {
        "status": "risk_accepted",
        "status_remarks": "通过POST端点更新状态",
        "expires_at": "2022-12-10",
        "severity": "high",
        "severity_remarks": "通过POST端点更新严重性",
        "ids": [
            "001ca9fe-7f34-4a43-9d9c-7d543badd802",
            "00dff8ea-3bd9-447b-ba57-2da616357238",
            "01e1706e-969f-42f9-9d27-4a5971251972"
        ]
    }
}

请求中未包含有效的检查ID： 

{
    "status_code": 400,
    "message": {
        错误：请提供一个或多个检查ID
    }
}

请求中包含的ID数量 ids 参数超过请求限制： 

{
    "status_code": 400,
    "message": {
        Error: 检查ID不应超过规定的请求限制。限制：每次请求100个
    }
}

使用的检查ID无效： 

{
    "status_code": 400,
    "message": {
        Error: 未找到以下检查ID：001ca9fe-7f34-4a43-9d9c-7d543badd801
    }
}

请求中未包含 status 参数，也未包含 severity 参数： 

{
    "status_code": 400,
    "message": {
        Error: 请提供状态变更、严重性变更或两者兼有。
    }
}

为 status 参数提供了无效值： 

{
    "status_code": 400,
    "message": {
        Error: 'invlid_status_example' 不是有效状态。有效状态包括：open、remediated、risk_accepted、false_positive、needs_review。
    }
}

为 status_remarks 参数提供的值超过长度限制： 

{
    "status_code": 400,
    "message": {
        Error: status_remarks 不得超过2000个字符
    }
}

为 expires_at 参数提供的值无效： 

{
    "status_code": 400,
    "message": {
        Error: 日期格式无效。要求格式：'yyyy-mm-d-d'
    }
}

除非请求中包含 expires_at 参数且 status 参数被设置为 risk_accepted 值。 

{
    "status_code": 400,
    "message": {
        错误：只有'risk_accepted'状态可设置为过期。
    }
}
本节 :