执行服务操作

最近更新时间:2024-07-01 01:15:49

我的收藏

1. 接口描述

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

用于启停服务 重启服务等功能

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:StartStopServiceOrMonitor。
Version String 公共参数,本接口取值:2019-01-03。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 集群ID
示例值:emr-xxx
OpType String 操作类型,当前支持
  • StartService:启动服务
  • StopService:停止服务
  • StartMonitor:退出维护
  • StopMonitor:进入维护
  • RestartService:重启服务 如果操作类型选择重启服务 StrategyConfig操作策略则是必填项

  • 示例值:StartService
    OpScope OpScope 操作范围
    StrategyConfig StrategyConfig 操作策略
    StopParams StopParams 暂停服务时用的参数
    KeepMonitorButNotRecoverProcess Boolean 当OpType为
  • StopMonitor
  • 才有用,true表示进入维护模式但是仍然监控进程但是不拉起进程

    3. 输出参数

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

    4. 示例

    示例1 StartStopServiceOrMonitor

    启停服务接口

    输入示例

    POST / HTTP/1.1
    Host: emr.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: StartStopServiceOrMonitor
    <公共请求参数>
    
    {
        "InstanceId": "emr-4zvc5mul",
        "OpType": "StartService",
        "OpScope": {
            "ServiceInfoList": [
                {
                    "ServiceName": "abc",
                    "ComponentInfoList": [
                        {
                            "ComponentName": "ZKFailoverController",
                            "IpList": [
                                "172.16.114.126"
                            ]
                        }
                    ]
                }
            ]
        },
        "StrategyConfig": {
            "RollingRestartSwitch": 0,
            "BatchSize": 1,
            "TimeWait": 5,
            "DealOnFail": 0
        }
    }

    输出示例

    {
        "Response": {
            "RequestId": "4c141dbb-b365-4c1b-a209-2c18e47fdb11"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError.CamCgwError 内部服务调用异常。
    InternalError.WoodServerError 内部服务调用异常。
    InvalidParameter.InvalidInstanceName 无效的集群名称。
    InvalidParameter.InvalidJobFlow 无效的流程任务。
    ResourceInUse.InstanceInProcess 实例在流程中。
    ResourceNotFound.InstanceNotFound 无法找到该实例。
    UnauthorizedOperation.CheckCamAuth 校验账号操作无权限。
    UnsupportedOperation.ServiceNotSupport 该服务不支持此操作。