tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateCommand

Last updated: 2023-03-14 16:55:47

1. API Description

Domain name for API request: tat.tencentcloudapi.com.

This API is used to create a command.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateCommand.
Version Yes String Common Params. The value used for this API: 2020-10-28.
Region No String Common Params. This parameter is not required for this API.
CommandName Yes String Command name. The name can be up to 60 bytes, and contain [a-z], [A-Z], [0-9] and [_-.].
Content Yes String Base64-encoded command. The maximum length is 64 KB.
Description No String Command description. The maximum length is 120 characters.
CommandType No String Command type. SHELL and POWERSHELL are supported. The default value is SHELL.
WorkingDirectory No String Command execution path. The default value is /root for SHELL commands and C:\Program Files\qcloud\tat_agent\workdir for POWERSHELL commands.
Timeout No Integer Command timeout period. Default value: 60 seconds. Value range: [1, 86400].
EnableParameter No Boolean Whether to enable the custom parameter feature.
This cannot be modified once created.
Default value: false.
DefaultParameters No String The default value of the custom parameter value when it is enabled. The field type is JSON encoded string. For example, {"varA": "222"}.
key is the name of the custom parameter and value is the default value. Both key and value are strings.
If no parameter value is provided in the InvokeCommand API, the default value is used.
Up to 20 custom parameters are supported.
The name of the custom parameter cannot exceed 64 characters and can contain [a-z], [A-Z], [0-9] and [-_].
Tags.N No Array of Tag Tags bound to the command. At most 10 tags are allowed.
Username No String The username used to execute the command on the CVM or Lighthouse instance.
The principle of least privilege is the best practice for permission management. We recommend you execute TAT commands as a general user. By default, the root user is used to execute commands on Linux and the System user is used on Windows.
OutputCOSBucketUrl No String The COS bucket URL for uploading logs. The URL must start with https, such as https://BucketName-123454321.cos.ap-beijing.myqcloud.com.
OutputCOSKeyPrefix No String The COS bucket directory where the logs are saved. Check below for the rules of the directory name.
1. It must be a combination of number, letters, and visible characters. Up to 60 characters are allowed.
2. Use a slash (/) to create a subdirectory.
3. Consecutive dots (.) and slashes (/) are not allowed. It can not start with a slash (/).

3. Output Parameters

Parameter Name Type Description
CommandId String Command ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a command

Input Example

POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCommand
<Common request parameters>

{
    "CommandName": "hello-command",
    "Description": "hello world",
    "Content": "bHM=",
    "CommandType": "SHELL",
    "WorkingDirectory": "/",
    "Timeout": 60
}

Output Example

{
    "Response": {
        "RequestId": "9bea970a-0bab-495f-b0dd-de5eedfdf611",
        "CommandId": "cmd-7efujjs6"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.CommandContentInvalid Invalid command content.
InvalidParameterValue.CommandNameDuplicated Duplicate command name.
InvalidParameterValue.InvalidCommandName Invalid command name.
InvalidParameterValue.InvalidContent Invalid command.
InvalidParameterValue.InvalidOutputCOSBucketUrl Invalid OutputCOSBucketUrl.
InvalidParameterValue.InvalidOutputCOSKeyPrefix Invalid OutputCOSKeyPrefix.
InvalidParameterValue.InvalidUsername Invalid username.
InvalidParameterValue.InvalidWorkingDirectory Invalid command execution path.
InvalidParameterValue.ParameterDisabled The custom parameter feature is not enabled.
InvalidParameterValue.ParameterInvalidJsonFormat The parameter is not a valid JSON string.
InvalidParameterValue.ParameterKeyContainsInvalidChar The parameter key contains invalid characters.
InvalidParameterValue.ParameterKeyDuplicated Duplicate parameter keys.
InvalidParameterValue.ParameterKeyLenExceeded The parameter key is too long.
InvalidParameterValue.ParameterNumberExceeded Too many parameters.
InvalidParameterValue.ParameterValueNotString The parameter value is not a string.
InvalidParameterValue.Range The parameter value is not in the valid range.
InvalidParameterValue.SupportParametersOnlyIfEnableParameter The custom parameter feature is not enabled.
InvalidParameterValue.TooLong Length limit exceeded.
MissingParameter Missing parameter.
UnauthorizedOperation.CamAuthFailed CAM authentication failed.
UnauthorizedOperation.InvalidToken Invalid token.
UnauthorizedOperation.MFAExpired The Multi-factor authentication (MFA) code expired.
UnauthorizedOperation.MFANotFound Multi-factor authentication (MFA) does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy