Start instancesedit
This endpoint is deprecated and scheduled to be removed in the next major version. Use start resource instances instead.
Starts the instances belonging to a Apm cluster.
Requestedit
POST /api/v1/clusters/apm/{cluster_id}/instances/{instance_ids}/_start
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
Responsesedit
-
202
-
The start command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
-
403
-
The start command was prohibited for the given cluster. (code:
clusters.command_prohibited
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.command_prohibited
]) - The error codes associated with the response
-
-
404
-
-
The cluster specified by {cluster_id} cannot be found. (code:
clusters.cluster_not_found
) -
One or more of the instances specified at {instance_ids} could not be found. (code:
clusters.instances_not_found
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
,clusters.instances_not_found
]) - The error codes associated with the response
-
The cluster specified by {cluster_id} cannot be found. (code:
-
449
-
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/instances/{instance_ids}/_start \ -H "Authorization: ApiKey $ECE_API_KEY"