Manages a service deployed in a cluster. For example, you can call this operation to start pr stop a service.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| ClusterId | string | Yes | The cluster ID. | C-C95F0A39D8FF**** |
| ActionName | string | Yes | The name of the action. Valid values:
| start |
| ComponentInstanceSelector | ComponentInstanceSelector | Yes | The operation object. | |
| RollingExecute | boolean | No | Specifies whether to enable rolling execution. | true |
| ExecuteStrategy | string | No | The execution policy. Valid values:
| FAILED_CONTINUE |
| Interval | long | No | The interval for rolling execution. Unit: seconds. | 10 |
| BatchSize | integer | No | The number of applications in each batch. | 1 |
| Description | string | No | The description of the execution. |
Response parameters
Examples
Sample success responses
JSONformat
{
"OperationId": "op-13c37a77c505****",
"AbnInstances": [
{
"NodeName": "core1-1",
"NodeId": "i-bp1cudc25w2bfwl5****"
}
],
"RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | ConcurrentModification | The request on %s failed due to multiple requests to change this object were submitted simultaneously. Wait a few minutes and try again. |
| 400 | InvalidParameter.InvalidRunActionScope | The specified run action scope is invalid. |
| 400 | MissingParameter.ComponentInstance | You must specify componentInstance. |
| 400 | MissingParameter.NodeId | You must specify nodeId. |
| 400 | MissingParameter.ComponentName | You must specify componentName. |
| 400 | MissingParameter.ApplicationName | You must specify applicationName. |
| 400 | MissingParameter.NodeGroupId | You must specify nodeGroupId. |
| 400 | InvokeEcmError | An error occurred while invoking ECM service. |
| 400 | ConflictParameters | Parameters that must not be used together. %s |
| 400 | IncompleteSignature | The request signature is invalid. |
| 400 | InvalidAction | The action %s requested is invalid. |
| 400 | InvalidParameter | The specified parameter %s is not valid. |
| 400 | InvalidParameterValue | The input parameter %s is invalid or out of range. |
| 400 | MissingAction | The action %s requested is missing. |
| 400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. |
| 400 | NotAuthorized | You do not have permission to perform this action. %s |
| 400 | ThrottlingException | The request was denied due to request throttling. %s |
| 404 | ResourceNotFound | The resource not found by %s. |
| 500 | InternalError | The request processing has failed due to some unknown error, exception or failure. |
| 503 | ServiceFailure | The request has failed due to a temporary failure of %s service. |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-12-07 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-10-23 | The Error code has changed | View Change Details |
