tencent cloud

StartStopServiceOrMonitor
Last updated: 2025-11-13 20:49:10
StartStopServiceOrMonitor
Last updated: 2025-11-13 20:49:10

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to start, stop, or restart services.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: StartStopServiceOrMonitor.
Version Yes String Common Params. The value used for this API: 2019-01-03.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String The cluster ID.
OpType Yes String The operation type. Valid values:
  • StartService: Start service
  • StopService: Stop service
  • StartMonitor: Start maintenance
  • StopMonitor: Stop maintenance
  • RestartService: Restart service. If this type is selected, "StrategyConfig" is required.
    		•
    OpScope Yes OpScope The operation scope.
    StrategyConfig No StrategyConfig The operation policy.
    StopParams No StopParams Parameters used for suspending services.
    KeepMonitorButNotRecoverProcess No Boolean This parameter is available only when OpType is
  • StopMonitor
    • . True indicates that the system enters the maintenance mode but still monitors processes without starting them.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 StartStopServiceOrMonitor

    This example shows you how to start or stop a service API.

    Input Example

    POST / HTTP/1.1
Host: emr.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartStopServiceOrMonitor
<Common request parameters>

{
    "InstanceId": "emr-mfk",
    "OpScope": {
        "ServiceInfoList": [
            {
                "ComponentInfoList": [
                    {
                        "ComponentName": "NameNode",
                        "IpList": [
                            "0.0.0.0"
                        ]
                    },
                    {
                        "ComponentName": "ZKFailoverController",
                        "IpList": [
                            "0.0.0.0"
                        ]
                    }
                ],
                "ServiceName": "HDFS"
            }
        ]
    },
    "OpType": "StartService"
}

    Output Example

    {
    "Response": {
        "RequestId": "017c3a6d-382a-4cb2-bd7d-67072b86f027"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InternalError.CamCgwError An error occurred while calling another service API.
    InternalError.WoodServerError An error occurred while calling another service API.
    InvalidParameter.InvalidInstanceName Invalid cluster name.
    InvalidParameter.InvalidJobFlow Invalid process task.
    ResourceInUse.InstanceInProcess The instance is under workflow.
    ResourceNotFound.InstanceNotFound The instance was not found.
    UnauthorizedOperation.CheckCamAuth Unauthorized operation.
    UnsupportedOperation.ServiceNotSupport This operation is not supported.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback