Skip to main content
GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
changelogs
/
{changelog}
cURL
curl --request GET \
  --url https://api.example.com/v1/instances/{instance}/databases/{database}/changelogs/{changelog}
{
  "name": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "status": "STATUS_UNSPECIFIED",
  "statement": "<string>",
  "statementSize": "<string>",
  "statementSheet": "<string>",
  "schema": "<string>",
  "schemaSize": "<string>",
  "prevSchema": "<string>",
  "prevSchemaSize": "<string>",
  "taskRun": "<string>",
  "version": "<string>",
  "revision": "<string>",
  "type": "TYPE_UNSPECIFIED"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

​
changelog
string
required

The changelog id.

Query Parameters

​
view
enum<string>
Available options:
CHANGELOG_VIEW_UNSPECIFIED,
CHANGELOG_VIEW_BASIC,
CHANGELOG_VIEW_FULL

Response

OK

​
name
string

Format: instances/{instance}/databases/{database}/changelogs/{changelog}

​
createTime
string<date-time>
​
status
enum<string>
Available options:
STATUS_UNSPECIFIED,
PENDING,
DONE,
FAILED
​
statement
string

The statement is used for preview purpose.

​
statementSize
string
​
statementSheet
string

The name of the sheet resource. Format: projects/{project}/sheets/{sheet}

​
schema
string
​
schemaSize
string
​
prevSchema
string
​
prevSchemaSize
string
​
taskRun
string

Format: projects/{projects}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}

​
version
string

Could be empty

​
revision
string

Could be empty Or present but not found if deleted

​
type
enum<string>
Available options:
TYPE_UNSPECIFIED,
BASELINE,
MIGRATE,
SDL