GET
/
v1
/
projects
/
{project}
/
plans
{
  "plans": [
    {
      "name": "<string>",
      "issue": "<string>",
      "rollout": "<string>",
      "title": "<string>",
      "description": "<string>",
      "specs": [
        {
          "id": "<string>",
          "createDatabaseConfig": {
            "target": "<string>",
            "database": "<string>",
            "table": "<string>",
            "characterSet": "<string>",
            "collation": "<string>",
            "cluster": "<string>",
            "owner": "<string>",
            "environment": "<string>"
          },
          "changeDatabaseConfig": {
            "targets": [
              "<string>"
            ],
            "sheet": "<string>",
            "release": "<string>",
            "type": "TYPE_UNSPECIFIED",
            "ghostFlags": {},
            "enablePriorBackup": true
          },
          "exportDataConfig": {
            "targets": [
              "<string>"
            ],
            "sheet": "<string>",
            "format": "FORMAT_UNSPECIFIED",
            "password": "<string>"
          }
        }
      ],
      "creator": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "planCheckRunStatusCount": {},
      "deployment": {
        "environments": [
          "<string>"
        ],
        "databaseGroupMappings": [
          {
            "databaseGroup": "<string>",
            "databases": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

Query Parameters

​
pageSize
integer

The maximum number of plans to return. The service may return fewer than this value. If unspecified, at most 10 plans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListPlans call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPlans must match the call that provided the page token.

Response

200
application/json

OK

The response is of type object.

GET
/
v1
/
projects
/
{project}
/
plans
{
  "plans": [
    {
      "name": "<string>",
      "issue": "<string>",
      "rollout": "<string>",
      "title": "<string>",
      "description": "<string>",
      "specs": [
        {
          "id": "<string>",
          "createDatabaseConfig": {
            "target": "<string>",
            "database": "<string>",
            "table": "<string>",
            "characterSet": "<string>",
            "collation": "<string>",
            "cluster": "<string>",
            "owner": "<string>",
            "environment": "<string>"
          },
          "changeDatabaseConfig": {
            "targets": [
              "<string>"
            ],
            "sheet": "<string>",
            "release": "<string>",
            "type": "TYPE_UNSPECIFIED",
            "ghostFlags": {},
            "enablePriorBackup": true
          },
          "exportDataConfig": {
            "targets": [
              "<string>"
            ],
            "sheet": "<string>",
            "format": "FORMAT_UNSPECIFIED",
            "password": "<string>"
          }
        }
      ],
      "creator": "<string>",
      "createTime": "2023-11-07T05:31:56Z",
      "updateTime": "2023-11-07T05:31:56Z",
      "planCheckRunStatusCount": {},
      "deployment": {
        "environments": [
          "<string>"
        ],
        "databaseGroupMappings": [
          {
            "databaseGroup": "<string>",
            "databases": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "nextPageToken": "<string>"
}

Path Parameters

​
project
string
required

The project id.

Query Parameters

​
pageSize
integer

The maximum number of plans to return. The service may return fewer than this value. If unspecified, at most 10 plans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

​
pageToken
string

A page token, received from a previous ListPlans call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPlans must match the call that provided the page token.

Response

200
application/json

OK

The response is of type object.