1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
导入定时任务
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ImportInstancesActionTimer。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 实例id列表,可以通过DescribeInstances接口查询到。 示例值:["ins-37qv3ucj\r\n"] |
ActionTimer | 是 | ActionTimer | 定时器任务信息,目前仅支持定时销毁。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ActionTimerIds | Array of String | 定时器id列表 示例值:["865d042d-0219-46c3-9821-6028c96cfb7c"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导入定时任务
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportInstancesActionTimer
<公共请求参数>
{
"ActionTimer": {
"TimerAction": "TerminateInstances",
"ActionTime": "2018-08-01 20:00:00"
},
"InstanceIds": [
"ins-37qv3ucj"
]
}
输出示例
{
"Response": {
"ActionTimerIds": [
"865d042d-0219-46c3-9821-6028c96cfb7c"
],
"RequestId": "d4617dd8-071a-4bd6-aabf-f8026f757189"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.MutActionTimerExist | 该实例已存在指定的定时任务 |
InvalidInstanceId.NotFound | 没有找到相应实例。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。 |
InvalidParameterValue.InvalidTimeFormat | 时间格式不合法。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
UnsupportedOperation.NotSupportImportInstancesActionTimer | 针对当前实例设置定时任务失败。 |