Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Bare Metal Server/ Referência de API/ Visão geral da API

Atualizado em 2023-03-20 GMT+08:00

Ver PDF

Visão geral da API

Introdução sobre a API

APIs OpenStack nativo e APIs de BMS são fornecidas.

Uma combinação dos dois tipos de APIs permite que você use todas as funções fornecidas pelo serviço BMS. Por exemplo, você pode criar um BMS usando uma API OpenStack nativo ou uma API do BMS.

**Tabela 1** Descrição da API
Tipo	Função	Descrição
APIs do BMS	Consulta de informações de versão da API	Consultar a versão da API do serviço BMS.
	Gerenciamento de ciclo de vida	Criar BMSs anuais/mensais e consultar os detalhes do BMS.
	Gerenciamento de status	Alterar o nome do BMS, reinstalar o SO do BMS, iniciar, reiniciar e interromper os BMSs.
	Gerenciamento de flavor	Consultar detalhes de flavors do BMS e informações de flavor estendidas, como ID de flavor, nome de flavor, número de CPUs e dispositivo de inicialização.
	Gerenciamento de NIC	Consultar as informações da NIC do BMS, como o endereço IP e o endereço MAC da NIC.
	Gerenciamento de disco do EVS	Anexar discos do EVS a ou desanexar discos do EVS de um BMS e consultar discos do EVS ligados a um BMS.
	Gerenciamento de metadados	Os metadados do BMS incluem informações básicas do BMS na plataforma em nuvem, como o ID do BMS, o nome do host e as informações da rede. Você pode atualizar os metadados do BMS.
	Gerenciamento de cotas de locatários	Consultar as cotas de todos os recursos de um locatário especificado, incluindo cotas usadas.
	Gerenciamento de senha	Consultar se a redefinição de senha com um clique é suportada. Se sim, você pode redefinir a senha do BMS. Obter e excluir a senha de um BMS do Windows.
	Consulta de status da tarefa	Depois que uma tarefa, como criar um BMS ou anexar discos, é entregue, job_id é retornado, com base no qual você pode consultar o status de execução da tarefa.
APIs OpenStack nativo v2.1	Gerenciamento do ciclo de vida	Consultar detalhes do BMS, consultar BMSs e consultar detalhes sobre BMSs.
	Gerenciamento de status	Iniciar, reiniciar e parar BMSs.
	Gerenciamento de metadados	Os metadados do BMS incluem informações básicas do BMS na plataforma em nuvem, como o ID do BMS, o nome do host e as informações da rede. Você pode consultar, atualizar e excluir metadados do BMS.
	Consulta de endereço IP	Consultar o endereço IP privado de um BMS, incluindo a versão do endereço IP (IPv4 ou IPv6) e o endereço IP específico.
	Consulta de flavor do BMS	Consulta de flavors do BMS: consultar todos os flavors do BMS ou consultar os flavors do BMS especificados por filtros. Consulta de detalhes de flavor do BMS: consultar detalhes sobre um BMS com base no ID de flavor, como o nome de flavor, o número de CPUs e a memória. Consulta de parâmetro extra_specs de um flavor do BMS: o parâmetro extra_specs especifica o par chave-valor de um flavor do BMS. Se você quiser verificar se uma versão do BMS oferece suporte ao provisionamento rápido, chame essa API.
	Consulta da NIC do BMS	Consultar todas as NICs de um BMS ou consultar detalhes sobre uma NIC com base no ID da NIC, como o endereço IP e o endereço MAC da NIC.
	Gerenciamento de disco do EVS	Consultar todos os discos do EVS anexados a um BMS ou consulte detalhes sobre um disco do EVS anexado a um BMS com base no ID do disco, como o diretório de montagem.
	Gerenciamento de chaves SSH	Consultar pares de chaves SSH ou detalhes sobre um par de chaves SSH e criar e excluir pares de chaves SSH.
	Gerenciamento de tags 1D	Adicionar, excluir, modificar e consultar tags 1D de BMSs.

Ao usar as APIs do BMS, você deve usar os pontos de extremidade do serviço BMS.
Ao usar APIs OpenStack nativo, você deve usar os pontos de extremidade registrados pelo serviço ECS.
Na versão atual, conexões HTTP longas não podem ser usadas para chamar APIs OpenStack nativo.

Restrições da API do BMS

**Tabela 2** Restrições da API do BMS
Tipo	API	URI	Restrição
Consulta de versões da API	Consulta de versões da API	GET /	2000 vezes por minuto
Consulta de versões da API	Consulta de uma versão da API	GET /{api_version}	2000 vezes por minuto
Gerenciamento do ciclo de vida	Criação de um BMS	POST /v1/{project_id}/baremetalservers	50 vezes por minuto
	Consulta de detalhes sobre um BMS	GET /v1/{project_id}/baremetalservers/detail	500 vezes por minuto
	Consulta de detalhes sobre os BMSs	GET /v1/{project_id}/baremetalservers/{server_id}	1000 vezes por minuto
Gerenciamento de status	Mudança do nome de um BMS	PUT /v1/{project_id}/baremetalservers/{server_id}	100 vezes por minuto
	Reinstalação do SO do BMS	POST /v1/{project_id}/baremetalservers/{server_id}/reinstallos	50 vezes por minuto
	Iniciar um BMS	POST /v1/{project_id}/baremetalservers/action	50 vezes por minuto
	Reiniciar um BMS	POST /v1/{project_id}/baremetalservers/action	50 vezes por minuto
	Parar um BMS	POST /v1/{project_id}/baremetalservers/action	50 vezes por minuto
Gerenciamento de flavor	Consulta de detalhes do flavor e informações estendidas do flavor	GET /v1/{project_id}/baremetalservers/flavors	500 vezes por minuto
Gerenciamento de NICs	Consulta de NICs do BMS	GET /v1/{project_id}/baremetalservers/{server_id}/os-interface	500 vezes por minuto
Gerenciamento de disco do EVS	Anexar um disco do EVS a um BMS	POST /v1/{project_id}/baremetalservers/{server_id}/attachvolume	100 vezes por minuto
	Desanexar um disco do EVS de um BMS	DELETE /v1/{project_id}/baremetalservers/{server_id}/detachvolume/{attachment_id}	100 vezes por minuto
	Consulta de discos anexados a um BMS	GET /v1/{project_id}/baremetalservers/{server_id}/os-volume_attachments	500 vezes por minuto
Gerenciamento de metadados	Atualização dos metadados de um BMS	POST /v1/{project_id}/baremetalservers/{server_id}/metadata	100 vezes por minuto
Gerenciamento de cotas de locatários	Consulta de cotas de locatários	GET /v1/{project_id}/baremetalservers/limits	500 vezes por minuto
Gerenciamento de senha	Consultar se a redefinição de senha com um clique é suportada	GET /v1/{project_id}/baremetalservers/{server_id}/os-resetpwd-flag	500 vezes por minuto
	Redefinição da senha do BMS com alguns cliques	PUT /v1/{project_id}/baremetalservers/{server_id}/os-reset-password	50 vezes por minuto
	Obtenção da senha de um BMS do Windows	GET /v1/{project_id}/baremetalservers/{server_id}/os-server-password	50 vezes por minuto
	Exclusão da senha de um BMS do Windows	DELETE /v1/{project_id}/baremetalservers/{server_id}/os-server-password	50 vezes por minuto
Gerenciamento de tarefas	Consulta do status da tarefa	GET /v1/{project_id}/jobs/{jobId}	2000 vezes por minuto