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

云安全中心

复制全文
下载 pdf
HIDS_AGENT
GenerateInstallCommand - 生成安装agent命令
复制全文
下载 pdf
GenerateInstallCommand - 生成安装agent命令

按操作系统、架构、安装范围和有效期生成 Agent 安装命令;关联分组等 ID 可从资产分组接口获取,可选字段不传时采用业务默认配置,返回命令内容及命令 ID。

调试

请求参数

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

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

GenerateInstallCommand

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

Version
String
是

2024-05-08

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

AutoProtect
Boolean
否

true

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

ExpireTime
Long
否

1789171200

安装命令过期时间,秒级 Unix 时间戳;必须晚于当前时间

HostEngine
Long
否

1

主机防护引擎状态

GroupId
String
否

group-id-001

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

InstallationMethod
String
否

direct

客户端安装方式

OS
String
否

linux

操作系统名称

ProxyName
String
否

proxy-001

ProxyName 名称

CloudProvider
String
否

volcengine

云厂商标识

返回参数

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

参数
类型
示例值
描述
ExpireTime
Long

1789171200

安装命令过期时间,秒级 Unix 时间戳

GroupName
String

example-name

GroupName 名称

HostEngine
Long

1

主机防护引擎状态

Id
String

install-command-id-001

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

Command
String

ls -la

执行命令

GroupId
String

group-id-001

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

InstallationMethod
String

default

客户端安装方式

OS
String

linux

操作系统名称

ProxyName
String

example-name

ProxyName 名称

AutoProtect
Boolean

true

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

CloudProvider
String

volcengine

云厂商标识

请求示例

POST /?Action=GenerateInstallCommand&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

{
  "AutoProtect": true,
  "CloudProvider": "volcengine",
  "ExpireTime": 1789171200,
  "GroupId": "group-id-001",
  "HostEngine": 1,
  "InstallationMethod": "direct",
  "OS": "linux",
  "ProxyName": "proxy-001"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GenerateInstallCommand",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "AutoProtect": true,
    "CloudProvider": "volcengine",
    "Command": "ls -la",
    "ExpireTime": 1789171200,
    "GroupId": "group-id-001",
    "GroupName": "example-name",
    "HostEngine": 1,
    "Id": "install-command-id-001",
    "InstallationMethod": "default",
    "OS": "linux",
    "ProxyName": "example-name"
  }
}

错误码

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

状态码
错误码
错误信息
说明
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:30:50
这个页面对您有帮助吗?
有用
有用
无用
无用