Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
Authorization requires the following IAM permission on the specified resource parent:
alloydb.instances.create
Query parameters
Parameters
instanceId
string
Required. ID of the requesting object.
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.
Request body
The request body contains an instance of Instance.
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 endpoint allows you to create a new SECONDARY Instance within a specified project and location, as designated by the \u003ccode\u003eparent\u003c/code\u003e parameter in the HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003einstanceId\u003c/code\u003e parameter is a required string to specify the ID of the new instance being created, and the \u003ccode\u003erequestId\u003c/code\u003e parameter is an optional unique identifier that prevents accidental duplicate requests.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint accepts an optional boolean \u003ccode\u003evalidateOnly\u003c/code\u003e parameter that, when set, will check request validations, but will not go through with the request.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include an Instance resource, and upon successful execution, the response will contain an Operation resource.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for this endpoint requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e, and the caller must have the \u003ccode\u003ealloydb.instances.create\u003c/code\u003e IAM permission on the specified parent resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.clusters.instances.createsecondary\n\nCreates a new SECONDARY Instance in a given project and location.\n\n### HTTP request\n\n`POST https://alloydb.googleapis.com/v1beta/{parent=projects/*/locations/*/clusters/*}/instances:createsecondary`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Instance](/alloydb/docs/reference/rest/v1beta/projects.locations.clusters.instances#Instance).\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)."]]