List image license switch types

Overview

List image license switch types.

Classification

  • List

API Operation Object

  • license switch

Synchronous / Asynchronous

  • synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/extension/license_switch/types

HTTP Request Header

Format

X-Auth-Token: <token_id>
  • User-Agent, Host, Accept fields are automatically added

HTTP Request Body

Format

  • none

Request Parameter

Request Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
token_id Header authentication token string keystone authentication token required - Terminate 401

Response

HTTP Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

    • skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"

Response Code

Response Codes
response code condition
200 normal end
401 unauthorized
500 system error

HTTP Response Body

Format

{

    "license_switch_types": [
        "<license_switch_type>",
        <<repeat>>
    ]

}

Response Parameter

Response Parameters
item format description
license_switch_type
String (0-255 characters)
("WindowsServer_2012R2_Standard_64bit_ComLicense", "WindowsServer_2012_Standard_64bit_ComLicense", "WindowsServer_2008R2_Enterprise_64bit_ComLicense", "WindowsServer_2008R2_Standard_64bit_ComLicense", "WindowsServer_2008_Enterprise_64bit_ComLicense", "WindowsServer_2008_Standard_64bit_ComLicense", "Red_Hat_Enterprise_Linux_6_64bit_BYOL")
Switch destination of the license type

Sample API Request and Response

Sample API Request

Request URI

https://example.com/v2/extension/license_switch/types

Request Header

Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: ajk3adjiown02
Content-Type: application/json

Request Body

  • none

Sample API Response

Response Header

HTTP/1.1 200 OK
  • <response_code>: see "HTTP Responses" section

  • <message>: message based on the response code

    • skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"

Response Body

{

    "license_switch_types": [
        "<license_switch_type>",
        <<repeat>>
    ]

}

Execution Example

HTTP Request

GET /v2/extension/license_switch/types HTTP/1.1
Host: 192.168.11.141:9292
Content-Length: 0
Accept: application/json
X-Auth-Token: 8d1d540bc4cc424783677266ee423802

HTTP Response

HTTP/1.1 200 OK
Content-Length: 137
Content-Type: application/json; charset=UTF-8
Date: Fri, 27 May 2016 09:32:47 GMT

{"license_switch_types": ["WindowsServer_2012R2_Standard_64bit_ComLicense", "WindowsServer_2012_Standard_64bit_ComLicense", "WindowsServer_2008R2_Enterprise_64bit_ComLicense", "WindowsServer_2008R2_Standard_64bit_ComLicense", "WindowsServer_2008_Enterprise_64bit_ComLicense", "WindowsServer_2008_Standard_64bit_ComLicense", "Red_Hat_Enterprise_Linux_6_64bit_BYOL"]}

Error Execution Example

HTTP Request

GET /v2/extension/license_switch/types HTTP/1.1
Host: 192.168.56.250:9292
Accept: application/json
X-Auth-Token: fbb873f41e3f4fff94a709dbabb3bd70

HTTP Response

HTTP/1.1 401 Unauthorized
Content-Length: 44
Content-Type: text/html; charset=UTF-8
Date: Fri, 27 May 2016 09:33:30 GMT

401 Unauthorized

Authentication required.