Create License

Overview

This API create additional Guest Image license key.
You can create additional license key only for the licenses which ‘has_license_key’ property is True.

Classification

  • Create

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • POST

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

{
  "license_type": "vCenter Server 5.5 Standard"
}

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 plain String Name of your Guest Image license type as a string. required - Terminate 400, 404

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
202 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 parameter is over the maximum number
500 compute fault
503 internal server error(license out of stock or some error)

HTTP Response Body

Format

{
  "license": "<license>"
}

Response Parameter

Response Parameters
item format   description
license License   License Created.

Sample Request and Response

Sample API Request

Request URI

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

HTTP Request Header

POST /v1.0/b322a85578de48beba0f92acce57869b/licenses HTTP/1.1
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

{
  "license_type": "vCenter Server 5.5 Standard"
}

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

{
    "license": {
        "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"
    }
}