跳至主内容

POST /cspm/vm/update

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

请求

格式 

{
  "status": "open",
  "status_remarks": "string",
  "expires_at": "2024-01-08",
  "severity": "informational",
  "severity_remarks": "string",
  "ids": [
    "string"
  ]
}

参数

参数

类型

可选

描述

状态

字符串

是*

更改所选检查项的状态。

可选值： 开放 , 已修复 , 风险已接受 , 误报 , 需复核 .

状态备注

字符串

是

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

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

注意

仅当请求中包含 状态 参数时，方可包含此参数。

到期时间

字符串

是

为新状态设置到期日期。到期后，检查项状态将变更为 待审核 .

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

注意

仅当请求中包含 状态 参数且其值为 风险已接受 时，才能使用此参数。

严重性

字符串

必填*

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

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

严重性备注

字符串

必填

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

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

注意

仅当请求中包含 严重性 参数时，才能包含此参数。

ids

字符串数组

否

需要修改的检查项ID列表。

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

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

*请求中必须包含 状态 和/或 严重性 参数中的至少一个。

示例

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

{
    "status": "remediated",
    "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 的状态更新为 risk_accepted ，并设置状态过期时间为 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 为 high : 

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

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

{
    "status_code": 400,
    "message": {
        错误: 检查ID数量不应超过规定的请求限制。限制:100/请求
    }
}

使用的检查ID无效： 

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

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

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

为 status 参数提供了无效值： 

{
    "status_code": 400,
    "message": {
        错误: 'invlid_status_example'不是有效状态。有效状态:open, remediated, risk_accepted, false_positive, needs_review。
    }
}

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

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

为 expires_at 参数提供的值无效： 

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

您不能使用 expires_at 参数不可使用，除非 status 参数包含在请求中并赋予 risk_accepted 值。 

{
    "status_code": 400,
    "message": {
        Error: 仅'risk_accepted'状态可设置过期时间。
    }
}
本节内容 :