Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
HTTP request
POST https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/tables/*}:checkConsistency
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The unique name of the Table for which to check replication consistency. Values are of the form Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{ "consistencyToken": string } |
Fields | |
---|---|
consistencyToken |
Required. The token created using tables.generateConsistencyToken for the Table. |
Response body
If successful, the response body contains data with the following structure:
Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
JSON representation | |
---|---|
{ "consistent": boolean } |
Fields | |
---|---|
consistent |
True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request. |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/bigtable.admin
https://www.googleapis.com/auth/bigtable.admin.table
https://www.googleapis.com/auth/cloud-bigtable.admin
https://www.googleapis.com/auth/cloud-bigtable.admin.table
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.