有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

取消一台或多台CVM实例执行的命令

  • 如果命令还未下发到agent,任务状态处于处于PENDING、DELIVERING、DELIVER_DELAYED,取消后任务状态是CANCELLED
  • 如果命令已下发到agent,任务状态处于RUNNING, 取消后任务状态是TERMINATED

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CancelInvocation。
Version String 公共参数,本接口取值:2020-10-28。
Region String 公共参数,详见产品支持的 地域列表
InvocationId String 执行活动ID
示例值:inv-xxxxxxxx
InstanceIds.N Array of String 实例ID列表,上限100。支持实例类型:
  • CVM
  • LIGHTHOUSE

  • 示例值:["ins-xxxxxxxx"]

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 取消命令执行

    输入示例

    POST / HTTP/1.1
    Host: tat.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CancelInvocation
    <公共请求参数>
    
    {
        "InvocationId": "inv-ib2lld37",
        "InstanceIds": [
            "ins-zcewfho0"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "b27421da-0ad4-4e11-b694-cda143606701"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.InstanceIsNotRelatedToInvocation 实例ID与执行活动无关。
    InvalidParameterValue.InvalidInstanceId 实例ID无效。
    InvalidParameterValue.InvalidInvocationId 不合法的执行活动ID。
    InvalidParameterValue.LimitExceeded 超过参数限制。
    InvalidParameterValue.TooLong 长度超过限制。
    LimitExceeded 超过配额限制。
    MissingParameter 缺少参数错误。
    ResourceNotFound.InvocationNotFound 执行活动未找到。
    UnauthorizedOperation.CamAuthFailed CAM鉴权失败。
    UnauthorizedOperation.InvalidToken Token 无效。
    UnauthorizedOperation.MFAExpired Multi-Factor Authentication(MFA) 过期。
    UnauthorizedOperation.MFANotFound Multi-Factor Authentication(MFA) 不存在。
    UnknownParameter 未知参数错误。