StopDbNode
Stops the specified DB node in a VM cluster.
Request Syntax
{
"cloudVmClusterId": "string",
"dbNodeId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- cloudVmClusterId
-
The unique identifier of the VM cluster that contains the DB node to stop.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 64.
Pattern:
[a-zA-Z0-9_~.-]+Required: Yes
- dbNodeId
-
The unique identifier of the DB node to stop.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 64.
Pattern:
[a-zA-Z0-9_~.-]+Required: Yes
Response Syntax
{
"dbNodeId": "string",
"status": "string",
"statusReason": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- dbNodeId
-
The unique identifier of the DB node that was stopped.
Type: String
- status
-
The current status of the DB node after the stop operation.
Type: String
Valid Values:
AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | STOPPING | STOPPED | STARTING - statusReason
-
Additional information about the status of the DB node after the stop operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.
HTTP Status Code: 400
- InternalServerException
-
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.
- resourceId
-
The identifier of the resource that was not found.
- resourceType
-
The type of resource that was not found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400
- ValidationException
-
The request has failed validation because it is missing required fields or has invalid inputs.
- fieldList
-
A list of fields that failed validation.
- reason
-
The reason why the validation failed.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
