v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132769111.5 KB
projects

Creates a metastore service in a project and location.

post/v1/{+parent}/services

Path parameters

parentstring required

Required. The relative resource name of the location in which to create a metastore service, in the following form:projects/{project_number}/locations/{location_id}.

Query parameters

requestIdstring

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

serviceIdstring

Required. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.

Request body

endpointUristring

Output only. The URI of the endpoint used to access the metastore service.

labelsobject

User-defined labels for the metastore service.

artifactGcsUristring

Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.

tier'TIER_UNSPECIFIED' | 'DEVELOPER' | 'ENTERPRISE'

Optional. The tier of the service.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'SUSPENDING' | 'SUSPENDED' | 'UPDATING' | 'DELETING' | 'ERROR' | 'AUTOSCALING' | 'MIGRATING'

Output only. The current state of the metastore service.

uidstring

Output only. The globally unique resource identifier of the metastore service.

updateTimestring google-datetime

Output only. The time when the metastore service was last updated.

stateMessagestring

Output only. Additional information about the current state of the metastore service, if available.

createTimestring google-datetime

Output only. The time when the metastore service was created.

networkstring

Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

portinteger

Optional. The TCP port at which the metastore service is reached. Default: 9083.

databaseType'DATABASE_TYPE_UNSPECIFIED' | 'MYSQL' | 'SPANNER'

Immutable. The database type that the Metastore service stores its data.

namestring

Immutable. Identifier. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.

releaseChannel'RELEASE_CHANNEL_UNSPECIFIED' | 'CANARY' | 'STABLE'

Immutable. The release channel of the service. If unspecified, defaults to STABLE.

deletionProtectionboolean

Optional. Indicates if the dataproc metastore should be protected against accidental deletions.

Response

Successful response