• MapReduce Service

mrs
  1. Help Center
  2. MapReduce Service
  3. API Reference
  4. MRS Manager APIs
  5. MRS Manager Web APIs
  6. Stopping a Service

Stopping a Service

Function

This API is used to stop a specified service.

URI

  • Format

POST /web/v1/maintain/cluster/{cluster_id}/service/{service_name}/stop

  • URI parameter description

Parameter

Mandatory or Not

Description

service_name

Yes

Name of the service to be stopped

cluster_id

Yes

Cluster ID that is displayed on MRS Manager. The default cluster ID is 1, because MRS Manager supports management of only one cluster currently.

Request

  • Example:
    POST /web/v1/maintain/cluster/{cluster_id}/service/{service_name}/stop HTTP/1.1
    Host: example.com
    Content-Type: application/json
    Accept:application/json
    {
      "user_password": "string",
      "only_self": true
    }
  • Request parameter description
Table 1 Request parameter description

Parameter

Mandatory or Not

Type

Description

user_password

No

STRING

Password of the login user. This parameter is used for secondary authentication. If you call REST APIs, secondary authentication is not required and you do not need to set this parameter.

only_self

No

BOOLEAN

Whether to operate only the specified service

false: The services depending on the service are also stopped.

true: Only the specified service is stopped.

If you call REST APIs, secondary authentication is not required and you do not need to set this parameter.

Response

  • Example:
    HTTP/1.1 200 OK
    Data:Wed,02 May 2018 10:10:01 GMT
    Server: example-server
    Content-Type: application/json
    {
      "id": 0,
      "state": "COMPLETE",
      "error_code": 0,
      "error_description": "string",
      "total_progress": 0
    }
  • Response parameter description

Parameter

Mandatory or Not

Description

id

No

Asynchronous task ID (meaningless in other scenarios). The default value is -1.

state

No

Cluster status. The value FAILED indicates that the command fails to be executed. The value COMPLETE indicates that the command is successfully executed. The value IN_PROGRESS indicates that the command is being executed.

error_code

No

Error code returned

error_description

No

Error code description

total_progress

No

Total progress

Status Code

Status Code

Description

200

The operation is successful.

For details about error status codes, see Status Codes.