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,
  "selfLinkWithId": string,
  "resourceRequirements": {
    "minGuestCpuCount": integer,
    "minMemoryMb": integer
  },
  "appendableToDisk": boolean,
  "removableFromDisk": boolean,
  "allowedReplacementLicenses": [
    string
  ],
  "osLicense": boolean,
  "incompatibleLicenses": [
    string
  ],
  "requiredCoattachedLicenses": [
    string
  ],
  "soleTenantOnly": boolean,
  "multiTenantOnly": boolean,
  "minimumRetention": {
    "seconds": string,
    "nanos": integer
  },
  "updateTimestamp": string
}
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

[Input Only] Deprecated.
resourceRequirements.minGuestCpuCount

integer

[Input Only] Deprecated. This field no longer reflects the minimum number of guest cpus required to use the Instance.
resourceRequirements.minMemoryMb

integer

[Input Only] Deprecated. This field no longer reflects the minimum memory required to use the Instance.
appendableToDisk

boolean

If true, this license can be appended to an existing disk's set of licenses.
removableFromDisk

boolean

If true, this license can be removed from a disk's set of licenses, with no replacement license needed.
allowedReplacementLicenses[]

string

Specifies licenseCodes of licenses that can replace this license. Note: such replacements are allowed even if removableFromDisk is false.
osLicense

boolean

If true, indicates this is an OS license. Only one OS license can be attached to a disk or image at a time.
incompatibleLicenses[]

string

Specifies licenseCodes of licenses that are incompatible with this license. If a license is incompatible with this license, it cannot be attached to the same disk or image.
requiredCoattachedLicenses[]

string

Specifies the set of permissible coattached licenseCodes of licenses that satisfy the coattachment requirement of this license. At least one license from the set must be attached to the same disk or image as this license.
soleTenantOnly

boolean

If true, this license can only be used on VMs on sole tenant nodes.
multiTenantOnly

boolean

If true, this license can only be used on VMs on multi tenant nodes.
minimumRetention

object

If set, this license will be unable to be removed or replaced once attached to a disk until the minimumRetention period has passed.
minimumRetention.seconds

string (int64 format)

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
minimumRetention.nanos

integer

Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
updateTimestamp

string

[Output Only] Last update timestamp in RFC3339 text format.

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.