Google

Replica Pool

The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template.

Developer tools#openapi#backend

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template.

Endpoints 10

pools

  • GETreplicapool.pools.list/:projectName/zones/:zone/pools?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=string&maxResults=500&pageToken=stringList all replica pools.
  • POSTreplicapool.pools.insert/:projectName/zones/:zone/pools?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringInserts a new replica pool.
  • GETreplicapool.pools.get/:projectName/zones/:zone/pools/:poolName?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringGets information about a single replica pool.
  • POSTreplicapool.pools.delete/:projectName/zones/:zone/pools/:poolName?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringDeletes a replica pool.
  • POSTreplicapool.pools.resize/:projectName/zones/:zone/pools/:poolName/resize?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=string&numReplicas=0Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last…
  • POSTreplicapool.pools.updatetemplate/:projectName/zones/:zone/pools/:poolName/updateTemplate?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringUpdate the template used by the pool.

replicas

  • GETreplicapool.replicas.list/:projectName/zones/:zone/pools/:poolName/replicas?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=string&maxResults=500&pageToken=stringLists all replicas in a pool.
  • GETreplicapool.replicas.get/:projectName/zones/:zone/pools/:poolName/replicas/:replicaName?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringGets information about a specific replica.
  • POSTreplicapool.replicas.delete/:projectName/zones/:zone/pools/:poolName/replicas/:replicaName?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringDeletes a replica from the pool.
  • POSTreplicapool.replicas.restart/:projectName/zones/:zone/pools/:poolName/replicas/:replicaName/restart?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=stringRestarts a replica in a pool.

API details

Base URL
https://www.googleapis.com/replicapool/v1beta1/projects
Authentication
OAuth 2.0 (implicit flow) with 6 scopes
OAuth 2.0 (authorization code flow) with 6 scopes
Operations
10 operations on 7 pathsPOST 6GET 4
Main resources
pools 6replicas 4
Response formats
*/*
Description format
OpenAPI 3.0.0, API version v1beta1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Replica Pool in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Replica Pool collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 6 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “replicapool.pools.list” (GET /:projectName/zones/:zone/pools?alt=json&fields=string&key=string&oauth_token=string&prettyPrint=true&quotaUser=string&userIp=string&maxResults=500&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Replica Pool?

The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template. It is listed under Developer tools and has 10 endpoints.

Who publishes the Replica Pool?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Replica Pool?

Requests go to https://www.googleapis.com/replicapool/v1beta1/projects. Endpoint paths are added to this base URL.

How do I authenticate with the Replica Pool?

It accepts 2 methods: OAuth 2.0 (implicit flow) with 6 scopes; OAuth 2.0 (authorization code flow) with 6 scopes.

How many endpoints does the Replica Pool have?

10 operations on 7 paths (6 POST, 4 GET). The largest groups are pools, replicas.

Is forking the Replica Pool free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.