- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/licenseCodes/{licenseCode}
The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog
Path parameters
Parameters | |
---|---|
project |
Project ID for this request. |
licenseCode |
Number corresponding to the License code resource to return. |
Request body
The request body must be empty.
Response body
Represents a License Code resource.
A License Code is a unique identifier used to represent a license resource.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "id": string, "name": string, "creationTimestamp": string, "description": string, "selfLink": string, "transferable": boolean, "state": enum, "licenseAlias": [ { "selfLink": string, "description": string } ] } |
Fields | |
---|---|
kind |
[Output Only] Type of resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
name |
[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
description |
[Output Only] Description of this License Code. |
selfLink |
[Output Only] Server-defined URL for the resource. |
transferable |
[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. |
state |
[Output Only] Current state of this License Code. |
licenseAlias[] |
[Output Only] URL and description aliases of Licenses with the same License Code. |
licenseAlias[].selfLink |
[Output Only] URL of license corresponding to this License Code. |
licenseAlias[].description |
[Output Only] Description of this License Code. |
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.licenseCodes.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.