Consulta de DeHs
Función
Esta API se utiliza para consultar la lista DeH.
URI
GET /v1.0/{project_id}/dedicated-hosts
Tabla 1 describe los parámetros.
Parámetro |
Tipo |
Obligatorio |
Descripción |
---|---|---|---|
project_id |
String |
Sí |
Especifica el ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto. |
Solicitud
- Parámetros de solicitud
Puede agregar parámetros host_type, host_type_name, flavor, dedicated_host_id, state, tenant, availability_zone, name, limit, marker, tags, instance_uuid, released_at o changes-since al URI para filtrar el resultado de la búsqueda,
por ejemplo, /v1.0/{project_id}/dedicated-hosts?host_type={host_type}&state={state}.
Tabla 2 Parámetros de solicitud Parámetro
In
Tipo
Obligatorio
Descripción
dedicated_host_id
query
String
No
Especifica el ID de DeH.
name
query
String
No
Especifica el nombre de DeH.
host_type
query
String
No
Especifica el tipo de DeH.
host_type_name
query
String
No
Especifica el nombre del tipo de DeH.
flavor
query
String
No
Especifica el ID de variante.
state
query
String
No
Especifica el estado de DeH.
El valor puede ser available, fault o released.
tenant
query
String
No
El valor puede ser all o ID de inquilino.
Sólo los usuarios con los permisos de administrador de DeH pueden especificar este parámetro.
availability_zone
query
String
No
Especifica la zona de disponibilidad al que pertenece el DeH.
limit
query
String
No
Especifica el número de registros mostrados por página.
marker
query
String
No
Especifica el identificador del último registro de la página anterior. Si el valor marker no es válido, se devuelve el código de estado 400.
tags
query
String
No
Especifica las etiquetas DeH.
instance_uuid
query
String
No
Especifica el ID del ECS en el DeH.
released_at
query
String
No
Especifica la hora a la que se libera DeH.
changes-since
query
String
No
Filtra la respuesta por fecha y marca de tiempo cuando cambia el estado de DeH. Para ayudar a realizar un seguimiento de los cambios, este parámetro también puede mostrar DeHs eliminados recientemente.
El formato de fecha y hora es ISO 8601:
CCYY-MM-DDThh:mm:ss±hh:mm
Si se incluye el valor hh:mm, la zona horaria se devuelve como el desplazamiento UTC, por ejemplo, 2015-08-27T09:49:58-05:00. Si omite la zona horaria, se asume la zona horaria UTC.
- Solicitud de ejemplo
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts?state=available
Respuesta
- Parámetros de respuesta
Tabla 3 Parámetros de respuesta Parámetro
In
Tipo
Descripción
dedicated_hosts
body
Array of objects
Especifica el DeHs que cumple los criterios de búsqueda.
Para obtener más información, véase Tabla 1.
total
body
Integer
Especifica la cantidad de DeHs que cumple los criterios de búsqueda.
- Ejemplo de respuesta
{ "dedicated_hosts": [ { "dedicated_host_id": "ab910cf0daebca90c4001", "name": "high performance servers1", "auto_placement": "off", "availability_zone": "az1", "host_properties": { "vcpus": 36, "cores": 12, "sockets": 2, "memory": 1073741824, "host_type": "h1", "host_type_name": "High performance", "available_instance_capacities": [ { "flavor": "h1.large" }, { "flavor": "h1.2large" }, { "flavor": "h1.4large" }, { "flavor": "h1.8large" } ] }, "state": "available", "project_id": "9c53a566cb3443ab910cf0daebca90c4", "available_vcpus": 20, "available_memory": 1073201821, "instance_total": 2, "allocated_at": "2016-10-10T14:35:47Z", "released_at": null }, { "dedicated_host_id": "ab910cf0daebca90c4002", "name": "high performance servers2", "auto_placement": "off", "availability_zone": "az1", "host_properties": { "vcpus": 36, "cores": 12, "sockets": 2, "host_type": "h1", "host_type_name": "High performance", "memory": 1073741824, "available_instance_capacities": [ { "flavor": "h1.large" }, { "flavor": "h1.2large" }, { "flavor": "h1.4large" }, { "flavor": "h1.8large" } ] }, "state": "available", "project_id": "9c53a566cb3443ab910cf0daebca90c4", "available_vcpus": 20, "available_memory": 1073101821, "instance_total": 3, "allocated_at": "2016-10-10T14:35:47Z", "released_at": null }, ], "total": 25 }
Código de estado
Véase Códigos de estado.