You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_RASP
OperateAgentRaspConfigSwitch - 控制主机RASP配置开关
复制全文
下载 pdf
OperateAgentRaspConfigSwitch - 控制主机RASP配置开关

对指定 Agent 或进程开启、关闭 RASP 防护;相关 ID 可从 RASP 配置主机列表获取,Switch=true 开启、false 关闭。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

OperateAgentRaspConfigSwitch

要执行的操作,取值:OperateAgentRaspConfigSwitch。

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

TopGroupID
String
否

group-id-001

TopGroupID 标识值,可从对应资源列表接口获取

AgentIDs
Array of String
是

["agent-id-001"]

AgentIDs 标识值,可从对应资源列表接口获取

SwitchOn
Boolean
否

true

SwitchOn 开关;true 表示开启,false 表示关闭

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
Reason
String

example description

原因说明

Success
Boolean

true

操作是否成功;true 表示成功,false 表示失败

请求示例

POST /?Action=OperateAgentRaspConfigSwitch&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "AgentIDs": [
    "agent-id-001"
  ],
  "SwitchOn": true,
  "TopGroupID": "group-id-001"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "OperateAgentRaspConfigSwitch",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Reason": "example description",
    "Success": true
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.08.21 20:38:54
这个页面对您有帮助吗?
有用
有用
无用
无用