Projects

Represents a Project resource. See the Projects documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.

{
  "kind": "compute#project",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "commonInstanceMetadata": {
    "kind": "compute#metadata",
    "fingerprint": bytes,
    "items": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "quotas": [
    {
      "metric": string,
      "limit": double,
      "usage": double
    }
  ],
  "usageExportLocation": {
    "bucketName": string,
    "reportNamePrefix": string
  },
  "enabledFeatures": [
    string
  ],
  "selfLink": string,
  "defaultServiceAccount": string,
  "xpnProjectStatus": string
}
Property name Value Description Notes
commonInstanceMetadata nested object Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
commonInstanceMetadata.fingerprint bytes Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
commonInstanceMetadata.items[] list Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
commonInstanceMetadata.items[].key string Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
commonInstanceMetadata.items[].value string Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
commonInstanceMetadata.kind string [Output Only] Type of the resource. Always compute#metadata for metadata.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
defaultServiceAccount string [Output Only] Default service account used by VMs running in this project.
description string An optional textual description of the resource. This is defined by the client when the resource is created.
enabledFeatures[] list Restricted features enabled for use on this project.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
kind string [Output Only] Type of the resource. Always compute#project for projects.
name string The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
quotas[] list [Output Only] Quotas assigned to this project.
quotas[].limit double [Output Only] Quota limit for this metric.
quotas[].metric string [Output Only] Name of the quota metric.
quotas[].usage double [Output Only] Current usage of this metric.
usageExportLocation nested object The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
usageExportLocation.bucketName string The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
usageExportLocation.reportNamePrefix string An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
xpnProjectStatus string [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated.

Methods

The following are valid methods for Project resources.

disableXpnHost
Disable this project as a shared VPC host project.
disableXpnResource
Disable a serivce resource (a.k.a service project) associated with this host project.
enableXpnHost
Enable this project as a shared VPC host project.
enableXpnResource
Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.
get
Returns the specified Project resource.
getXpnHost
Get the shared VPC host project that this project links to. May be empty if no link exists.
getXpnResources
Get service resources (a.k.a service project) associated with this host project.
listXpnHosts
List all shared VPC host projects visible to the user in an organization.
moveDisk
Moves a persistent disk from one zone to another.
moveInstance
Moves an instance and its attached persistent disks from one zone to another.
setCommonInstanceMetadata
Sets metadata common to all instances within the specified project using the data included in the request.
setUsageExportBucket
Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

Send feedback about...

Compute Engine