1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(RepairTaskControl)用于对待授权状态的维修任务进行授权操作。
- 仅当任务状态处于
待授权
状态时,可通过此接口对待授权的维修任务进行授权。 - 调用时需指定产品类型、实例ID、维修任务ID、操作类型。
- 可授权立即处理,或提前预约计划维护时间之前的指定时间进行处理(预约时间需晚于当前时间至少5分钟,且在48小时之内)。
- 针对不同类型的维修任务,提供的可选授权处理策略可参见 维修任务类型与处理策略。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RepairTaskControl。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Product | 是 | String | 待授权任务实例对应的产品类型,支持取值: - CVM :云服务器- CDH :专用宿主机- CPM2.0 :裸金属云服务器示例值:CVM |
InstanceIds.N | 是 | Array of String | 指定待操作的实例ID列表,仅允许对列表中的实例ID相关的维修任务发起授权。 示例值:["ins-xxxxxxx1", "ins-xxxxxxx2"] |
TaskId | 是 | String | 维修任务ID。 示例值:rep-xxxxxxxx |
Operate | 是 | String | 操作类型,当前只支持传入AuthorizeRepair 。示例值:AuthorizeRepair |
OrderAuthTime | 否 | String | 预约授权时间,形如2023-01-01 12:00:00 。预约时间需晚于当前时间至少5分钟,且在48小时之内。示例值:2023-01-01 12:00:00 |
TaskSubMethod | 否 | String | 附加的授权处理策略。 示例值:NA |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 已完成授权的维修任务ID。 示例值:rep-xxxxxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 授权维修任务立即进行处理
授权待授权的维修任务,允许立即进行处理
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RepairTaskControl
<公共请求参数>
{
"Product": "CVM",
"InstanceIds": [
"ins-xxxxxxxx"
],
"TaskId": "rep-xxxxxxxx",
"Operate": "AuthorizeRepair"
}
输出示例
{
"Response": {
"RequestId": "0436564c-1234-4f0f-a341-59e86338446",
"TaskId": "rep-xxxxxxxx"
}
}
示例2 预约维修任务在指定时间进行处理
提前预约待授权的维修任务在2023-01-02 12:00:00
授权进行处理
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RepairTaskControl
<公共请求参数>
{
"Product": "CVM",
"InstanceIds": [
"ins-xxxxxxxx"
],
"TaskId": "rep-xxxxxxxx",
"Operate": "AuthorizeRepair",
"OrderAuthTime": "2023-01-02 12:00:00"
}
输出示例
{
"Response": {
"RequestId": "0436564c-1234-4f0f-a341-59e86338446",
"TaskId": "rep-xxxxxxxx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |