Baremetal Server API reference (1.0.0)

Download OpenAPI specification:Download

This manual explains how to use the Smart Data Platform Baremetal Server API

Server

The following API manages to generate, update, list and delete baremetal servers. To get management console information, power on, power off and reboot specified baremetal server, please refer Server Actions.

List Servers

This API lists your baremetal servers information.

path Parameters

tenant_id

required

string <uuid>

ID for 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

404

Not Found

405

Method Not Allowed

413

Payload Too Large

500

Internal Server Error

get/{tenant_id}/servers

https://{api_endpoint}/v2/{tenant_id}/servers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"servers": 
[
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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"
},
{"id": "508f6eca-7387-5004-bfeb-64cbbbba7f19",
"links": 
[
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd18",
"rel": "self"
},
{"href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd18",
"rel": "bookmark"
}
],
"name": "new-server-test2"
}
]
}

Create Server

This API creates additional baremetal servers.

path Parameters

tenant_id

required

string

Request Body schema: application/json

One of

Standard Plan RHEL, CentOS, Ubuntu(without LVM)
Standard Plan RHEL, CentOS, Ubuntu(with LVM)
Standard Plan Windows
Standard Plan ESXi
Custom Plan

server

object

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

413

Payload Too Large

500

Internal Server Error

503

Service Unavailable

post/{tenant_id}/servers

https://{api_endpoint}/v2/{tenant_id}/servers

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"server": 
{"name": "server-test-1",
"networks": 
[
{"uuid": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
"fixed_ip": "10.0.0.100"
}
],
"adminPass": "aabbccddeeff",
"imageRef": "string",
"flavorRef": "0fbc4972-f9e6-448d-9f70-cf0b183c571d",
"availability_zone": "zone1-groupa",
"metadata": 
{"foo": "bar"
},
"key_name": "<name>",
"user_data": "IyEvYmluL2Jhc2gKZWNobyAiS3VtYSBQb3N0IEluc3RhbGwgU2NyaXB0IiA+PiAvaG9tZS9iaWcvcG9zdC1pbnN0YWxsLXNjcmlwdA==",
"personality": 
{"path": "<path>",
"contents": "<contents>"
},
"raid_arrays": 
[
{"primary_storage": true,
"partitions": 
[
{"size": "40G",
"partition_label": "root"
},
{"size": "auto",
"partition_label": "home"
},
{"size": "4G",
"partition_label": "swap"
}
]
}
],
"filesystems": 
[
{"label": "root",
"fs_type": "ext4"
},
{"label": "home",
"mount_point": "/home",
"fs_type": "ext4"
},
{"label": "swap",
"mount_point": "sawap"
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
],
"adminPass": "aabbccddeeff"
}
}

Show Server

This API shows your baremetal server information.

path Parameters

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

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/{tenant_id}/servers/{server_id}

https://{api_endpoint}/v2/{tenant_id}/servers/{server_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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-09-05T06:24:04Z",
"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/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"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": 
{"AnyKey": "AnyValue"
},
"name": "new-server-test",
"progress": 0,
"status": "ACTIVE",
"tenant_id": "aaa8749130bc3d2886d6b9bb3fcb1715",
"updated": "2024-09-05T06:24:04Z",
"user_id": "fake",
"managed_by_service": "dedicated-hypervisor",
"managed_service_resource_id": "8d366088-95d7-4601-ae14-d0f7b37d1896",
"raid_arrays": 
[
{"primary_storage": true,
"raid_card_hardware_id": "string",
"disk_hardware_ids": 
["string"
],
"raid_level": 0,
"partitions": 
[
{"lvm": true,
"size": "string",
"partition_label": "string"
}
],
"example": null
}
],
"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"
}
]
}
}
]
}
}