REST Resource: projects

• Resource: Project
  • JSON representation
    • JSON representation
• Methods

Resource: Project

Represents a Project resource.

A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.

JSON representation

{ "id": string, "creationTimestamp": string, "name": string, "description": string, "commonInstanceMetadata": { "fingerprint": string, "items": [ { "key": string, "value": string } ], "kind": string }, "quotas": [ { "metric": enum, "limit": number, "usage": number, "owner": string } ], "usageExportLocation": { "bucketName": string, "reportNamePrefix": string }, "enabledFeatures": [ string ], "selfLink": string, "defaultServiceAccount": string, "xpnProjectStatus": enum, "defaultNetworkTier": enum, "kind": string }

Fields
id	string (fixed64 format) [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.
creationTimestamp	string [Output Only] Creation timestamp in RFC3339 text format.
name	string The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
description	string An optional textual description of the resource.
commonInstanceMetadata	object Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
commonInstanceMetadata.fingerprint	string (bytes format) 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, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. A base64-encoded string.
commonInstanceMetadata.items[]	object 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 262144 bytes (256 KiB).
commonInstanceMetadata.kind	string [Output Only] Type of the resource. Always compute#metadata for metadata.
quotas[]	object [Output Only] Quotas assigned to this project.
quotas[].metric	enum [Output Only] Name of the quota metric.
quotas[].limit	number [Output Only] Quota limit for this metric.
quotas[].usage	number [Output Only] Current usage of this metric.
quotas[].owner	string [Output Only] Owning resource. This is the resource on which this quota is applied.
usageExportLocation	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.
enabledFeatures[]	string Restricted features enabled for use on this project.
selfLink	string [Output Only] Server-defined URL for the resource.
defaultServiceAccount	string [Output Only] Default service account used by VMs running in this project.
xpnProjectStatus	enum [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated.
defaultNetworkTier	enum This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.
kind	string [Output Only] Type of the resource. Always compute#project for projects.

Methods
disableXpnHost	Disable this project as a shared VPC host project.
disableXpnResource	Disable a service resource (also known as 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	Gets the shared VPC host project that this project links to.
getXpnResources	Gets service resources (a.k.a service project) associated with this host project.
listXpnHosts	Lists 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.
setDefaultNetworkTier	Sets the default network tier of the project.
setUsageExportBucket	Enables the usage export feature and sets the usage export bucket where reports are stored.