执行远程命令

最近更新时间: 2026-09-17 00:00:18

1. 接口描述

接口请求域名： remoteexecutor.api3.fincloud.tencent.cn。

ExecRemoteCmd

默认接口请求频率限制：20次/秒。

接口更新时间：2024-03-07 11:21:56。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：ExecRemoteCmd
Version	是	否	String	公共参数，本接口取值：2023-12-15
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
Target	是	否	Target	目标机器信息示例值：查看
Cmd	是	否	String	Cmd 示例值： ls
User	是	否	String	执行用户示例值： root
Args	否	否	Array of String	cmd 参数示例值： -al
Parallel	否	否	Parallel	并行控制配置示例值：查看
ErrorIgnore	否	否	ErrorIgnore	错误忽略配置示例值：查看
Timeout	是	否	Int64	超时时间示例值： 100
Type	是	否	String	类型示例值： shell
EnvDefault	否	否	Bool	EnvDefault 示例值： true
EnvCustom	否	否	EnvKV	EnvCustom 示例值：查看

3. 输出参数

参数名称	类型	描述
TaskUUID	String	任务UUID 示例值： 907b7dd9-6ad1-a04c-b1b5-94ac3c11b286
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

5. 示例

示例1 ExecRemoteCmd

输入示例

POST / HTTP/1.1
Host: tapi.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: ExecRemoteCmd
<公共请求参数>

{
    "Target": {
        "Type": 1,
        "Value": [
            "4d571ac8-526b-45e8-a945-943b4fbf354a"
        ]
    },
    "Type": "agent",
    "EnvDefault":true,
    "Action": "ExecRemoteCmd",
    "Region": "newyork",
    "AppId": 1255002251,
    "Uin": "100004614207",
    "SubAccountUin": "100004614207",
    "Cmd": "env",
    "User": "root",
    "Timeout": 600
}

输出示例

{
    "Response": {
        "RequestId": "0dd14411-2ece-6df9-1825-27e448369b81",
        "TaskUUID": "907b7dd9-6ad1-a04c-b1b5-94ac3c11b286"
    }
}