List Licenses¶

Overview¶

This API lists your Guest Image license key information.

Classification¶

List

API Operation Object¶

License

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{api_endpoint}/v1.0/{tenant_id}/licenses

HTTP Request Header¶

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body¶

Format¶

none

Request Parameter¶

Input Parameters¶
name	style	format	description	required/optional	default value	action for invalid parameter	response code for invalid parameter
tenant_id	URL	UUID	ID for the tenant.	required	-	Terminate	403, 404
license_type	query	String	license type name as string.	optional	-	Terminate	400

Response¶

HTTP Response Header¶

Format¶

HTTP/1.1 200 OK

<response_code>: see “HTTP Responses” section
<message>: message based on the response code

Response Code¶

Response Codes¶
response code	condition
200	normal end
400	specified parameter is invalid
401	unauthorized
403	tenant is not available
404	not found a specified item
405	request URL or method is invalid
413	any parameter is over the maximum number
500	compute fault

HTTP Response Body¶

Format¶

{
  "licenses":
}

Response Parameter¶

Response Parameters¶
item	format		description
licenses	datatype_licenses Array		List of licenses

Sample Request and Response¶

Sample API Request¶

Request URI¶

https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/b322a85578de48beba0f92acce57869b/license

HTTP Request Header¶

GET /v1.0/b322a85578de48beba0f92acce57869b/licenses
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Content-Type: application/json
Accept: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

HTTP Request Body¶

none

Sample API Response¶

HTTP Response Header¶

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

HTTP Response Body¶

{
    "licenses": [
        {
            "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
            "key": "4fbc-b7a2-03b62b884931aaaaaaaaa",
            "assigned_from": "2016-06-01T00:00:00Z",
            "expires_at": "2016-07-01T00:00:00Z",
            "license_type": "vCenter Server 5.5 Standard"
        },
        {
            "id": "05184ba3-00ba-4fbc-b7a2-03b62b884932",
            "key": "4fbc-b7a2-03b62b884931aaaaaabbb",
            "assigned_from": "2016-06-01T10:00:00Z",
            "expires_at": "2016-07-01T10:00:00Z",
            "license_type": "vCenter Server 5.5 Standard"
        }
    ]
}

Delete License

2.3. LicenseTypes