Projects: setUsageExportBucket

Requires authorization

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. Try it now .

Request

HTTP request

POST https://www.googleapis.com/compute/v1/projects/project/setUsageExportBucket

Parameters

Parameter name	Value	Description
Path parameters
`project`	`string`	Project ID for this request.

Authorization

This request requires authorization with at least one of the following scopes ( read more about authentication and authorization ).

Scope
`https://www.googleapis.com/auth/compute`
`https://www.googleapis.com/auth/devstorage.read_only`
`https://www.googleapis.com/auth/devstorage.read_write`
`https://www.googleapis.com/auth/devstorage.full_control`

Request body

In the request body, supply data with the following structure:

{
  "bucketName": string,
  "reportNamePrefix": string
}

Property name	Value	Description	Notes
`bucketName`	`string`	The name of an existing bucket in Cloud Storage where the usage reports are stored. The Google service account is granted write access to this bucket. This is the full URL to the bucket name, with either `gs://` or `https://storage.googleapis.com/` in front of it.
`reportNamePrefix`	`string`	An optional prefix for the file names of the usage reports stored in the Cloud Storage bucket. If not supplied, defaults to the prefix `usage_gce` . The report is stored as a CSV file named `<report_prefix>_<numeric_project_id>_<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 .

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "compute#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string
}

Property name	Value	Description
`kind`	`string`	[Output Only] Type of the resource. Always `compute#operation` for Operation resources.
`id`	`unsigned long`	[Output Only] Unique identifier for the resource, generated by the server.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`name`	`string`	[Output Only] Name of the resource.
`zone`	`string`	[Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
`clientOperationId`	`string`	[Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
`operationType`	`string`	[Output Only] Type of the operation. Operations include `insert` , `update` , and `delete` .
`targetLink`	`string`	[Output Only] URL of the resource the operation is mutating.
`targetId`	`unsigned long`	[Output Only] Unique target ID which identifies a particular incarnation of the target.
`status`	`string`	[Output Only] Status of the operation. Acceptable values are: " `DONE` ": The operation has finished. " `PENDING` ": The operation is pending and not yet run. " `RUNNING` ": The operation is currently running.
`statusMessage`	`string`	[Output Only] An optional textual description of the current status of the operation.
`user`	`string`	[Output Only] User who requested the operation, for example: `[email protected]` .
`progress`	`integer`	[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
`insertTime`	`string`	[Output Only] The time that this operation was requested. This is in RFC3339 text format.
`startTime`	`string`	[Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
`endTime`	`string`	[Output Only] The time that this operation was completed. This is in RFC3339 text format.
`error`	`object`	[Output Only] If errors occurred during processing of this operation, this field will be populated.
`error. errors[]`	`list`	[Output Only] The array of errors encountered while processing this operation.
`error.errors[]. code`	`string`	[Output Only] The error type identifier for this error.
`error.errors[]. location`	`string`	[Output Only] Indicates the field in the request which caused the error. This property is optional.
`error.errors[]. message`	`string`	[Output Only] An optional, human-readable error message.
`warnings[]`	`list`	[Output Only] If there are issues with this operation, a warning is returned.
`warnings[]. code`	`string`	[Output Only] The warning type identifier for this warning. Acceptable values are: " `DEPRECATED_RESOURCE_USED` ": Indicates that you are using a deprecated resource and should transition to using a more current resource. " `DISK_SIZE_LARGER_THAN_IMAGE_SIZE` ": Indicates that the disk you are creating is larger than the size of the image and you might need to repartition the disk to use the additional space. " `INJECTED_KERNELS_DEPRECATED` ": Indicates that specifying a separate Kernel resource is deprecated. You should transition to using images that contain kernel binaries. " `NEXT_HOP_ADDRESS_NOT_ASSIGNED` ": You did not specify a next hop address for your route. " `NEXT_HOP_CANNOT_IP_FORWARD` ": In order for your route to work correctly, your source and destination virtual machine instances must have canIpForward enabled. See the documentation for more information. " `NEXT_HOP_INSTANCE_NOT_FOUND` ": The next hop instance you specified was not found. Please double check that the instance exists and that you have specified it correctly. " `NEXT_HOP_INSTANCE_NOT_ON_NETWORK` ": The next hop instance you specified was not found on the same network as your route object. Please make sure the instance is part of the same network as your route object. " `NEXT_HOP_NOT_RUNNING` ": The next hop instance you specified is not currently running. Please restart or create the instnce. " `NO_RESULTS_ON_PAGE` ": There were no results for your request. " `REQUIRED_TOS_AGREEMENT` ": You must first agree to the terms of service agreement before you can use this service. " `RESOURCE_NOT_DELETED` ": Your resource couldn't be deleted. It is possible that another resource is currently using this resource. " `UNREACHABLE` ": The Compute Engine service is currently unreachable.
`warnings[]. message`	`string`	[Output Only] The warning type identifier for this warning.
`warnings[]. data[]`	`list`	[Output Only] Metadata for this warning in 'key: value' format.
`warnings[].data[]. key`	`string`	[Output Only] Metadata key for this warning.
`warnings[].data[]. value`	`string`	[Output Only] Metadata value for the specified key.
`httpErrorStatusCode`	`integer`	[Output Only] If operation fails, the HTTP error status code returned, e.g. `404` .
`httpErrorMessage`	`string`	[Output Only] If operation fails, the HTTP error message returned, e.g. `NOT FOUND` .
`selfLink`	`string`	[Output Only] Server-defined fully-qualified URL for this resource.
`region`	`string`	[Output Only] URL of the region where the operation resides. Only available when performing regional operations.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License , and code samples are licensed under the Apache 2.0 License . For details, see our Site Policies .

Last updated June 27, 2014.

Google Compute Engine