Dedicated Hypervisor API reference (1.0.0)

Download OpenAPI specification:Download

This manual explains how to use the Smart Data Platform Dedicated Hypervisor API

Servers

The following API manages to create, list and delete specified servers.

List Servers

This API shows your dedicated hypervisors information.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

query Parameters

changes-since	string <date-time> A time/date stamp for when the server last changed status.
marker	string <uuid> UUID of the server at which you want to set a marker. Find servers from the next UUID of the given one.
limit	integer Integer value for the limit of values to return.
name	string Name of the server as a string.
image	string Name of the image in URL format. This parameter can be obtained by GET /images API.
flavor	string Name of the flavor in URL format. This parameter can be obtained by GET /flavors API.
status	string Value of the status of the server so that you can filter on.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/servers

https://{api_endpoint}/v1.0/{tenant_id}/servers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"servers": 
[
{"id": "string",
"name": "new-server-test",
"links": 
[
{"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/f118d06a83ce49938b3cf6bf3400e4cd/servers/347708f8-cd51-42b1-b3c3-a0597514e982",
"rel": "self"
}
],
"baremetal_server": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
],
"name": "new-server-test"
}
}
]
}

Create Server

This API creates additional vsphere server.

path Parameters

tenant_id

required

string

ID of the tenant

Request Body schema: application/json

server

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

post/servers

https://{api_endpoint}/v1.0/{tenant_id}/servers

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"server": 
{"name": "server-test-1",
"description": "string",
"adminPass": "aabbccddeeff",
"imageRef": "b5660a6e-4b46-4be3-9707-6b47221b454f",
"flavorRef": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
"networks": 
[
{"uuid": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"fixed_ip": "10.0.0.100",
"segmentation_id": 2001
},
{"uuid": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"fixed_ip": "10.0.0.101",
"segmentation_id": 2001
}
],
"availability_zone": "zone1-groupa",
"metadata": 
{"foo": "bar"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"server": 
{"id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
"links": 
[
{"rel": "self",
"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931"
},
{"rel": "bookmark",
"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931"
}
],
"name": "new-server-test",
"adminPass": "aabbccddeeff"
}
}

List Servers Detail

This API shows your dedicated hypervisors information in detail.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

query Parameters

changes-since	string <date-time> A time/date stamp for when the server last changed status.
marker	string <uuid> UUID of the server at which you want to set a marker. Find servers from the next UUID of the given one.
limit	integer Integer value for the limit of values to return.
name	string Name of the server as a string.
image	string Name of the image in URL format. This parameter can be obtained by GET /images API.
flavor	string Name of the flavor in URL format. This parameter can be obtained by GET /flavors API.
status	string Value of the status of the server so that you can filter on.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/servers/detail

https://{api_endpoint}/v1.0/{tenant_id}/servers/detail

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"servers": 
[
{"id": "string",
"name": "new-server-test",
"description": "hogehoge",
"hypervisor_type": "vsphere_esxi",
"imageRef": "string",
"image_name": "string",
"status": "ACTIVE",
"baremetal_server": 
{"OS-EXT-STS:power_state": "RUNNING",
"OS-EXT-STS:task_state": "None",
"OS-EXT-STS:vm_state": "ACTIVE",
"OS-EXT-AZ:availability_zone": "zone1-groupa",
"created": "2025-07-03T02:59:43Z",
"flavor": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/flavors/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
]
},
"id": "string",
"image": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
]
},
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
],
"metadata": 
{"My Server Name": "Apache1"
},
"name": "new-server-test",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
"updated": "2025-07-03T02:59:43Z",
"user_id": "fake",
"raid_arrays": 
[
{"primary_storage": true,
"raid_card_hardware_id": "fakeraid_card_uuid",
"disk_hardware_ids": 
["disk0_uuid",
"disk1_uuid",
"disk2_uuid",
"disk3_uuid"
],
"partitions": 
[
{"lvm": true,
"partition_label": "partition_label"
},
{"lvm": false,
"size": "100G",
"partition_label": "var"
}
]
},
{"primary_storage": false,
"raid_card_hardware_id": "fakeraid_card_uuid",
"disk_hardware_ids": 
["disk4_uuid",
"disk5_uuid",
"disk6_uuid",
"disk7_uuid"
],
"raid_level": 10,
"partitions": 
[
{"lvm": true,
"partition_label": "secondary-part1"
}
]
}
],
"lvm_volume_groups": 
[
{"vg_label": "VG_root",
"physical_volume_partition_labels": 
["primary-part1",
"secondary-part1"
],
"logical_volumes": 
[
{"lv_label": "LV_root"
},
{"size": "2G",
"lv_label": "LV_swap"
}
]
}
],
"filesystems": 
[
{"label": "LV_root",
"mount_point": "/",
"fs_type": "xfs"
},
{"label": "var",
"mount_point": "/var",
"fs_type": "xfs"
},
{"label": "LV_swap",
"mount_point": "swap"
}
],
"nic_physical_ports": 
[
{"id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
"mac_addr": "0a:31:c1:d5:6d:9c",
"network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
"plane": "data",
"attached_ports": 
[
{"port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
"network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
"fixed_ips": 
[
{"subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
"ip_address": "192.168.10.2"
}
]
}
],
"hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
],
"chassis-status": 
{"chassis-power": true,
"power-supply": true,
"cpu": true,
"memory": true,
"fan": true,
"disk": 0,
"nic": true,
"system-board": true,
"etc": true
},
"media_attachments": 
[
{"image": 
{"id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/images/3339fd5f-ec06-4ef8-9337-c1c70218a748",
"rel": "bookmark"
}
]
}
}
]
},
"cfgw_connection_status": true
}
]
}

Show Server

This API shows your dedicated hypervisor information.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
server_id required	string <uuid> ID of the server

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

request URL or method is invalid

500

Internal Server Error

get/servers/{server_id}

https://{api_endpoint}/v1.0/{tenant_id}/servers/{server_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"server": 
{"id": "string",
"name": "new-server-test",
"description": "hogehoge",
"hypervisor_type": "vsphere_esxi",
"imageRef": "string",
"image_name": "string",
"status": "ACTIVE",
"baremetal_server": 
{"OS-EXT-STS:power_state": "RUNNING",
"OS-EXT-STS:task_state": "None",
"OS-EXT-STS:vm_state": "ACTIVE",
"OS-EXT-AZ:availability_zone": "zone1-groupa",
"created": "2025-07-03T02:59:43Z",
"flavor": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/flavors/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
]
},
"id": "string",
"image": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
]
},
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
],
"metadata": 
{"My Server Name": "Apache1"
},
"name": "new-server-test",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
"updated": "2025-07-03T02:59:43Z",
"user_id": "fake",
"raid_arrays": 
[
{"primary_storage": true,
"raid_card_hardware_id": "fakeraid_card_uuid",
"disk_hardware_ids": 
["disk0_uuid",
"disk1_uuid",
"disk2_uuid",
"disk3_uuid"
],
"partitions": 
[
{"lvm": true,
"partition_label": "partition_label"
},
{"lvm": false,
"size": "100G",
"partition_label": "var"
}
]
},
{"primary_storage": false,
"raid_card_hardware_id": "fakeraid_card_uuid",
"disk_hardware_ids": 
["disk4_uuid",
"disk5_uuid",
"disk6_uuid",
"disk7_uuid"
],
"raid_level": 10,
"partitions": 
[
{"lvm": true,
"partition_label": "secondary-part1"
}
]
}
],
"lvm_volume_groups": 
[
{"vg_label": "VG_root",
"physical_volume_partition_labels": 
["primary-part1",
"secondary-part1"
],
"logical_volumes": 
[
{"lv_label": "LV_root"
},
{"size": "2G",
"lv_label": "LV_swap"
}
]
}
],
"filesystems": 
[
{"label": "LV_root",
"mount_point": "/",
"fs_type": "xfs"
},
{"label": "var",
"mount_point": "/var",
"fs_type": "xfs"
},
{"label": "LV_swap",
"mount_point": "swap"
}
],
"nic_physical_ports": 
[
{"id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
"mac_addr": "0a:31:c1:d5:6d:9c",
"network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
"plane": "data",
"attached_ports": 
[
{"port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
"network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
"fixed_ips": 
[
{"subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
"ip_address": "192.168.10.2"
}
]
}
],
"hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
],
"chassis-status": 
{"chassis-power": true,
"power-supply": true,
"cpu": true,
"memory": true,
"fan": true,
"disk": 0,
"nic": true,
"system-board": true,
"etc": true
},
"media_attachments": 
[
{"image": 
{"id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/images/3339fd5f-ec06-4ef8-9337-c1c70218a748",
"rel": "bookmark"
}
]
}
}
]
},
"cfgw_connection_status": true
}
}

Delete Server

This API deletes a specified vsphere/hyper-v server. You can delete server when specified server status is ACTIVE or ERROR status.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
server_id required	string <uuid> ID of the server

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

405

request URL or method is invalid

409

Conflict

500

Internal Server Error

503

Service Unavailable

delete/servers/{server_id}

https://{api_endpoint}/v1.0/{tenant_id}/servers/{server_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"badRequest": 
{"code": 400,
"message": "Request Parameter Error:\\n"
}
}

Update Server

This API updates the editable attributes of the specified baremetal server.

path Parameters

tenant_id required	string <uuid> ID for the tenant.
server_id required	string <uuid> ID for the server.

Request Body schema: application/json

server

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

put/servers/{server_id}

https://{api_endpoint}/v1.0/{tenant_id}/servers/{server_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"server": 
{"name": "server-test-1"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"server": 
{"id": "string",
"name": "new-server-test",
"description": "hogehoge",
"hypervisor_type": "vsphere_esxi",
"imageRef": "string",
"image_name": "string",
"status": "ACTIVE",
"baremetal_server": 
{"OS-EXT-STS:power_state": "RUNNING",
"OS-EXT-STS:task_state": "None",
"OS-EXT-STS:vm_state": "ACTIVE",
"OS-EXT-AZ:availability_zone": "zone1-groupa",
"created": "2025-07-03T02:59:43Z",
"flavor": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/flavors/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
]
},
"id": "string",
"image": 
{"id": "string",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
]
},
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
"rel": "bookmark"
}
],
"metadata": 
{"My Server Name": "Apache1"
},
"name": "new-server-test",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
"updated": "2025-07-03T02:59:43Z",
"user_id": "fake",
"raid_arrays": 
[
{"primary_storage": true,
"raid_card_hardware_id": "fakeraid_card_uuid",
"disk_hardware_ids": 
["disk0_uuid",
"disk1_uuid",
"disk2_uuid",
"disk3_uuid"
],
"partitions": 
[
{"lvm": true,
"partition_label": "partition_label"
},
{"lvm": false,
"size": "100G",
"partition_label": "var"
}
]
},
{"primary_storage": false,
"raid_card_hardware_id": "fakeraid_card_uuid",
"disk_hardware_ids": 
["disk4_uuid",
"disk5_uuid",
"disk6_uuid",
"disk7_uuid"
],
"raid_level": 10,
"partitions": 
[
{"lvm": true,
"partition_label": "secondary-part1"
}
]
}
],
"lvm_volume_groups": 
[
{"vg_label": "VG_root",
"physical_volume_partition_labels": 
["primary-part1",
"secondary-part1"
],
"logical_volumes": 
[
{"lv_label": "LV_root"
},
{"size": "2G",
"lv_label": "LV_swap"
}
]
}
],
"filesystems": 
[
{"label": "LV_root",
"mount_point": "/",
"fs_type": "xfs"
},
{"label": "var",
"mount_point": "/var",
"fs_type": "xfs"
},
{"label": "LV_swap",
"mount_point": "swap"
}
],
"nic_physical_ports": 
[
{"id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
"mac_addr": "0a:31:c1:d5:6d:9c",
"network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
"plane": "data",
"attached_ports": 
[
{"port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
"network_id": "9aa93722-1ec4-4912-b813-b975c21460a5",
"fixed_ips": 
[
{"subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
"ip_address": "192.168.10.2"
}
]
}
],
"hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
}
],
"chassis-status": 
{"chassis-power": true,
"power-supply": true,
"cpu": true,
"memory": true,
"fan": true,
"disk": 0,
"nic": true,
"system-board": true,
"etc": true
},
"media_attachments": 
[
{"image": 
{"id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/images/3339fd5f-ec06-4ef8-9337-c1c70218a748",
"rel": "bookmark"
}
]
}
}
]
},
"cfgw_connection_status": true
}
}

Licenses

The following API manages to create, list and delete specified license keys on vsphere/hyper-v.

List Licenses

This API shows your dedicated hypervisors information.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

query Parameters

license_type

string

Example: license_type=vCenter Server 5.5 Standard

license type name as string.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/licenses

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

Create License

This API creates additional vsphere/hyper-v server.

path Parameters

tenant_id

required

string

ID of the tenant

Request Body schema: application/json

license_type

required

string

Name of your guestimage license type as a string.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

post/licenses

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license": 
{"id": "string",
"key": "4fbc-b7a2-03b62b884931aaaaaaaaa",
"assigned_from": "2016-06-01T00:00:00.000Z",
"expires_at": "2016-07-01T00:00:00.000Z",
"license_type": "vCenter.Server 5.5 Standard"
}
}

Delete License

This API deletes a specified vsphere/hyper-v server. You can delete server when specified server status is ACTIVE or ERROR status.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
license_id required	string <uuid> ID for the license.

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

405

request URL or method is invalid

409

Conflict

500

Internal Server Error

503

Service Unavailable

delete/licenses/{license_id}

https://{api_endpoint}/v1.0/{tenant_id}/licenses/{license_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"badRequest": 
{"code": 400,
"message": "Request Parameter Error:\\n"
}
}

LicenseTypes

The following API lists the information to purchase.

List LicenseTypes

This API lists your guestimage license on vsphere/hyper-v servers information.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/license_types

https://{api_endpoint}/v1.0/{tenant_id}/license_types

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"license_types": 
[
{"id": "69fcba22209347719e764e3eba862db1",
"name": "vCenter Server 5.5 Standard",
"has_license_key": true,
"license_switch": false,
"unit": "license",
"description": "vCenter Server 5.5 Standard"
},
{"id": "69fcba22209347719e764e3eba862db2",
"name": "SQL Server 2014 Standard Edition",
"has_license_key": false,
"license_switch": true,
"unit": "vCPU",
"description": "SQL Server 2014 Standard Edition"
},
{"id": "69fcba22209347719e764e3eba862db3",
"name": "Windows Server",
"has_license_key": false,
"license_switch": false,
"unit": "VM",
"description": "Windows Server 2008 - 2012 R2"
}
]
}

Usages

The following API manages to list usages for guestimage.

List Usages

This API lists your guestimage usage information.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

query Parameters

from	string Example: from= date to list usage from. If not specified, the begining of the month is set.
to	string Example: to= date to list usage to. month of the parameter must be the same as 'from'. If not specified, the end of the month is set.
license_type	string Example: license_type=vCenter Server 5.5 Standard license type name as string.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/usages

https://{api_endpoint}/v1.0/{tenant_id}/usages

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenant_id": "9da9116d-cc44-4ad8-aca5-7db398fcb477",
"usages": 
[
{"id": "9da9116d-cc44-4ad8-aca5-7db398fcb477",
"type": "dedicated-hypervisor.guest-image.sql-server-2014-standard",
"value": 4,
"unit": "vCPU",
"name": "SQL Server 2014 Standard Edition",
"description": "SQL Server 2014 Standard Edition",
"has_license_key": false,
"resource_id": "d-cc44-4ad8-aca5-7db398fcb477aaaaaa"
},
{"id": "9da9116d-cc44-4ad8-aca5-7db398fcb478",
"type": "dedicated-hypervisor.guest-image.sql-server-2014-standard",
"value": 6,
"unit": "vCPU",
"name": "SQL Server 2014 Standard Edition",
"description": "SQL Server 2014 Standard Edition",
"has_license_key": false,
"resource_id": "d-cc44-4ad8-aca5-7db398fcb477bbbbbb"
},
{"id": "9da9116d-cc44-4ad8-aca5-7db398fcb479",
"type": "dedicated-hypervisor.guest-image.windows-server",
"value": 3,
"unit": "VM",
"name": "Windows Server",
"description": "Windows Server 2008 - 2012 R2",
"has_license_key": false,
"resource_id": "d-cc44-4ad8-aca5-cc44"
}
]
}

Show Usage Histories

This API shows your |guestimage| usage history information.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
usage_id required	string Example: d22fe95e-f9f5-4cd2-a669-75439eaeada7 Usage ID. This parameter can be retrieved by List Usage API.

query Parameters

from	string Example: from= date to list usage from. If not specified, the begining of the month is set.
to	string Example: to= date to list usage to. month of the parameter must be the same as 'from'. If not specified, the end of the month is set.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/usages/{usage_id}/histories

https://{api_endpoint}/v1.0/{tenant_id}/usages/{usage_id}/histories

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenant_id": "9da9116d-cc44-4ad8-aca5-7db398fcb477",
"unit": "VM",
"resource_id": "9da9116d-cc44-4ad8-aca5-7db398fcb488",
"license_type": "Windows Server",
"histories": 
[
{"time": "2015-05-06 11:00:00",
"value": 0
},
{"time": "2015-05-06 12:00:00",
"value": 1
},
{"time": "2015-05-06 13:00:00",
"value": 1
},
{"time": "2015-05-06 14:00:00",
"value": 3
}
]
}

Server Actions

The following API manages to add license to vm, get result for add license to vm, deploy guest image and get result for deploy guest image.

Server Actions

The following API manages to add license to vm, get result for add license to vm, deploy guest image and get result for deploy guest image.

Action	Description
Add License to VM	Add license meta-information to the VM on the specified hypervisor.
Get Result for add license to VM	Shows the result for add-license-to-vm API.
Deploy GuestImage	Deploy GuestImage to the specified hypervisor. (available only for deployment to ESXi not managed by vCenter)
Get Result for deploy GuestImage	Shows the result for deploy-guestimage API.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID for the tenant.
server_id required	string <uuid> ID for the server.

Request Body schema: application/json

One of

Add License to VM by vm_id
Add License to VM by vm_name
Get Result for add license to VM
Deploy GuestImage
Get Result for deploy GuestImage

add-license-to-vm

required

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

request URL or method is invalid

500

Internal Server Error

post/servers/{server_id}/action

https://{api_endpoint}/v1.0/{tenant_id}/servers/{server_id}/action

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"add-license-to-vm": 
{"vm_id": "cd898512-d145-4198-a256-9c1351cd4fcf",
"license_types": 
["Windows Server",
"SQL Server Standard 2014"
]
}
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"job_id": "b4f888dc2b9d4c41bb769cbd"
}

CFGW Connection

The following API manages to get and update CFGW Connection.

Show CFGW Connection

This API shows the connection status between your dedicated hypervisor and common function gateway network

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
server_id required	string <uuid> ID of the server

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

request URL or method is invalid

500

Internal Server Error

get/servers/{server_id}/cfgw_connection

https://{api_endpoint}/v1.0/{tenant_id}/servers/{server_id}/cfgw_connection

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"server": 
{"id": "string",
"cfgw_connection": 
{"status": true,
"error_type": null,
"last_established_at": "2022-07-20T06:26:00.000Z",
"updated_at": "2022-07-20T06:26:00.000Z"
}
}
}

Update CFGW Connection Status

This API updates the connection status between your dedicated hypervisor and common function gateway network

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
server_id required	string <uuid> ID of the server

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

405

request URL or method is invalid

500

Internal Server Error

post/servers/{server_id}/cfgw_connection

https://{api_endpoint}/v1.0/{tenant_id}/servers/{server_id}/cfgw_connection

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"server": 
{"id": "string",
"cfgw_connection": 
{"status": true,
"error_type": null,
"last_established_at": "2022-07-20T06:26:00.000Z",
"updated_at": "2022-07-20T06:26:00.000Z"
}
},
"info": "Successfully updated"
}

vCenter

The following API manages to register, list, update and delete the specified vCenter information.

List Registered vCenters Information

This API shows your registered vCenter information.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/vcenters

https://{api_endpoint}/v1.0/{tenant_id}/vcenters

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"vcenters": 
[
{"id": "string",
"link_local_address": "169.254.127.132",
"metering_health": false,
"metering_health_error_type": "CONNECTION_ERROR",
"version": "8.0.2.00400",
"instance_name": "production-vcenter",
"license_id": "bac8b95f-77b9-439a-ac43-53566502ff3f"
}
]
}

Register vCenter Information

This API registers your vCenter information.

path Parameters

tenant_id

required

string

ID of the tenant

Request Body schema: application/json

vcenter

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

post/vcenters

https://{api_endpoint}/v1.0/{tenant_id}/vcenters

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"vcenter": 
{"link_local_address": "169.254.127.132",
"password": "hogehoge",
"license_id": "bac8b95f-77b9-439a-ac43-53566502ff3f"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"vcenter": 
{"id": "5eee721d-7390-4ed7-858b-2997e72e799e",
"link_local_address": "169.254.127.132",
"metering_health": null,
"metering_health_error_type": null,
"version": null,
"instance_name": null,
"license_id": "bac8b95f-77b9-439a-ac43-53566502ff3f"
}
}

Update Registered vCenter Information

This API updates the specified registered vCenter information.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
vcenter_id required	string <uuid> ID of the vCenter

Request Body schema: application/json

vcenter

object

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

405

request URL or method is invalid

409

Conflict

500

Internal Server Error

503

Service Unavailable

put/vcenters/{vcenter_id}

https://{api_endpoint}/v1.0/{tenant_id}/vcenters/{vcenter_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"vcenter": 
{"link_local_address": "169.254.127.132",
"password": "hogehoge",
"license_id": "bac8b95f-77b9-439a-ac43-53566502ff3f"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"vcenter": 
{"id": "5eee721d-7390-4ed7-858b-2997e72e799e",
"link_local_address": "169.254.127.132",
"metering_health": null,
"metering_health_error_type": null,
"version": null,
"instance_name": null,
"license_id": "bac8b95f-77b9-439a-ac43-53566502ff3f"
}
}

Delete Registered vCenter Information

This API deletes the specified registered vCenter information.

path Parameters

tenant_id required	string Example: aaa8749130bc3d2886d6b9bb3fcb1715 ID of the tenant
vcenter_id required	string <uuid> ID of the vCenter

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

405

request URL or method is invalid

409

Conflict

500

Internal Server Error

503

Service Unavailable

delete/vcenters/{vcenter_id}

https://{api_endpoint}/v1.0/{tenant_id}/vcenters/{vcenter_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"badRequest": 
{"code": 400,
"message": "Request Parameter Error:\\n"
}
}

List Available IP Addresses of vCenter

This API shows IP addresses that you can assign to your vCenter.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/vcenters/addresses

https://{api_endpoint}/v1.0/{tenant_id}/vcenters/addresses

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"addresses": 
[
{"address": "169.254.127.132",
"in_use": true
},
{"address": "169.254.127.133",
"in_use": false
},
{"address": "169.254.127.134",
"in_use": false
}
]
}

vSphere Contracts

The following API manages to create, list and update the contract of long term discount for vSphere ESXi.

List vSphere Contracts

This API shows your contracts of long term discount for vSphere ESXi.

In addition of the content of your contract, you can show the total number of cores of your vSphere ESXi servers and the histories of the monthly cores of your contract.

path Parameters

tenant_id

required

string

Example: aaa8749130bc3d2886d6b9bb3fcb1715

ID of the tenant

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

get/vsphere_contracts

https://{api_endpoint}/v1.0/{tenant_id}/vsphere_contracts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"vsphere_contracts": 
[
{"contract_year": 1,
"contract_renewal": true,
"cores": 16,
"start_month": "2025-10",
"end_month": "2026-09",
"pending_cores": 32,
"cores_in_next_month": 48
}
],
"all_server_cores": 64,
"vsphere_contracts_histories": 
[
{"month": "2025-10",
"vsphere_contracts_summaries": 
[
{"contract_year": 1,
"cores": 16
}
]
},
{"month": "2025-11",
"vsphere_contracts_summaries": 
[
{"contract_year": 1,
"cores": 48
}
]
}
]
}

Manage vSphere Contracts

This API is used to manage (create, update, or delete) a long-term discount contract and its commitment for vSphere ESXi.

The behavior of the API varies based on the contract's status.

1. If no contract has been created or has not started yet

When there is no existing contract or the contract has not started yet, the API functions as a create/update/delete API for a new contract starting the next month.

Create: If no contract exists, a new contract will be created with the initial commitment with the specified cores.
Update: If a contract already exists, the cores of its commitment will be updated to the specified cores.
Delete: If a contract exists and 0 cores are specified, the contract will be deleted.

2. If a contract already exists and has started (not in the final month)

When a contract exists and has already started but is not in its final month, the API functions as a create/update/delete API for its commitment that will be added starting from the next month.

Create: If no commitment for the next month has been added, a new one will be created with the specified cores.
Update: If a commitment for the next month has already been added in the current month, its cores will be updated with the specified cores.
Delete: If a commitment for the next month has already been added and 0 cores are specified, the commitment will be deleted.

3. If a contract exists and it is in its final month

If the contract is in its final month, the API functions in the same way as case 1 (If the contract has not been created or has not started yet), with the following exceptions:

Create: Before creating a new contract, contract_renewal of current contract must be set to true using the PUT vSphere Contracts API.
Delete: Before deleting a new contract, contract_renewal of current contract must be set to false using the PUT vSphere Contracts API.

path Parameters

tenant_id

required

string

ID of the tenant

Request Body schema: application/json

vsphere_contract

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

post/vsphere_contracts

https://{api_endpoint}/v1.0/{tenant_id}/vsphere_contracts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"vsphere_contract": 
{"contract_year": 1,
"cores": 16
}
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"vsphere_contract": 
{"contract_year": 1,
"contract_renewal": true,
"cores": 16,
"start_month": "2025-10",
"end_month": "2026-09",
"pending_cores": 32,
"cores_in_next_month": 48
}
}

Enable/Disable Contract Renewal

This API is used to enable/disable contract renewal of long term discount for vSpehre ESXi.

path Parameters

tenant_id

required

string

ID of the tenant

Request Body schema: application/json

vsphere_contract

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

put/vsphere_contracts

https://{api_endpoint}/v1.0/{tenant_id}/vsphere_contracts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"vsphere_contract": 
{"contract_year": 1,
"contract_renewal": true
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"vsphere_contract": 
{"contract_year": 1,
"contract_renewal": true,
"cores": 16,
"start_month": "2025-10",
"end_month": "2026-09",
"pending_cores": 32,
"cores_in_next_month": 48
}
}