Method: googleapis.spanner.v1.projects.instances.get

Gets information about a particular instance.

For more information about retries and long-running operations, see Understand connectors .

Arguments

Parameters
name

string

Required. The name of the requested instance. Values are of the form projects//instances/ .

fieldMask

string ( FieldMask format)

If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

Raised exceptions

Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Instance .

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation .

YAML

 - 
  
 get 
 : 
  
 call 
 : 
  
 googleapis.spanner.v1.projects.instances.get 
  
 args 
 : 
  
 name 
 : 
  
 ... 
  
 fieldMask 
 : 
  
 ... 
  
 result 
 : 
  
 getResult 

JSON

 [ 
  
 { 
  
 "get" 
 : 
  
 { 
  
 "call" 
 : 
  
 "googleapis.spanner.v1.projects.instances.get" 
 , 
  
 "args" 
 : 
  
 { 
  
 "name" 
 : 
  
 "..." 
 , 
  
 "fieldMask" 
 : 
  
 "..." 
  
 }, 
  
 "result" 
 : 
  
 "getResult" 
  
 } 
  
 } 
 ] 
Design a Mobile Site
View Site in Mobile | Classic
Share by: