getCommands

Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const default = volcengine.ecs.getCommands({
    commandId: "cmd-ychkepkhtim0tr3b****",
});

import pulumi
import pulumi_volcengine as volcengine

default = volcengine.ecs.get_commands(command_id="cmd-ychkepkhtim0tr3b****")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecs.GetCommands(ctx, &ecs.GetCommandsArgs{
			CommandId: pulumi.StringRef("cmd-ychkepkhtim0tr3b****"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Ecs.GetCommands.Invoke(new()
    {
        CommandId = "cmd-ychkepkhtim0tr3b****",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetCommandsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = EcsFunctions.getCommands(GetCommandsArgs.builder()
            .commandId("cmd-ychkepkhtim0tr3b****")
            .build());

    }
}

variables:
  default:
    fn::invoke:
      Function: volcengine:ecs:getCommands
      Arguments:
        commandId: cmd-ychkepkhtim0tr3b****

Using getCommands

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 getCommands(args: GetCommandsArgs, opts?: InvokeOptions): Promise<GetCommandsResult>
function getCommandsOutput(args: GetCommandsOutputArgs, opts?: InvokeOptions): Output<GetCommandsResult>

def get_commands(command_id: Optional[str] = None,
                 command_provider: Optional[str] = None,
                 name: Optional[str] = None,
                 name_regex: Optional[str] = None,
                 order: Optional[str] = None,
                 output_file: Optional[str] = None,
                 project_name: Optional[str] = None,
                 tags: Optional[Sequence[GetCommandsTag]] = None,
                 type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetCommandsResult
def get_commands_output(command_id: Optional[pulumi.Input[str]] = None,
                 command_provider: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 name_regex: Optional[pulumi.Input[str]] = None,
                 order: Optional[pulumi.Input[str]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 project_name: Optional[pulumi.Input[str]] = None,
                 tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetCommandsTagArgs]]]] = None,
                 type: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetCommandsResult]

func GetCommands(ctx *Context, args *GetCommandsArgs, opts ...InvokeOption) (*GetCommandsResult, error)
func GetCommandsOutput(ctx *Context, args *GetCommandsOutputArgs, opts ...InvokeOption) GetCommandsResultOutput

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

public static class GetCommands 
{
    public static Task<GetCommandsResult> InvokeAsync(GetCommandsArgs args, InvokeOptions? opts = null)
    public static Output<GetCommandsResult> Invoke(GetCommandsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCommandsResult> getCommands(GetCommandsArgs args, InvokeOptions options)
public static Output<GetCommandsResult> getCommands(GetCommandsArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:ecs/getCommands:getCommands
  arguments:
    # arguments dictionary

The following arguments are supported:

CommandId string: The id of ecs command.
CommandProvider string: The provider of public command. When this field is not specified, query for custom commands.
Name string: The name of ecs command. This field support fuzzy query.
NameRegex string: A Name Regex of Resource.
Order string: The order of ecs command query result.
OutputFile string: File name where to save data source results.
ProjectName string: The project name of ecs command.
Tags List<GetCommandsTag>: Tags.
Type string: The type of ecs command. Valid values: Shell.

CommandId string: The id of ecs command.
CommandProvider string: The provider of public command. When this field is not specified, query for custom commands.
Name string: The name of ecs command. This field support fuzzy query.
NameRegex string: A Name Regex of Resource.
Order string: The order of ecs command query result.
OutputFile string: File name where to save data source results.
ProjectName string: The project name of ecs command.
Tags []GetCommandsTag: Tags.
Type string: The type of ecs command. Valid values: Shell.

commandId String: The id of ecs command.
commandProvider String: The provider of public command. When this field is not specified, query for custom commands.
name String: The name of ecs command. This field support fuzzy query.
nameRegex String: A Name Regex of Resource.
order String: The order of ecs command query result.
outputFile String: File name where to save data source results.
projectName String: The project name of ecs command.
tags List<GetCommandsTag>: Tags.
type String: The type of ecs command. Valid values: Shell.

commandId string: The id of ecs command.
commandProvider string: The provider of public command. When this field is not specified, query for custom commands.
name string: The name of ecs command. This field support fuzzy query.
nameRegex string: A Name Regex of Resource.
order string: The order of ecs command query result.
outputFile string: File name where to save data source results.
projectName string: The project name of ecs command.
tags GetCommandsTag[]: Tags.
type string: The type of ecs command. Valid values: Shell.

command_id str: The id of ecs command.
command_provider str: The provider of public command. When this field is not specified, query for custom commands.
name str: The name of ecs command. This field support fuzzy query.
name_regex str: A Name Regex of Resource.
order str: The order of ecs command query result.
output_file str: File name where to save data source results.
project_name str: The project name of ecs command.
tags Sequence[GetCommandsTag]: Tags.
type str: The type of ecs command. Valid values: Shell.

commandId String: The id of ecs command.
commandProvider String: The provider of public command. When this field is not specified, query for custom commands.
name String: The name of ecs command. This field support fuzzy query.
nameRegex String: A Name Regex of Resource.
order String: The order of ecs command query result.
outputFile String: File name where to save data source results.
projectName String: The project name of ecs command.
tags List<Property Map>: Tags.
type String: The type of ecs command. Valid values: Shell.

getCommands Result

The following output properties are available:

Commands List<GetCommandsCommand>: The collection of query.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
CommandId string: The id of the ecs command.
CommandProvider string: The provider of the public command.
Name string: The name of the custom parameter.
NameRegex string
Order string
OutputFile string
ProjectName string: The project name of the ecs command.
Tags List<GetCommandsTag>: Tags.
Type string: The type of the ecs command.

Commands []GetCommandsCommand: The collection of query.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
CommandId string: The id of the ecs command.
CommandProvider string: The provider of the public command.
Name string: The name of the custom parameter.
NameRegex string
Order string
OutputFile string
ProjectName string: The project name of the ecs command.
Tags []GetCommandsTag: Tags.
Type string: The type of the ecs command.

commands List<GetCommandsCommand>: The collection of query.
id String: The provider-assigned unique ID for this managed resource.
totalCount Integer: The total count of query.
commandId String: The id of the ecs command.
commandProvider String: The provider of the public command.
name String: The name of the custom parameter.
nameRegex String
order String
outputFile String
projectName String: The project name of the ecs command.
tags List<GetCommandsTag>: Tags.
type String: The type of the ecs command.

commands GetCommandsCommand[]: The collection of query.
id string: The provider-assigned unique ID for this managed resource.
totalCount number: The total count of query.
commandId string: The id of the ecs command.
commandProvider string: The provider of the public command.
name string: The name of the custom parameter.
nameRegex string
order string
outputFile string
projectName string: The project name of the ecs command.
tags GetCommandsTag[]: Tags.
type string: The type of the ecs command.

commands Sequence[GetCommandsCommand]: The collection of query.
id str: The provider-assigned unique ID for this managed resource.
total_count int: The total count of query.
command_id str: The id of the ecs command.
command_provider str: The provider of the public command.
name str: The name of the custom parameter.
name_regex str
order str
output_file str
project_name str: The project name of the ecs command.
tags Sequence[GetCommandsTag]: Tags.
type str: The type of the ecs command.

commands List<Property Map>: The collection of query.
id String: The provider-assigned unique ID for this managed resource.
totalCount Number: The total count of query.
commandId String: The id of the ecs command.
commandProvider String: The provider of the public command.
name String: The name of the custom parameter.
nameRegex String
order String
outputFile String
projectName String: The project name of the ecs command.
tags List<Property Map>: Tags.
type String: The type of the ecs command.

Supporting Types

GetCommandsCommand

CommandContent string: The base64 encoded content of the ecs command.
CommandId string: The id of ecs command.
CommandProvider string: The provider of public command. When this field is not specified, query for custom commands.
ContentEncoding string: Whether the command content is base64 encoded. Valid values: Base64, PlainText. Default is Base64.
CreatedAt string: The create time of the ecs command.
Description string: The description of the ecs command.
EnableParameter bool: Whether to enable custom parameter. Default is false.
Id string: The id of the ecs command.
InvocationTimes int: The invocation times of the ecs command. Public commands do not display the invocation times.
Name string: The name of ecs command. This field support fuzzy query.
ParameterDefinitions List<GetCommandsCommandParameterDefinition>: The custom parameter definitions of the ecs command.
ProjectName string: The project name of ecs command.
Tags List<GetCommandsCommandTag>: Tags.
Timeout int: The timeout of the ecs command.
Type string: The type of ecs command. Valid values: Shell.
UpdatedAt string: The update time of the ecs command.
Username string: The username of the ecs command.
WorkingDir string: The working directory of the ecs command.

CommandContent string: The base64 encoded content of the ecs command.
CommandId string: The id of ecs command.
CommandProvider string: The provider of public command. When this field is not specified, query for custom commands.
ContentEncoding string: Whether the command content is base64 encoded. Valid values: Base64, PlainText. Default is Base64.
CreatedAt string: The create time of the ecs command.
Description string: The description of the ecs command.
EnableParameter bool: Whether to enable custom parameter. Default is false.
Id string: The id of the ecs command.
InvocationTimes int: The invocation times of the ecs command. Public commands do not display the invocation times.
Name string: The name of ecs command. This field support fuzzy query.
ParameterDefinitions []GetCommandsCommandParameterDefinition: The custom parameter definitions of the ecs command.
ProjectName string: The project name of ecs command.
Tags []GetCommandsCommandTag: Tags.
Timeout int: The timeout of the ecs command.
Type string: The type of ecs command. Valid values: Shell.
UpdatedAt string: The update time of the ecs command.
Username string: The username of the ecs command.
WorkingDir string: The working directory of the ecs command.

commandContent String: The base64 encoded content of the ecs command.
commandId String: The id of ecs command.
commandProvider String: The provider of public command. When this field is not specified, query for custom commands.
contentEncoding String: Whether the command content is base64 encoded. Valid values: Base64, PlainText. Default is Base64.
createdAt String: The create time of the ecs command.
description String: The description of the ecs command.
enableParameter Boolean: Whether to enable custom parameter. Default is false.
id String: The id of the ecs command.
invocationTimes Integer: The invocation times of the ecs command. Public commands do not display the invocation times.
name String: The name of ecs command. This field support fuzzy query.
parameterDefinitions List<GetCommandsCommandParameterDefinition>: The custom parameter definitions of the ecs command.
projectName String: The project name of ecs command.
tags List<GetCommandsCommandTag>: Tags.
timeout Integer: The timeout of the ecs command.
type String: The type of ecs command. Valid values: Shell.
updatedAt String: The update time of the ecs command.
username String: The username of the ecs command.
workingDir String: The working directory of the ecs command.

commandContent string: The base64 encoded content of the ecs command.
commandId string: The id of ecs command.
commandProvider string: The provider of public command. When this field is not specified, query for custom commands.
contentEncoding string: Whether the command content is base64 encoded. Valid values: Base64, PlainText. Default is Base64.
createdAt string: The create time of the ecs command.
description string: The description of the ecs command.
enableParameter boolean: Whether to enable custom parameter. Default is false.
id string: The id of the ecs command.
invocationTimes number: The invocation times of the ecs command. Public commands do not display the invocation times.
name string: The name of ecs command. This field support fuzzy query.
parameterDefinitions GetCommandsCommandParameterDefinition[]: The custom parameter definitions of the ecs command.
projectName string: The project name of ecs command.
tags GetCommandsCommandTag[]: Tags.
timeout number: The timeout of the ecs command.
type string: The type of ecs command. Valid values: Shell.
updatedAt string: The update time of the ecs command.
username string: The username of the ecs command.
workingDir string: The working directory of the ecs command.

command_content str: The base64 encoded content of the ecs command.
command_id str: The id of ecs command.
command_provider str: The provider of public command. When this field is not specified, query for custom commands.
content_encoding str: Whether the command content is base64 encoded. Valid values: Base64, PlainText. Default is Base64.
created_at str: The create time of the ecs command.
description str: The description of the ecs command.
enable_parameter bool: Whether to enable custom parameter. Default is false.
id str: The id of the ecs command.
invocation_times int: The invocation times of the ecs command. Public commands do not display the invocation times.
name str: The name of ecs command. This field support fuzzy query.
parameter_definitions Sequence[GetCommandsCommandParameterDefinition]: The custom parameter definitions of the ecs command.
project_name str: The project name of ecs command.
tags Sequence[GetCommandsCommandTag]: Tags.
timeout int: The timeout of the ecs command.
type str: The type of ecs command. Valid values: Shell.
updated_at str: The update time of the ecs command.
username str: The username of the ecs command.
working_dir str: The working directory of the ecs command.

commandContent String: The base64 encoded content of the ecs command.
commandId String: The id of ecs command.
commandProvider String: The provider of public command. When this field is not specified, query for custom commands.
contentEncoding String: Whether the command content is base64 encoded. Valid values: Base64, PlainText. Default is Base64.
createdAt String: The create time of the ecs command.
description String: The description of the ecs command.
enableParameter Boolean: Whether to enable custom parameter. Default is false.
id String: The id of the ecs command.
invocationTimes Number: The invocation times of the ecs command. Public commands do not display the invocation times.
name String: The name of ecs command. This field support fuzzy query.
parameterDefinitions List<Property Map>: The custom parameter definitions of the ecs command.
projectName String: The project name of ecs command.
tags List<Property Map>: Tags.
timeout Number: The timeout of the ecs command.
type String: The type of ecs command. Valid values: Shell.
updatedAt String: The update time of the ecs command.
username String: The username of the ecs command.
workingDir String: The working directory of the ecs command.

GetCommandsCommandParameterDefinition

DecimalPrecision int: The decimal precision of the custom parameter. This field is required when the parameter type is Digit.
DefaultValue string: The default value of the custom parameter.
MaxLength int: The maximum length of the custom parameter. This field is required when the parameter type is String.
MaxValue string: The maximum value of the custom parameter. This field is required when the parameter type is Digit.
MinLength int: The minimum length of the custom parameter. This field is required when the parameter type is String.
MinValue string: The minimum value of the custom parameter. This field is required when the parameter type is Digit.
Name string: The name of ecs command. This field support fuzzy query.
Required bool: Whether the custom parameter is required.
Type string: The type of ecs command. Valid values: Shell.

DecimalPrecision int: The decimal precision of the custom parameter. This field is required when the parameter type is Digit.
DefaultValue string: The default value of the custom parameter.
MaxLength int: The maximum length of the custom parameter. This field is required when the parameter type is String.
MaxValue string: The maximum value of the custom parameter. This field is required when the parameter type is Digit.
MinLength int: The minimum length of the custom parameter. This field is required when the parameter type is String.
MinValue string: The minimum value of the custom parameter. This field is required when the parameter type is Digit.
Name string: The name of ecs command. This field support fuzzy query.
Required bool: Whether the custom parameter is required.
Type string: The type of ecs command. Valid values: Shell.

decimalPrecision Integer: The decimal precision of the custom parameter. This field is required when the parameter type is Digit.
defaultValue String: The default value of the custom parameter.
maxLength Integer: The maximum length of the custom parameter. This field is required when the parameter type is String.
maxValue String: The maximum value of the custom parameter. This field is required when the parameter type is Digit.
minLength Integer: The minimum length of the custom parameter. This field is required when the parameter type is String.
minValue String: The minimum value of the custom parameter. This field is required when the parameter type is Digit.
name String: The name of ecs command. This field support fuzzy query.
required Boolean: Whether the custom parameter is required.
type String: The type of ecs command. Valid values: Shell.

decimalPrecision number: The decimal precision of the custom parameter. This field is required when the parameter type is Digit.
defaultValue string: The default value of the custom parameter.
maxLength number: The maximum length of the custom parameter. This field is required when the parameter type is String.
maxValue string: The maximum value of the custom parameter. This field is required when the parameter type is Digit.
minLength number: The minimum length of the custom parameter. This field is required when the parameter type is String.
minValue string: The minimum value of the custom parameter. This field is required when the parameter type is Digit.
name string: The name of ecs command. This field support fuzzy query.
required boolean: Whether the custom parameter is required.
type string: The type of ecs command. Valid values: Shell.

decimal_precision int: The decimal precision of the custom parameter. This field is required when the parameter type is Digit.
default_value str: The default value of the custom parameter.
max_length int: The maximum length of the custom parameter. This field is required when the parameter type is String.
max_value str: The maximum value of the custom parameter. This field is required when the parameter type is Digit.
min_length int: The minimum length of the custom parameter. This field is required when the parameter type is String.
min_value str: The minimum value of the custom parameter. This field is required when the parameter type is Digit.
name str: The name of ecs command. This field support fuzzy query.
required bool: Whether the custom parameter is required.
type str: The type of ecs command. Valid values: Shell.

decimalPrecision Number: The decimal precision of the custom parameter. This field is required when the parameter type is Digit.
defaultValue String: The default value of the custom parameter.
maxLength Number: The maximum length of the custom parameter. This field is required when the parameter type is String.
maxValue String: The maximum value of the custom parameter. This field is required when the parameter type is Digit.
minLength Number: The minimum length of the custom parameter. This field is required when the parameter type is String.
minValue String: The minimum value of the custom parameter. This field is required when the parameter type is Digit.
name String: The name of ecs command. This field support fuzzy query.
required Boolean: Whether the custom parameter is required.
type String: The type of ecs command. Valid values: Shell.

GetCommandsCommandTag

Key string: The Key of Tags.
Value string: The Value of Tags.

Key string: The Key of Tags.
Value string: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

key string: The Key of Tags.
value string: The Value of Tags.

key str: The Key of Tags.
value str: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

GetCommandsTag

Key string: The Key of Tags.
Value string: The Value of Tags.

Key string: The Key of Tags.
Value string: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

key string: The Key of Tags.
value string: The Value of Tags.

key str: The Key of Tags.
value str: The Value of Tags.

key String: The Key of Tags.
value String: The Value of Tags.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.ecs.getCommands

On this page

On this page

Example Usage

Using getCommands

getCommands Result

Supporting Types

GetCommandsCommand

GetCommandsCommandParameterDefinition

GetCommandsCommandTag

GetCommandsTag

Package Details

On this page

On this page