Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Bare Metal Server/ Referencia de la API/ Descripción de las API

Actualización más reciente 2023-03-20 GMT+08:00

Ver PDF

Descripción de las API

Introducción a la API

Se proporcionan las API nativas de OpenStack y las API de BMS APIs.

Una combinación de los dos tipos de API le permite utilizar todas las funciones proporcionadas por el servicio BMS. Por ejemplo, puedes crear un BMS usando una API nativa de OpenStack o una API de BMS.

**Tabla 1** Descripción de la API
Tipo	Función	Descripción
API de BMS	Consulta de información de versión de API	Consulta la versión de la API del servicio BMS.
	Gestión del ciclo de vida	Crea BMS anuales/mensuales y consulta los detalles de BMS.
	Gestión de estado	Cambia el nombre del BMS, vuelve a instalar el SO del BMS, inicia, reinicia y detiene los BMS.
	Gestión de variante	Consulta los detalles de la variante de BMS y la información extendida de la variante, como el ID de la variante, el nombre de la variante, el número de CPU y el dispositivo de arranque.
	Gestión de NIC	Consulta la información de la NIC del BMS, como la dirección IP y la dirección de MAC de la NIC.
	Gestión de discos de EVS	Adjunta los discos de EVS o desvincula los discos EVS de un BMS y consulta los discos de EVS conectados a un BMS.
	Gestión de metadatos	Los metadatos de BMS incluyen la información básica de BMS en la plataforma en la nube, tal como el ID de BMS, el nombre de host y la información de red. Puede actualizar los metadatos del BMS.
	Gestión de la cuota de tenant	Consulta las cuotas de todos los recursos de un tenant especificado, incluidas las cuotas usadas.
	Gestión de contraseñas	Consulta si se admite el restablecimiento de contraseña con un solo clic. En caso afirmativo, puede restablecer la contraseña del BMS. Obtiene y elimina la contraseña de un BMS de Windows.
	Consulta de estado de tarea	Después de entregar una tarea, como crear un BMS o adjuntar los discos, se devuelve job_id, en función del cual puede consultar el estado de ejecución de la tarea.
API nativa de OpenStack v2.1	Gestión del ciclo de vida	Consulta los detalles de BMS, consulta los BMS y consulta los detalles sobre BMS.
	Gestión de estado	Inicia, reinicia y detiene los BMS.
	Gestión de metadatos	Los metadatos de BMS incluyen la información básica de BMS en la plataforma en la nube, tal como el ID de BMS, el nombre de host y la información de red. Puede consultar, actualizar y eliminar los metadatos de BMS.
	Consulta de dirección IP	Consulta la dirección IP privada de un BMS, incluida la versión de la dirección IP (IPv4 o IPv6) y la dirección IP específica.
	Consulta de la variante de BMS	Consulta de las variantes de BMS: consulta todas las variantes de BMS o consulta las variantes de BMS especificadas por filtros. Consulta de los detalles de la variante del BMS: Consulta los detalles sobre un BMS basado en el ID de la variante, como el nombre de la variante, el número de CPU y la memoria. Consulta del parámetro extra_specs de una variante de BMS: el parámetro extra_specs especifica el par de clave y valor de una variante de BMS. Si desea comprobar si una variante de BMS admite el aprovisionamiento rápido, invoque a esta API.
	Consulta de la NIC de BMS	Consulta todas las NIC de un BMS o consulta detalles sobre una NIC basada en el ID de NIC, como la dirección IP y la dirección de MAC de la NIC.
	Gestión de discos de EVS	Consulta todos los discos de EVS conectados a un BMS o consulta los detalles sobre un disco de EVS conectado a un BMS basándose en el ID de disco, como el directorio de montaje.
	Gestión de claves de SSH	Consulta los pares de claves de SSH o los detalles sobre un par de claves SSH, y crear y eliminar los pares de claves SSH.
	Gestión de etiquetas de 1D	Agrega, elimina, modifica y consulta las etiquetas 1D de BMS.

Al utilizar las API de BMS, debe utilizar el punto de conexión del servicio de BMS.
Al utilizar las API nativas de OpenStack, debe utilizar el punto de conexión registrado por el servicio de ECS.
En la versión actual, las conexiones de HTTP largas no se pueden usar para invocar a las API nativas de OpenStack.

Restricciones de API de BMS

**Tabla 2** Restricciones de API de BMS
Tipo	API	URI	Restricciones
Consulta de la versión de API	Consulta de versiones de API	GET /	2000 veces por minuto
Consulta de la versión de API	Consulta de una versión de API	GET /{api_version}	2000 veces por minuto
Gestión del ciclo de vida	Creación de un BMS	POST /v1/{project_id}/baremetalservers	50 veces por minuto
	Consulta de detalles sobre un BMS	GET /v1/{project_id}/baremetalservers/detail	500 veces por minuto
	Consulta de detalles sobre los BMS	GET /v1/{project_id}/baremetalservers/{server_id}	1000 veces por minuto
Gestión de estado	Cambio del nombre de un BMS	PUT /v1/{project_id}/baremetalservers/{server_id}	100 veces por minuto
	Reinstalación del SO de BMS	POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos	50 veces por minuto
	Inicio de un BMS	POST /v1/{project_id}/baremetalservers/action	50 veces por minuto
	Reinicio de un BMS	POST /v1/{project_id}/baremetalservers/action	50 veces por minuto
	Detención de un BMS	POST /v1/{project_id}/baremetalservers/action	50 veces por minuto
Gestión de variante	Consulta de detalles de la variante y de información de la variante extendida	GET /v1/{project_id}/baremetalservers/flavors	500 veces por minuto
Gestión de NIC	Consulta de las NIC de BMS	GET /v1/{project_id}/baremetalservers/{server_id}/os-interface	500 veces por minuto
Gestión de discos de EVS	Conexión de un disco de EVS a un BMS	POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume	100 veces por minuto
	Conexión de un disco de EVS de un BMS	DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id}	100 veces por minuto
	Consulta de los discos asociados a un BMS	GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments	500 veces por minuto
Gestión de metadatos	Actualización de los metadatos de un BMS	POST /v1/{project_id}/baremetalservers/{server_id}/metadata	100 veces por minuto
Gestión de la cuota de tenant	Consulta de las cuotas de tenant	GET /v1/{project_id}/baremetalservers/limits	500 veces por minuto
Gestión de contraseñas	Consulta de si se admite el restablecimiento de la contraseña con un solo clic	GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag	500 veces por minuto
	Restablecimiento de la contraseña del BMS con unos clics	PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password	50 veces por minuto
	Obtención de la contraseña de un BMS de Windows	GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password	50 veces por minuto
	Eliminación de la contraseña de un BMS de Windows	DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password	50 veces por minuto
Gestión de tareas	Consulta del estado de la tarea	GET /v1/{project_id}/jobs/{jobId}	2000 veces por minuto