百度智能云

搜索本产品文档关键词

所有文档

没有找到结果，请重新输入

云服务器 BCC

附录

更新时间：2026-07-28

Model对象定义

Action

参数名称	类型	是否必需	描述
id	String	否	命令ID，系统自动生成，仅被保存的命令拥有，创建命令时无需填写
ref	String	否	Action ID，仅用于更新命令接口。通常引用已有的 Action ID，例如命令执行场景（命令列表查询不返回）
type	String	是	Action类型。COMMAND（命令），FILE_UPLOAD（上传文件）
name	String	是	命令名称，仅被保存的命令拥有
alias	String	否	Action 别名
description	String	否	Action 描述
timeoutSecond	int	是	动作的超时时间（秒）
command	Command	否	命令详情，当type=COMMAND时，此为必填项
fileUpload	FileUpload	否	文件上传详情，当type=FILE_UPLOAD时，此为必填项
supportedInstanceTypes	List<String>	否	此公共命令支持的实例类型列表，根据命令创建执行时，根据此字段确定展示那些实例列表，目前支持：BCC、BBC、HPAS
createdTimestamp	long	否	命令创建时间。unix时间戳（毫秒）
updatedTimestamp	long	否	命令最后一次被修改时间。unix时间戳（毫秒）

ActionFilter

参数名称	类型	是否必需	描述
id	String	否	命令 ID，仅用来查询执行历史记录，例如：c-jPwwUBxxxxxxxxxx
name	String	否	命令名称，仅用来查询执行历史记录
type	String	是	Action类型。COMMAND（命令），FILE_UPLOAD（上传文件）
command	CommandFilter	否	执行命令相关过滤条件
fileUpload	FileUploadFilter	否	上传文件相关过滤条件

ActionPage

参数名称	类型	描述
pageNo	int	页码
pageSize	int	页大小
totalCount	int	总数
data	List<Action>	命令列表

ActionRef

参数名称	类型	是否必需	描述
ref	String	是	命令ID，创建执行时必须指定引用的那个命令

ActionResult

参数名称	类型	是否必需	描述
actionId	String	否	命令id
actionName	String	是	命令名称，保存命令的时候返回
runId	String	否	执行id，仅在命令执行时返回

ActionRun

参数名称	类型	描述
id	String	执行ID
state	String	执行状态。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行成功），PARTIAL_FAILED（部分成功），PENDING（等待中）
action	Action
createdTimestamp	long	执行开始时间。unix时间戳，单位：毫秒
finishedTimestamp	long	执行结束时间，仅执行结束时返回
statistics	Statistics	子执行执行情况，仅查询执行记录列表时返回
children	List<ChildRun>	子执行列表，读取详情时，响应此字段
totalCount	int	子执行总数，读取详情时，响应此字段

ActionRunPage

参数名称	类型	描述
pageNo	int	页码
pageSize	int	页大小
totalCount	int	总数
data	List<ActionRun>	执行记录

Agent

参数名称	类型	描述
host	Host	实例信息
state	String	bsm-agent状态。枚举值：ONLINE（在线），OFFLINE（离线）
version	String	bsm-agent版本号，如4.2.0.1

ChildRun

参数名称	类型	描述
id	String	子执行ID
state	String	执行状态。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行成功），PARTIAL_FAILED（部分成功），PENDING（等待中）
target	Map<String, String>	子执行对应的实例信息
createdTimestamp	long	子执行开始时间。unix时间戳，单位：毫秒
finishedTimestamp	long	子执行结束时间，仅执行结束时返回。unix时间戳，单位：毫秒。
output	Output	命令输出结果
log	String	子执行日志内容，仅当请求参数 withLog=true 时返回
errorCode	String	错误码
failReason	String	子执行失败原因

Command

参数名称	类型	是否必需	描述
type	String	是	脚本类型
content	String	是	命令脚本内容
scope	String	否	命令可见范围。GLOBAL公共命令，INDIVIDUAL个人命令
enableParameter	Boolean	否	命令是否包含参数
parameters	List<Parameter>	否	命令参数列表
user	String	是	命令在虚机的执行用户
workDir	String	是	命令在虚机的执行路径
execParams	Map<String, String>	否	命令执行时的实际参数值，仅在查询 ActionRun 详情时返回
waitOnAgentMilli	int	否	Agent等待时间（毫秒）

CommandFilter

参数名称	类型	是否必需	描述
scope	String	否	按命令可见范围筛选。枚举值：INDIVIDUAL（个人命令），GLOBAL（公共命令）。注意：查询执行记录时此字段无效
name	String	否	按命令名称筛选。注意：查询执行记录时此字段无效
type	String	是	按命令类型筛选。枚举值：SHELL，POWERSHELL

FileUpload

参数名称	类型	是否必需	描述
os	String	是	操作系统。枚举值：LINUX，WINDOWS
content	String	否	文件内容
filename	String	是	文件名称
filepath	String	是	目标路径
bosBucketName	String	是	bos桶名称
bosFilePath	String	是	bos文件路径
bosEtag	String	是	文件唯一标识符
user	String	否	用户，仅Linux文件上传需要
group	String	否	用户组，仅Linux文件上传需要
mode	String	否	文件权限，仅Linux文件上传需要
overwrite	Boolean	是	是否覆盖目标路径下的同名文件

FileUploadFilter

参数名称	类型	描述
filename	String	上传的文件名称

Host

参数名称	类型	描述
instanceId	String	实例id，如bcc实例id: i-gVGDt***

Log

参数名称	类型	描述
msg	String	命令执行日志

LogResult

参数名称	类型	描述
logs	List<Log>	日志内容，顺序排列
nextCursor	int	下一次请求使用的cursor。若子执行已结束，且nextCursor=cursor，表示已无更多日志。否则，表示可能存在更多日志
state	String	执行状态。枚举值：FAILED（执行失败），RUNNING（执行中），SUCCESS（执行成功），PARTIAL_FAILED（部分成功），PENDING（等待中）
childId	String	子执行id

Output

参数名称	类型	描述
exitCode	int	退出码
stderr	String	标准错误
stdout	String	标准输出
isTruncated	Boolean	标准输出或标准错误是否由于过长（超过4KB）而被截断

Parameter

参数名称	类型	是否必需	描述
name	String	是	参数名称
desc	String	否	参数描述
required	Boolean	否	是否必填
defaultValue	String	否	默认值

Statistics

参数名称	类型	描述
totalTargetCount	long	执行的实例总数
failedTargetCount	long	已失败的执行实例总数

Tag

参数名称	类型	描述
tagKey	String	标签 key
tagValue	String	标签 value

Target

参数名称	类型	是否必需	描述
instanceType	String	是	实例类型。枚举值：BCC，BBC，HPAS
instanceId	String	是	实例ID
instanceName	String	否	实例名称
internalIp	String	否	内网IP
externalIp	String	否	外网IP
bandwidth	String	否	带宽

TargetImport

参数名称	类型	描述
keywordType	String	实例列表导入类型。枚举值：instanceId（通过实例ID导入），internalIp表示（通过实例内网导入）
instances	List<String>	实例清单列表

TargetSelector

参数名称	类型	是否必需	描述
instanceType	String	是	实例类型。枚举值：BCC，BBC，HPAS
tags	List<Tag>	否	实例标签列表
importInstances	TargetImport	否

类型编码定义

TargetSelectorType

编码	描述
INSTANCES_LIST	实例列表
ALL_INSTANCES	全部实例
TAG_INSTANCES	实例标签选择
INSTANCES_IMPORT	实例列表导入

评价此篇文章

有帮助没帮助

命令相关接口

BsmAgent相关接口