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

云安全中心

复制全文
下载 pdf
HIDS_AGENT
UninstallAgentClient - 卸载Agent
复制全文
下载 pdf
UninstallAgentClient - 卸载Agent

向指定已纳管主机下发 Agent 卸载任务;Agent ID 可从主机资产列表获取,可选参数不传时按默认卸载方式执行,返回任务及执行信息。

调试

请求参数

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

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

UninstallAgentClient

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

Version
String
是

2024-05-08

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

Type
String
是

disable

必填,卸载类型:disable 停用防护、cleanup 清理记录

AgentIDs
Array of String
是

["agent-id-001"]

必填,要卸载的 Agent ID 列表,可从主机资产列表获取,单次最多 500 个

Reasons
Array of String
否

["不需要了"]

可选,执行卸载的原因列表;不传时不记录结构化原因

Suggestion
String
否

--

可选,补充建议或说明;不传时为空字符串

返回参数

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

参数
类型
示例值
描述
SuccessCount
Long

1

操作成功的主机数量

Detail
Array of Object

--

每台主机的安装或卸载执行结果

FailureCount
Long

0

操作失败的主机数量

请求示例

POST /?Action=UninstallAgentClient&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"
  ],
  "Reasons": [
    "不需要了"
  ],
  "Suggestion": "--",
  "Type": "disable"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "UninstallAgentClient",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Detail": [
      {
        "AgentID": "agent-id-001",
        "Code": 0,
        "Msg": "--"
      }
    ],
    "FailureCount": 0,
    "SuccessCount": 1
  }
}

错误码

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

状态码
错误码
错误信息
说明
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.

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

403
OperationDenied.TenantUnauthorized(%s)

The request has failed due to tenant not found(%s)

未授权的租户操作

500
InternalError

The request has failed due to an unknown error.

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

500
DBOperateError

The request has failed because database return error: %s

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

最近更新时间:2026.10.30 14:06:16
这个页面对您有帮助吗?
有用
有用
无用
无用