Method: licenses.get

Returns the specified License resource.

Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/global/licenses/{license}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
license

string

Name of the License resource to return.

Request body

The request body must be empty.

Response body

Represents a License resource.

A License represents billing and aggregate usage data for public and marketplace images.

Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "name": string,
  "chargesUseFee": boolean,
  "id": string,
  "licenseCode": string,
  "creationTimestamp": string,
  "description": string,
  "transferable": boolean,
  "selfLink": string,
  "resourceRequirements": {
    "minGuestCpuCount": integer,
    "minMemoryMb": integer
  }
}
Fields
kind

string

[Output Only] Type of resource. Always compute#license for licenses.
name

string

Name of the resource. The name must be 1-63 characters long and comply with RFC1035.
chargesUseFee

boolean

[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
licenseCode

string (uint64 format)

[Output Only] The unique code used to attach this license to images, snapshots, and disks.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
description

string

An optional textual description of the resource; provided by the client when the resource is created.
transferable

boolean

If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.
resourceRequirements

object
resourceRequirements.minGuestCpuCount

integer

Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.
resourceRequirements.minMemoryMb

integer

Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute.readonly
  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.licenses.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.