Required. The type of fault to be injected in an instance.
requestId
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly
boolean
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-15 UTC."],[[["\u003cp\u003eThis document outlines the process for injecting a fault into an AlloyDB instance using an HTTP POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e path parameter is required and specifies the resource, necessitating \u003ccode\u003ealloydb.instances.injectFault\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003efaultType\u003c/code\u003e to define the fault, with \u003ccode\u003eSTOP_VM\u003c/code\u003e being one of the possible enum options, as well as the options to use a \u003ccode\u003erequestID\u003c/code\u003e to avoid sending duplicates and \u003ccode\u003evalidateOnly\u003c/code\u003e to perform a dry run.\u003c/p\u003e\n"],["\u003cp\u003eThe service supports setting authorization using OAuth scope: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an \u003ccode\u003eOperation\u003c/code\u003e instance, indicating that a background task is started.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.clusters.instances.injectFault\n\nInjects fault in an instance. Imperative only.\n\n### HTTP request\n\n`POST https://alloydb.googleapis.com/v1/{name=projects/*/locations/*/clusters/*/instances/*}:injectFault`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/alloydb/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\nFaultType\n---------\n\nFaultType contains all valid types of faults that can be injected to an instance."]]
