getCommand

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getCommand

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCommand(args: GetCommandArgs, opts?: InvokeOptions): Promise<GetCommandResult>
function getCommandOutput(args: GetCommandOutputArgs, opts?: InvokeOptions): Output<GetCommandResult>

def get_command(id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetCommandResult
def get_command_output(id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetCommandResult]

func LookupCommand(ctx *Context, args *LookupCommandArgs, opts ...InvokeOption) (*LookupCommandResult, error)
func LookupCommandOutput(ctx *Context, args *LookupCommandOutputArgs, opts ...InvokeOption) LookupCommandResultOutput

> Note: This function is named LookupCommand in the Go SDK.

public static class GetCommand 
{
    public static Task<GetCommandResult> InvokeAsync(GetCommandArgs args, InvokeOptions? opts = null)
    public static Output<GetCommandResult> Invoke(GetCommandInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCommandResult> getCommand(GetCommandArgs args, InvokeOptions options)
public static Output<GetCommandResult> getCommand(GetCommandArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:ecs/getCommand:getCommand
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getCommand Result

The following output properties are available:

CommandContent string: 命令内容。请根据ContentEncoding参数传入相应命令内容。命令内容不能超过16KB。
CommandId string: 自定义命令ID。
ContentEncoding string: 命令内容是否经过Base64编码处理。Base64（默认）：经过Base64编码处理。PlainText：未进行编码处理。
CreatedTime string: 创建时间。
Description string: 命令描述，默认为空字符串。字符长度0~256。不限制特殊字符。
EnableParameter bool: 创建的命令是否使用自定义参数。false：默认，表示不使用自定义参数。true：表示使用自定义参数。
Id string: Uniquely identifies the resource.
InvocationTimes int: 命令被调用次数。
Name string: 命令名称。字符长度1~32。不限制特殊字符。
ParameterDefinitions List<Byteplus.GetCommandParameterDefinition>: 自定义参数定义信息。
ProjectName string: 资源所属项目，一个资源只能归属于一个项目。
ProviderName string: 命令的提供方。
Tags List<Byteplus.GetCommandTag>: 标签键值对。
Timeout int: 创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。
Type string: 命令的类型。Shell：表示创建一个在Linux实例中运行的Shell脚本。Python：表示创建一个Python脚本。Bat：表示创建一个Bat脚本。PowerShell：表示创建一个PowerShell脚本。
UpdatedTime string: 更新时间。
Username string: 执行命令时的用户名。
WorkingDir string: 创建的命令在ECS实例中运行的目录。

CommandContent string: 命令内容。请根据ContentEncoding参数传入相应命令内容。命令内容不能超过16KB。
CommandId string: 自定义命令ID。
ContentEncoding string: 命令内容是否经过Base64编码处理。Base64（默认）：经过Base64编码处理。PlainText：未进行编码处理。
CreatedTime string: 创建时间。
Description string: 命令描述，默认为空字符串。字符长度0~256。不限制特殊字符。
EnableParameter bool: 创建的命令是否使用自定义参数。false：默认，表示不使用自定义参数。true：表示使用自定义参数。
Id string: Uniquely identifies the resource.
InvocationTimes int: 命令被调用次数。
Name string: 命令名称。字符长度1~32。不限制特殊字符。
ParameterDefinitions []GetCommandParameterDefinition: 自定义参数定义信息。
ProjectName string: 资源所属项目，一个资源只能归属于一个项目。
ProviderName string: 命令的提供方。
Tags []GetCommandTag: 标签键值对。
Timeout int: 创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。
Type string: 命令的类型。Shell：表示创建一个在Linux实例中运行的Shell脚本。Python：表示创建一个Python脚本。Bat：表示创建一个Bat脚本。PowerShell：表示创建一个PowerShell脚本。
UpdatedTime string: 更新时间。
Username string: 执行命令时的用户名。
WorkingDir string: 创建的命令在ECS实例中运行的目录。

commandContent String: 命令内容。请根据ContentEncoding参数传入相应命令内容。命令内容不能超过16KB。
commandId String: 自定义命令ID。
contentEncoding String: 命令内容是否经过Base64编码处理。Base64（默认）：经过Base64编码处理。PlainText：未进行编码处理。
createdTime String: 创建时间。
description String: 命令描述，默认为空字符串。字符长度0~256。不限制特殊字符。
enableParameter Boolean: 创建的命令是否使用自定义参数。false：默认，表示不使用自定义参数。true：表示使用自定义参数。
id String: Uniquely identifies the resource.
invocationTimes Integer: 命令被调用次数。
name String: 命令名称。字符长度1~32。不限制特殊字符。
parameterDefinitions List<GetCommandParameterDefinition>: 自定义参数定义信息。
projectName String: 资源所属项目，一个资源只能归属于一个项目。
providerName String: 命令的提供方。
tags List<GetCommandTag>: 标签键值对。
timeout Integer: 创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。
type String: 命令的类型。Shell：表示创建一个在Linux实例中运行的Shell脚本。Python：表示创建一个Python脚本。Bat：表示创建一个Bat脚本。PowerShell：表示创建一个PowerShell脚本。
updatedTime String: 更新时间。
username String: 执行命令时的用户名。
workingDir String: 创建的命令在ECS实例中运行的目录。

commandContent string: 命令内容。请根据ContentEncoding参数传入相应命令内容。命令内容不能超过16KB。
commandId string: 自定义命令ID。
contentEncoding string: 命令内容是否经过Base64编码处理。Base64（默认）：经过Base64编码处理。PlainText：未进行编码处理。
createdTime string: 创建时间。
description string: 命令描述，默认为空字符串。字符长度0~256。不限制特殊字符。
enableParameter boolean: 创建的命令是否使用自定义参数。false：默认，表示不使用自定义参数。true：表示使用自定义参数。
id string: Uniquely identifies the resource.
invocationTimes number: 命令被调用次数。
name string: 命令名称。字符长度1~32。不限制特殊字符。
parameterDefinitions GetCommandParameterDefinition[]: 自定义参数定义信息。
projectName string: 资源所属项目，一个资源只能归属于一个项目。
providerName string: 命令的提供方。
tags GetCommandTag[]: 标签键值对。
timeout number: 创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。
type string: 命令的类型。Shell：表示创建一个在Linux实例中运行的Shell脚本。Python：表示创建一个Python脚本。Bat：表示创建一个Bat脚本。PowerShell：表示创建一个PowerShell脚本。
updatedTime string: 更新时间。
username string: 执行命令时的用户名。
workingDir string: 创建的命令在ECS实例中运行的目录。

command_content str: 命令内容。请根据ContentEncoding参数传入相应命令内容。命令内容不能超过16KB。
command_id str: 自定义命令ID。
content_encoding str: 命令内容是否经过Base64编码处理。Base64（默认）：经过Base64编码处理。PlainText：未进行编码处理。
created_time str: 创建时间。
description str: 命令描述，默认为空字符串。字符长度0~256。不限制特殊字符。
enable_parameter bool: 创建的命令是否使用自定义参数。false：默认，表示不使用自定义参数。true：表示使用自定义参数。
id str: Uniquely identifies the resource.
invocation_times int: 命令被调用次数。
name str: 命令名称。字符长度1~32。不限制特殊字符。
parameter_definitions Sequence[GetCommandParameterDefinition]: 自定义参数定义信息。
project_name str: 资源所属项目，一个资源只能归属于一个项目。
provider_name str: 命令的提供方。
tags Sequence[GetCommandTag]: 标签键值对。
timeout int: 创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。
type str: 命令的类型。Shell：表示创建一个在Linux实例中运行的Shell脚本。Python：表示创建一个Python脚本。Bat：表示创建一个Bat脚本。PowerShell：表示创建一个PowerShell脚本。
updated_time str: 更新时间。
username str: 执行命令时的用户名。
working_dir str: 创建的命令在ECS实例中运行的目录。

commandContent String: 命令内容。请根据ContentEncoding参数传入相应命令内容。命令内容不能超过16KB。
commandId String: 自定义命令ID。
contentEncoding String: 命令内容是否经过Base64编码处理。Base64（默认）：经过Base64编码处理。PlainText：未进行编码处理。
createdTime String: 创建时间。
description String: 命令描述，默认为空字符串。字符长度0~256。不限制特殊字符。
enableParameter Boolean: 创建的命令是否使用自定义参数。false：默认，表示不使用自定义参数。true：表示使用自定义参数。
id String: Uniquely identifies the resource.
invocationTimes Number: 命令被调用次数。
name String: 命令名称。字符长度1~32。不限制特殊字符。
parameterDefinitions List<Property Map>: 自定义参数定义信息。
projectName String: 资源所属项目，一个资源只能归属于一个项目。
providerName String: 命令的提供方。
tags List<Property Map>: 标签键值对。
timeout Number: 创建的命令在ECS实例中执行时最大的超时时间，单位为秒。取值范围：30~86400。默认值：60。
type String: 命令的类型。Shell：表示创建一个在Linux实例中运行的Shell脚本。Python：表示创建一个Python脚本。Bat：表示创建一个Bat脚本。PowerShell：表示创建一个PowerShell脚本。
updatedTime String: 更新时间。
username String: 执行命令时的用户名。
workingDir String: 创建的命令在ECS实例中运行的目录。

Supporting Types

GetCommandParameterDefinition

DecimalPrecision int: 自定义参数值（数字）允许的小数点后位数。
DefaultValue string: 自定义参数默认值。
MaxLength int: 自定义参数值（字符串）的最大长度。
MaxValue string: 自定义参数值（数字）的最大值。
MinLength int: 自定义参数值（字符串）的最小长度。
MinValue string: 自定义参数值（数字）的最小值。
Name string: 自定义参数名称，需要在脚本中通过{{Param}}定义。单个参数名不能超过64字节。遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
Required bool: 是否必填。
Type string: 自定义参数类型。取值：String：表示自定义参数类型为String（字符串）类型。Digit：表示自定义参数类型为Digit（数值）类型。

DecimalPrecision int: 自定义参数值（数字）允许的小数点后位数。
DefaultValue string: 自定义参数默认值。
MaxLength int: 自定义参数值（字符串）的最大长度。
MaxValue string: 自定义参数值（数字）的最大值。
MinLength int: 自定义参数值（字符串）的最小长度。
MinValue string: 自定义参数值（数字）的最小值。
Name string: 自定义参数名称，需要在脚本中通过{{Param}}定义。单个参数名不能超过64字节。遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
Required bool: 是否必填。
Type string: 自定义参数类型。取值：String：表示自定义参数类型为String（字符串）类型。Digit：表示自定义参数类型为Digit（数值）类型。

decimalPrecision Integer: 自定义参数值（数字）允许的小数点后位数。
defaultValue String: 自定义参数默认值。
maxLength Integer: 自定义参数值（字符串）的最大长度。
maxValue String: 自定义参数值（数字）的最大值。
minLength Integer: 自定义参数值（字符串）的最小长度。
minValue String: 自定义参数值（数字）的最小值。
name String: 自定义参数名称，需要在脚本中通过{{Param}}定义。单个参数名不能超过64字节。遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
required Boolean: 是否必填。
type String: 自定义参数类型。取值：String：表示自定义参数类型为String（字符串）类型。Digit：表示自定义参数类型为Digit（数值）类型。

decimalPrecision number: 自定义参数值（数字）允许的小数点后位数。
defaultValue string: 自定义参数默认值。
maxLength number: 自定义参数值（字符串）的最大长度。
maxValue string: 自定义参数值（数字）的最大值。
minLength number: 自定义参数值（字符串）的最小长度。
minValue string: 自定义参数值（数字）的最小值。
name string: 自定义参数名称，需要在脚本中通过{{Param}}定义。单个参数名不能超过64字节。遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
required boolean: 是否必填。
type string: 自定义参数类型。取值：String：表示自定义参数类型为String（字符串）类型。Digit：表示自定义参数类型为Digit（数值）类型。

decimal_precision int: 自定义参数值（数字）允许的小数点后位数。
default_value str: 自定义参数默认值。
max_length int: 自定义参数值（字符串）的最大长度。
max_value str: 自定义参数值（数字）的最大值。
min_length int: 自定义参数值（字符串）的最小长度。
min_value str: 自定义参数值（数字）的最小值。
name str: 自定义参数名称，需要在脚本中通过{{Param}}定义。单个参数名不能超过64字节。遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
required bool: 是否必填。
type str: 自定义参数类型。取值：String：表示自定义参数类型为String（字符串）类型。Digit：表示自定义参数类型为Digit（数值）类型。

decimalPrecision Number: 自定义参数值（数字）允许的小数点后位数。
defaultValue String: 自定义参数默认值。
maxLength Number: 自定义参数值（字符串）的最大长度。
maxValue String: 自定义参数值（数字）的最大值。
minLength Number: 自定义参数值（字符串）的最小长度。
minValue String: 自定义参数值（数字）的最小值。
name String: 自定义参数名称，需要在脚本中通过{{Param}}定义。单个参数名不能超过64字节。遵循Shell变量命名规则，a-zA-Z0-9-_的组合。首个字符不能以数字开头。中间不能有空格，可以使用下划线。
required Boolean: 是否必填。
type String: 自定义参数类型。取值：String：表示自定义参数类型为String（字符串）类型。Digit：表示自定义参数类型为Digit（数值）类型。

GetCommandTag

Key string: 用户标签的标签键。命名规则如下：不能以volc:或sys:的任意大小写组合开头。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
Value string: 用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

Key string: 用户标签的标签键。命名规则如下：不能以volc:或sys:的任意大小写组合开头。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
Value string: 用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key String: 用户标签的标签键。命名规则如下：不能以volc:或sys:的任意大小写组合开头。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value String: 用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key string: 用户标签的标签键。命名规则如下：不能以volc:或sys:的任意大小写组合开头。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value string: 用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key str: 用户标签的标签键。命名规则如下：不能以volc:或sys:的任意大小写组合开头。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value str: 用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key String: 用户标签的标签键。命名规则如下：不能以volc:或sys:的任意大小写组合开头。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value String: 用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。