All Products
Search

This Product

    Simple Application Server:InvokeCommand

    Document Center

    Simple Application Server:InvokeCommand

    Last Updated:Aug 27, 2026

    Runs a Command Assistant command for one or more simple application servers.

    Operation description

    • The simple application servers for which you want to call the operation must meet the following conditions. If a simple application server cannot meet the conditions, you must call this operation again.

      • The simple application servers are in the Running state. You can call the ListInstances operation to query the status of simple application servers.

      • Cloud Assistant Agent is installed on the simple application servers. For more information, see InstallCloudAssistant.

      • If you run a PowerShell command, make sure that the PowerShell module is configured for the simple application servers.

    • The command may fail to be run due to the abnormal states of simple application servers, network exceptions, or exceptions in Cloud Assistant Agent. If the command fails to be run, no execution information is generated.

    • If you enable the custom parameter feature when you create a command, you must set the Parameters parameter to specify custom parameters when you run the command.

    • When you call this operation, you can select only one common command or a custom command that you have created.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    swas-open:InvokeCommand

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call the ListRegions operation to query the most recent region list.

    cn-hangzhou

    CommandId

    string

    Yes

    The command ID. You can call the DescribeCommands operation to query all available command IDs.

    c-sh02yh0932w****
    Parameters

    object

    No

    The key-value pairs of custom parameters to specify when the custom parameter feature is enabled.

    • You can specify up to 10 custom parameters. Each key in a Map collection cannot be an empty string and can be up to 64 characters in length.

    • Values in a Map collection can be empty strings. The total length of the custom parameters and the original command cannot exceed 18 KB after they are encoded in Base64.

    • The custom parameter names that you specify for the Parameters parameter must be included in the custom parameter names that you specified when you created the command.

    • You can use empty strings to represent the custom parameters that are not specified. If you want to disable the custom parameter feature, you can leave this parameter empty.

    {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
    Username

    string

    No

    The name of the user who runs the command in a simple application server. The username cannot exceed 255 characters in length.

    • For Linux servers, the default value is the root username.

    • For Windows servers, the default value is the system username.

    You can change the user to run the command only for Linux simple application servers.

    test
    InstanceIds

    string

    Yes

    The IDs of the simple application servers. The value can be a JSON array that consists of up to 50 IDs of simple application servers. Separate multiple IDs with commas (,).

    ["2ad1ae67295445f598017499dc****", "2ad1ae67295445f598017123dc****"]

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    20758A-585D-4A41-A9B2-28DA8F4F****
    InvokeId

    string

    The execution ID of the command.

    t-bj02prjhw1n****

    Examples

    Success response

    JSON format

    {
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "InvokeId": "t-bj02prjhw1n****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.