Method: projects.capacityPlans.get

Returns information about the capacity plan.

HTTP request

GET https://capacityplanner.googleapis.com/v1beta/{name=projects/*/capacityPlans/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the capacity plan to retrieve. Format: projects/{project}/capacityPlans/{capacityPlan}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of CapacityPlan.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/devstorage.full_control

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • capacityplanner.capacityPlans.get

For more information, see the IAM documentation.