Console
    Start free

    MCP Tools Reference: bigtableadmin.googleapis.com

    Tool: list_instances

    List information about instances in a project. The request requires the 'parent' field to be set in the format 'projects/{project}'. Example: { "parent": "projects/my-project" }

    The following sample demonstrate how to use curl to invoke the list_instances MCP tool.

    Curl Request 
      
curl  
--location  
 'https://bigtableadmin.googleapis.com/mcp' 
  
 \ 
--header  
 'content-type: application/json' 
  
 \ 
--header  
 'accept: application/json, text/event-stream' 
  
 \ 
--data  
 '{ 
 "method": "tools/call", 
 "params": { 
 "name": "list_instances", 
 "arguments": { 
 // provide these details according to the tool' 
s  
MCP  
specification  
 } 
  
 } 
,  
 "jsonrpc" 
:  
 "2.0" 
,  
 "id" 
:  
 1 
 } 
 '

    Input Schema

    Request message for BigtableInstanceAdmin.ListInstances.

    ListInstancesRequest

    JSON representation 
     { 
 "parent" 
 : 
 string 
 , 
 "pageToken" 
 : 
 string 
 }
    Fields
    parent

    string

    Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project} .
    pageToken
    (deprecated)

    string

    DEPRECATED: This field is unused and ignored.

    Output Schema

    Response message for BigtableInstanceAdmin.ListInstances.

    ListInstancesResponse

    JSON representation 
     { 
 "instances" 
 : 
 [ 
 { 
 object (  Instance 
 
) 
 } 
 ] 
 , 
 "failedLocations" 
 : 
 [ 
 string 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    instances[]

    object ( Instance )

    The list of requested instances.
    failedLocations[]

    string

    Locations from which Instance information could not be retrieved, due to an outage or some other transient condition. Instances whose Clusters are all in one of the failed locations may be missing from instances , and Instances with at least one Cluster in a failed location may only have partial information returned. Values are of the form projects/<project>/locations/<zone_id>

    nextPageToken
    (deprecated)

    string

    DEPRECATED: This field is unused and ignored.

    Instance

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "state" 
 : 
 enum ( State 
) 
 , 
 "type" 
 : 
 enum ( Type 
) 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "createTime" 
 : 
 string 
 , 
 "tags" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 // Union field _satisfies_pzs 
can be only one of the following: 
 "satisfiesPzs" 
 : 
 boolean 
 // End of list of possible types for union field _satisfies_pzs 
. 
 // Union field _satisfies_pzi 
can be only one of the following: 
 "satisfiesPzi" 
 : 
 boolean 
 // End of list of possible types for union field _satisfies_pzi 
. 
 }
    Fields
    name

    string

    The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9] .

    displayName

    string

    Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

    state

    enum ( State )

    Output only. The current state of the instance.

    type

    enum ( Type )

    The type of the instance. Defaults to PRODUCTION .

    labels

    map (key: string, value: string)

    Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

    • Label keys must be between 1 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} .
    • Label values must be between 0 and 63 characters long and must conform to the regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} .
    • No more than 64 labels can be associated with a given resource.
    • Keys and values must both be under 128 bytes.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    createTime

    string ( Timestamp format)

    Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1 .

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    tags

    map (key: string, value: string)

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

    Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    Union field _satisfies_pzs .

    _satisfies_pzs can be only one of the following:

    satisfiesPzs

    boolean

    Output only. Reserved for future use.

    Union field _satisfies_pzi .

    _satisfies_pzi can be only one of the following:

    satisfiesPzi

    boolean

    Output only. Reserved for future use.

    LabelsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    Timestamp

    JSON representation 
     { 
 "seconds" 
 : 
 string 
 , 
 "nanos" 
 : 
 integer 
 }
    Fields
    seconds

    string ( int64 format)

    Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
    nanos

    integer

    Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

    TagsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 }
    Fields
    key

    string

    value

    string

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ❌ | Read Only Hint: ✅ | Open World Hint: ✅
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: