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 create 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",
"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": "2024-11-27T01:00:17Z",
"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": "2024-11-27T01:00:17Z",
"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_t