tencent cloud

Elastic MapReduce

Release Notes and Announcements
Release Notes
Announcements
Security Announcements
Product Introduction
Overview
Strengths
Architecture
Features
Use Cases
Constraints and Limits
Technical Support Scope
Product release
Purchase Guide
EMR on CVM Billing Instructions
EMR on TKE Billing Instructions
EMR Serverless HBase Billing Instructions
Getting Started
EMR on CVM Quick Start
EMR on TKE Quick Start
EMR on CVM Operation Guide
Planning Cluster
Administrative rights
Configuring Cluster
Managing Cluster
Managing Service
Monitoring and Alarms
TCInsight
EMR on TKE Operation Guide
Introduction to EMR on TKE
Configuring Cluster
Cluster Management
Service Management
Monitoring and Ops
Application Analysis
EMR Serverless HBase Operation Guide
EMR Serverless HBase Product Introduction
Quotas and Limits
Planning an Instance
Managing an Instance
Monitoring and Alarms
Development Guide
EMR Development Guide
Hadoop Development Guide
Spark Development Guide
Hbase Development Guide
Phoenix on Hbase Development Guide
Hive Development Guide
Presto Development Guide
Sqoop Development Guide
Hue Development Guide
Oozie Development Guide
Flume Development Guide
Kerberos Development Guide
Knox Development Guide
Alluxio Development Guide
Kylin Development Guide
Livy Development Guide
Kyuubi Development Guide
Zeppelin Development Guide
Hudi Development Guide
Superset Development Guide
Impala Development Guide
Druid Development Guide
TensorFlow Development Guide
Kudu Development Guide
Ranger Development Guide
Kafka Development Guide
Iceberg Development Guide
StarRocks Development Guide
Flink Development Guide
JupyterLab Development Guide
MLflow Development Guide
Practical Tutorial
Practice of EMR on CVM Ops
Data Migration
Practical Tutorial on Custom Scaling
API Documentation
History
Introduction
API Category
Cluster Resource Management APIs
Cluster Services APIs
User Management APIs
Data Inquiry APIs
Scaling APIs
Configuration APIs
Other APIs
Serverless HBase APIs
YARN Resource Scheduling APIs
Making API Requests
Data Types
Error Codes
FAQs
EMR on CVM
Service Level Agreement
Contact Us

StartStopServiceOrMonitor

PDF
フォーカスモード
フォントサイズ
最終更新日: 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.

    ヘルプとサポート

    この記事はお役に立ちましたか?

    フィードバック