Method: projects.instances.getIamPolicy

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• Try it!

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 requires spanner.instances.getIamPolicy on resource.

HTTP request

Choose a location:

global europe-west8 me-central2 us-central1 us-central2 us-east1 us-east4 us-east5 us-east7 us-south1 us-west1 us-west2 us-west3 us-west4 us-west8

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
resource	string REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is projects/<project ID>/instances/<instance ID> for instance resources and projects/<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: A GetPolicyOptions object for specifying options to instances.getIamPolicy.

Response body

If successful, the response body contains an instance of Policy.

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 the Authentication Overview.