REST Resource: projects

Resource: ProjectsGetResponse

JSON representation
{
  "resource": {
    object (Project)
  }
}
Fields
resource

object (Project)

Project

Represents a Project resource.

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

JSON representation
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "commonInstanceMetadata": {
    object (Metadata)
  },
  "quotas": [
    {
      object (Quota)
    }
  ],
  "usageExportLocation": {
    object (UsageExportLocation)
  },
  "enabledFeatures": [
    string
  ],
  "selfLink": string,
  "defaultServiceAccount": string,
  "xpnProjectStatus": enum (XpnProjectStatus),
  "defaultNetworkTier": enum (NetworkTier),
  "vmDnsSetting": enum (VmDnsSetting),
  "cloudArmorTier": enum (CloudArmorTier)
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#project

for projects.

id

string (uint64 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)

Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

quotas[]

object (Quota)

[Output Only] Quotas assigned to this project.

usageExportLocation

object (UsageExportLocation)

An optional naming prefix for daily usage reports and the Trusted Cloud Storage bucket where they are stored.

enabledFeatures[]

string

An optional list of restricted features enabled for use on this project.

defaultServiceAccount

string

[Output Only] Default service account used by VMs running in this project.

xpnProjectStatus

enum (XpnProjectStatus)

[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value

HOST

, are differentiated.

defaultNetworkTier

enum (NetworkTier)

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

.

vmDnsSetting

enum (VmDnsSetting)

[Output Only] Default internal DNS setting used by VMs running in this project.

cloudArmorTier

enum (CloudArmorTier)

[Output Only] The Cloud Armor tier for this project. It can be one of the following values:

CA_STANDARD

,

CA_ENTERPRISE_PAYGO

.

If this field is not specified, it is assumed to be

CA_STANDARD

.

UsageExportLocation

The location in Cloud Storage and naming method of the daily usage report. Contains bucketName and report_name prefix.

JSON representation
{
  "bucketName": string,
  "reportNamePrefix": string
}
Fields
bucketName

string

The name of an existing bucket in Cloud Storage where the usage report object is stored. The Trusted Cloud 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

.

reportNamePrefix

string

An optional prefix for the name of the usage report object stored in

bucketName

. If not supplied, defaults to

usage_gce

. 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

Enums
UNSPECIFIED_XPN_PROJECT_STATUS
HOST

VmDnsSetting

Enums
UNSPECIFIED_VM_DNS_SETTING
GLOBAL_DEFAULT
ZONAL_DEFAULT
ZONAL_ONLY

CloudArmorTier

Cloud Armor tier.

Enums
CA_STANDARD Standard protection.
CA_ENTERPRISE_ANNUAL Enterprise tier protection billed annually.
CA_ENTERPRISE_PAYGO Enterprise tier protection billed monthly.

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
(deprecated)

Starting September 29, 2025, you can't use the moveDisk API on new projects.

moveInstance
(deprecated)

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.

setCloudArmorTier

The method compute.v1.ProjectsService.SetCloudArmorTier is not available in Trusted Cloud by S3NS.