Method: projects.instances.getIamPolicy

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Authorization requiresspanner.instances.getIamPolicy onresource.

HTTP request


POST https://spanner.googleapis.com/v1/{resource=projects/*/instances/*}:getIamPolicy

The URLs usegRPC Transcoding syntax.

Path parameters

Parameters
resource

string

REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format isprojects/<project ID>/instances/<instance ID> for instance resources andprojects/<project ID>/instances/<instance ID>/databases/<database ID> for database resources.

Request body

The request body contains data with the following structure:

JSON representation
{"options":{object (GetPolicyOptions)}}
Fields
options

object (GetPolicyOptions)

OPTIONAL: AGetPolicyOptions object for specifying options toinstances.getIamPolicy.

Response body

If successful, the response body contains an instance ofPolicy.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/spanner.admin
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-12 UTC.