运行自定义脚本

最近更新时间:2019-03-08 18:56:06

查看pdf

1. 接口描述

接口请求域名: bm.tencentcloudapi.com 。

运行自定义脚本

默认接口请求频率限制:10次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunUserCmd
Version String 公共参数,本接口取值:2018-04-23
Region String 公共参数,本接口不需要传递此参数。
CmdId String 自定义脚本ID
UserName String 执行脚本机器的用户名
Password String 执行脚本机器的用户名的密码
InstanceIds.N Array of String 执行脚本的服务器实例
CmdParam String 执行脚本的参数,必须经过base64编码

3. 输出参数

参数名称 类型 描述
SuccessTaskInfoSet Array of SuccessTaskInfo 运行成功的任务信息列表
FailedTaskInfoSet Array of FailedTaskInfo 运行失败的任务信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 运行自定义脚本

输入示例

https://bm.tencentcloudapi.com/?Action=RunUserCmd
&CmdId=cmd-aaaaa
&UserName=root
&Password=123456
&CmdParam=xx
&InstanceIds.0=cpm-xxx0
&InstanceIds.1=cpm-xxx1
&InstanceIds.2=cpm-xxx2
&<公共请求参数>

输出示例

{
    "Response": {
        "SuccessTaskInfoSet": [
            {
                "InstanceId": "cpm-xxx0",
                "TaskId": 902537
            },
            {
                "InstanceId": "cpm-xxx1",
                "TaskId": 902538
            }
        ],
        "FailedTaskInfoSet": [
            {
                "InstanceId": "cpm-xxx2",
                "ErrorMsg": "Some message"
            }
        ],
        "RequestId": "b035baf0-b935-4321-b6b4-cbd54c06437a"
    }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation 操作失败
InvalidParameter 参数错误
UnsupportedOperation 操作不支持