调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GenerateInstallCommand	要执行的操作，取值：GenerateInstallCommand。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
GroupId	String	否	group-id-001	GroupId 标识值，可从对应资源列表接口获取
HostEngine	Long	否	1	主机来源类型：1=火山引擎内网主机，2=外部云/云外主机；外部云/云外主机需选择云厂商与安装方式
InstallationMethod	String	否	direct	客户端安装方式
OS	String	否	linux	操作系统名称
ProxyName	String	否	proxy-001	ProxyName 名称
AutoProtect	Boolean	否	true	AutoProtect 开关；true 表示开启，false 表示关闭
CloudProvider	String	否	volcengine	云厂商标识；未指定时默认使用火山引擎（volc）渠道
ExpireTime	Long	否	1789171200	安装命令过期时间，秒级 Unix 时间戳；不传（0）时默认取当前日期加 6 个自然月（超出当月天数时取当月最后一天）；传入值必须晚于当前时间

返回参数

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

参数	类型	示例值	描述
Command	String	ls -la	执行命令
GroupId	String	group-id-001	GroupId 标识值，可从对应资源列表接口获取
HostEngine	Long	1	主机防护引擎状态
Id	String	install-command-id-001	Id 标识值，可从对应资源列表接口获取
InstallationMethod	String	default	客户端安装方式
AutoProtect	Boolean	true	AutoProtect 开关；true 表示开启，false 表示关闭
CloudProvider	String	volcengine	云厂商标识
OS	String	linux	操作系统名称
ProxyName	String	example-name	ProxyName 名称
ExpireTime	Long	1789171200	安装命令过期时间，秒级 Unix 时间戳
GroupName	String	example-name	GroupName 名称

请求示例

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.10.30 14:06:15

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码