GenerateInstallCommand - 生成安装agent命令--云安全中心-火山引擎

文档中心

立即注册

导航

GenerateInstallCommand - 生成安装agent命令

最近更新时间：2025.04.03 10:57:03首次发布时间：2025.04.03 10:57:03

生成安装agent命令

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GenerateInstallCommand	要执行的操作，取值：GenerateInstallCommand。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
AutoProtect	Boolean	否	true	AutoProtect
ExpireTime	Integer	否	1702090889	ExpireTime
HostEngine	Integer	否	16	HostEngine
GroupId	String	否	crl9aa73pfsdrned3gn0	GroupId
InstallationMethod	String	否	InstallationMethod	InstallationMethod
OS	String	否	linux	OS
ProxyName	String	否	ProxyName	ProxyName
CloudProvider	String	否	volc	CloudProvider

返回参数

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

参数	类型	示例值	描述
CloudProvider	String	volc	CloudProvider
HostEngine	Integer	17	HostEngine
AutoProtect	Boolean	true	AutoProtect
InstallationMethod	String	InstallationMethod	InstallationMethod
OS	String	linux	OS
GroupId	String	crl9aa73pfsdrned3gn0	GroupId
ProxyName	String	ProxyName	ProxyName
ExpireTime	Integer	1702090889	ExpireTime
GroupName	String	未分组	GroupName
Command	String	Command	Command
Id	String	66eac07353890101c02b3310	Id

请求示例

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

{
  "AutoProtect": true,
  "ExpireTime": 1702090889,
  "HostEngine": 1,
  "GroupId": "crl9aa73pfsdrned3gn0",
  "InstallationMethod": "direct",
  "OS": "linux",
  "ProxyName": "xxxx",
  "CloudProvider": "volc"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241210170450181010244213BC397E",
    "Action": "GenerateInstallCommand",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "HostEngine": 1,
    "CloudProvider": "volc",
    "ProxyName": "xxxx",
    "AutoProtect": true,
    "InstallationMethod": "direct",
    "OS": "linux",
    "GroupId": "crl9aa73pfsdrned3gn0",
    "ExpireTime": 1702090889,
    "Command": "xxxx",
    "Id": "66eac07353890101c02b3310"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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	数据库操作异常