Data Types

Command

Information on commands.

Parameter Name	Type	Description
commandId	String	Command ID.
name	String	Command name.
description	String	Command note.
content	String	Script content.
type	CommandType	Script language type.
createTime	String	Creation time of command.
latestInvocationTime	String	Latest execution time.
tags	Tags	Tag of command
resourceGroup	ResourceGroupInfo	Resource group of command.

CommandInvocation

Information on execution of commands.

Parameter Name	Type	Description
invocationId	String	Execution ID.
commandId	String	Command ID.
commandName	String	Command name.
commandType	CommandType	Script language type.
content	String	Script content.
timeout	Integer	Execution timeout.
createTime	String	Execution creation time.
invocationStatus	InvocationStatus	Execution state.
invocationInstances	Array of InvocationInstance	Target instance list for command execution.

CommandType

Script language types.

Value	Description
SHELL	Shell script running on Linux instances.
POWERSHELL	PowerShell script running on Windows instances.
BAT	Bat script running on Windows instances.

InvocationInstance

Information on target instances for command execution.

Parameter Name	Type	Description
instanceId	String	Execution ID.
instanceName	String	Instance name.
instanceExist	Boolean	Whether the specified instance exists.
taskStatus	InvocationTaskStatus	Instance status of command execution.
exitCode	Integer	Exit code of command execution.
errorCode	InvocationTaskErrorCode	Error code of command execution.
output	String	Standard output (stdout) of command execution.
outputError	String	Standard input (stderr) of command execution.
execStartTime	String	Start time of command execution.
execEndTime	String	End time of command execution.

InvocationStatus

Command execution state.

Value	Description
Pending	Command executions are pending. All instance tasks are Pending.
Running	Command executions are running. All instance tasks are Running.
PartialFailed	Command executions are partially failed. All instance tasks completed with mixed results.
Failed	Command executions are failed. All instance tasks completed and failed.
Success	Command executions are succeeded. All instance tasks completed successfully.

InvocationTaskErrorCode

Information on error codes.

Value	Description
InstanceNotExists	Instance does not exist.
InstanceInstanceState	Instance is not running.
SystemError	System error. Execution pending.
CommandPlatformInvalid	Command type cannot be executed on this instance.
ExecutionTimeout	Script execution timed out.
ExecutionExitNoneZero	Script execution failed with non-zero exit code.

InvocationTaskStatus

Instance status of command execution.

Value	Description
Pending	Waiting for command execution.
Running	Command execution in progress.
Timeout	Command execution timed out.
Failed	Command execution failed with non-zero exit code.
Success	Command completed with exit code 0.
Error	Command execution failed due to system error or instance not running.

ResourceGroupInfo

Information on resource group, including resource group name and resource group ID.

Parameter Name	Type	Description
resourceGroupId	String	Resource group ID.
resourceGroupName	String	Resource group name.

Tag

Information on a tag, including its key and value.

Parameter Name	Type	Required	Description
key	String	Yes	Tag key. Length limit: 1 to 64 characters.
value	String	No	Tag value. Length limit: 1 to 64 characters.

TagAssociation

Information on tags bound to resources, including their keys and values.

Parameter Name	Type	Required	Description
tags	Array of Tag​	Yes	List of tags.

Tags

Information on tags, including their keys and values.

Parameter Name	Type	Description
tags	Array of Tag​​	List of tags.