Mudança do nome do BMS
Função
Esta API é usada para alterar o nome de um BMS.
Restrições
O novo nome deve atender aos seguintes requisitos:
conter de 1 a 63 caracteres, consistindo em letras (sem distinção entre maiúsculas e minúsculas), dígitos, sublinhados (_), hifens (-) e pontos (.).
Essa API só pode ser usada para alterar o nome do BMS. O nome do host não será alterado. O novo nome entra em vigor depois que o BMS é reiniciado.
URI
PUT /v1/{project_id}/baremetalservers/{server_id}
A Tabela 1 lista os parâmetros.
Parâmetro |
Obrigatório |
Descrição |
---|---|---|
project_id |
Sim |
Especifica o ID do projeto. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de um ID de projeto. |
server_id |
Sim |
Especifica o ID do BMS. Você pode obter o ID do BMS no console do BMS ou usando a API do Consulta de BMSs (API OpenStack nativo). |
Solicitação
- Parâmetros de solicitação
Parâmetro
Obrigatório
Tipo
Descrição
server
Sim
Object
Especifica a estrutura de dados do BMS. Para mais detalhes, consulte Tabela 2.
- Exemplo de solicitação
1
PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd
1 2 3 4 5 6
{ "server": { "name": "new-server-test" } }
Resposta
- Parâmetros de resposta
Parâmetro
Tipo
Descrição
server
Object
Especifica as informações do BMS. Para mais detalhes, consulte Tabela 3.
Tabela 3 Descrição da estrutura de dados do campo server Parâmetro
Tipo
Descrição
name
String
Especifica o nome do BMS.
id
String
Especifica o ID exclusivo do BMS.
status
String
Especifica o status do BMS.
- ACTIVE: executando, interrompendo, apagando
- BUILD: criando
- ERROR: defeito
- HARD_REBOOT: reiniciando à força
- REBOOT: reiniciando
- DELETED: excluída
- SHUTOFF: interrompido, iniciando, excluindo, reconstruindo, reinstalando SO, falha na reinstalação do SO, congelado
created
String
Especifica a hora em que o BMS foi criado.
O formato de carimbo de data/hora é AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por exemplo, 2019-05-22T03:30:52Z.
updated
String
Especifica a hora em que o BMS foi atualizado pela última vez.
O formato de carimbo de data/hora é AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por exemplo, 2019-05-22T04:30:52Z.
flavor
Object
Especifica o flavor do BMS. Para mais detalhes, consulte Tabela 6.
image
Object
Especifica a imagem do BMS. Para mais detalhes, consulte Tabela 7.
tenant_id
String
Especifica o ID do locatário proprietário do BMS. O valor está no formato UUID.
Este parâmetro especifica o mesmo significado que project_id.
key_name
String
Especifica o nome da chave SSH.
user_id
String
Especifica o ID do usuário ao qual o BMS pertence.
metadata
Object
Especifica os metadados do BMS. Para mais detalhes, consulte Tabela 9.
hostId
String
Especifica o ID do host do BMS.
addresses
Object
Especifica endereços de rede do BMS. Para mais detalhes, consulte Tabela 10.
security_groups
Array of objects
Especifica os grupos de segurança aos quais o BMS pertence. Para mais detalhes, consulte Tabela 12.
links
Array of objects
Especifica os links de atalho do BMS. Para mais detalhes, consulte Tabela 8.
OS-DCF:diskConfig
String
Especifica o método de configuração do disco. Este é um atributo estendido. O valor pode ser:
- MANUAL: a API usa o esquema de particionamento na imagem e no sistema de arquivos para criar um BMS. Se o flavor de destino tiver um disco grande, a API não particionará o espaço em disco restante.
- AUTO: a API usa uma única partição com o mesmo tamanho do disco do flavor de destino para criar um BMS. A API ajusta automaticamente o sistema de arquivos para se adaptar a toda a partição.
OS-EXT-AZ:availability_zone
String
Especifica o AZ onde o BMS está localizado.
OS-EXT-SRV-ATTR:host
String
Especifica o nome do host do BMS. Este é um atributo estendido.
OS-EXT-SRV-ATTR:hypervisor_hostname
String
Especifica o nome do host no qual o BMS está implementado.
OS-EXT-SRV-ATTR:instance_name
String
Especifica o alias do BMS. Este é um atributo estendido.
OS-EXT-STS:power_state
Integer
Especifica o status de energia do BMS. Este é um atributo estendido. Exemplos:
- 0: indica NO STATE.
- 1: indica RUNNING.
- 4: indica SHUTDOWN.
OS-EXT-STS:task_state
String
Especifica o status da tarefa do BMS. Este é um atributo estendido. Exemplos:
- rebooting: o BMS está sendo reiniciado.
- reboot_started: o BMS é normalmente reiniciado.
- reboot_started_hard: o BMS é reiniciado à força.
- powering-off: o BMS está sendo desligado.
- powering-on: o BMS está sendo ligado.
- rebuilding: o BMS está sendo reconstruído.
- scheduling: o BMS está sendo agendado.
- deleting: o BMS está sendo excluído.
OS-EXT-STS:vm_state
String
Especifica o status do BMS. Este é um atributo estendido. Exemplos:
- active: o BMS está funcionando.
- shutoff: o BMS está parado.
- suspended: o BMS está suspenso.
- reboot: o BMS é reiniciado.
OS-SRV-USG:launched_at
String
Especifica a hora em que o BMS foi iniciado. Este é um atributo estendido.
O formato de carimbo de data/hora é ISO 8601, por exemplo, 2019-05-25T03:40:25.000000.
OS-SRV-USG:terminated_at
String
Especifica a hora em que o BMS foi interrompido. Este é um atributo estendido.
O formato de carimbo de data/hora é ISO 8601, por exemplo, 2019-06-25T03:40:25.000000.
os-extended-volumes:volumes_attached
Array of objects
Especifica os discos do EVS anexados ao BMS. Para mais detalhes, consulte Tabela 13.
accessIPv4
String
Este é um atributo reservado.
accessIPv6
String
Este é um atributo reservado.
fault
Object
Especifica a causa da falha do BMS. Para mais detalhes, consulte Tabela 14.
config_drive
String
Este é um atributo reservado.
progress
Integer
Este é um atributo reservado.
description
String
Especifica as informações do BMS.
host_status
String
Especifica o status do host que acomoda o BMS.
- UP: o status de computação nova é normal.
- UNKNOWN: o status da computação nova é desconhecido.
- DOWN: o status da computação nova é anormal.
- MAINTENANCE: a computação nova está no estado de manutenção.
- Cadeia vazia: o BMS não tem informações de host.
OS-EXT-SRV-ATTR:hostname
String
Especifica o nome do host do BMS.
OS-EXT-SRV-ATTR:reservation_id
String
Especifica os IDs reservados do BMS no cenário de criação de lotes.
Quando os BMSs são criados em um lote, eles têm o mesmo reservation_id.
OS-EXT-SRV-ATTR:launch_index
Integer
Especifica a sequência de inicialização do BMS no cenário de criação em lote.
OS-EXT-SRV-ATTR:kernel_id
String
Especifica o UUID da imagem do kernel quando a imagem de AMI é usada. Em outros cenários, deixe esse parâmetro em branco.
OS-EXT-SRV-ATTR:ramdisk_id
String
Especifica o UUID da imagem de Ramdisk quando a imagem de AMI é usada. Em outros cenários, deixe esse parâmetro em branco.
OS-EXT-SRV-ATTR:root_device_name
String
Especifica o nome do dispositivo do disco do sistema BMS, por exemplo, /dev/sdb.
OS-EXT-SRV-ATTR:user_data
String
Especifica o user_data especificado durante a criação do BMS. O valor é codificado usando Base64 ou uma cadeia vazia.
locked
Boolean
Especifica se o BMS está bloqueado.
- true: o BMS está bloqueado.
- false: o BMS não está bloqueado.
tags
Array of strings
Especifica as tags do BMS.
Array of objects
Especifica as tags do sistema do BMS.
enterprise_project_id
String
Especifica o ID do projeto empresarial.
Object
Especifica as informações de agendamento do BMS.
Tabela 4 Descrição da estrutura de dados do campo sys_tags Parâmetro
Tipo
Descrição
key
String
Especifica a chave de tag do sistema.
value
String
Especifica o valor da tag do sistema.
Tabela 5 Descrição da estrutura de dados do campo os:scheduler_hints Parâmetro
Tipo
Descrição
group
Array of strings
Especifica o ID do grupo do BMS no formato UUID.
Tabela 6 Descrição da estrutura de dados do campo flavor Parâmetro
Tipo
Descrição
id
String
Especifica o ID do flavor.
links
Array of objects
Especifica links de atalho do flavor. Para mais detalhes, consulte Tabela 8.
Tabela 7 Descrição da estrutura de dados do campo image Parâmetro
Tipo
Descrição
id
String
Especifica o ID da imagem do BMS.
links
Array of objects
Especifica os links de atalho da imagem do BMS. Para mais detalhes, consulte Tabela 8.
Tabela 8 Descrição da estrutura de dados do campo links Parâmetro
Tipo
Descrição
rel
String
Especifica o nome do marcador do link de atalho. O valor pode ser:
- self: link de recurso que contém o número da versão. É usado quando o rastreamento imediato é necessário.
- bookmark: link de recurso que pode ser armazenado por um longo tempo.
href
String
Especifica o link de atalho correspondente.
Tabela 9 Descrição da estrutura de dados do campo metadata Parâmetro
Tipo
Descrição
key
String
Especifica o par chave e valor dos metadados.
Cada chave ou valor contém no máximo 255 caracteres.
Tabela 10 Descrição da estrutura de dados do campo addresses Parâmetro
Tipo
Descrição
vpc_id
Array of objects
Especifica a VPC usada pelo BMS.
- key: indica o ID da VPC usada pelo BMS.
- value: indica os detalhes da VPC. Para mais detalhes, consulte Tabela 11.
Tabela 11 Descrição da estrutura de dados do campo address Parâmetro
Tipo
Descrição
addr
String
Especifica o endereço IP.
version
Integer
Especifica o tipo do endereço IP. O valor pode ser 4 ou 6.
- 4: o tipo do endereço IP é IPv4.
- 6: o tipo do endereço IP é IPv6.
OS-EXT-IPS-MAC:mac_addr
String
Especifica o endereço MAC. Este é um atributo estendido.
OS-EXT-IPS:type
String
Especifica o modo de atribuição de endereço IP. Este é um atributo estendido.
OS-EXT-IPS:port_id
String
Especifica o ID da porta correspondente ao endereço IP.
Tabela 12 Descrição da estrutura de dados do campo security_groups Parâmetro
Tipo
Descrição
name
String
- Se nenhum grupo de segurança for especificado durante a criação do BMS, o valor default será usado.
- Ao criar um BMS, você precisa especificar o ID de um grupo de segurança existente (no formato UUID).
Tabela 13 Descrição da estrutura de dados do campo os-extended-volumes:volumes_attached Parâmetro
Tipo
Descrição
id
String
Especifica o ID do disco do EVS.
delete_on_termination
Boolean
Especifica se o disco deve ser excluído ao excluir o BMS.
- true: sim
- false: não
Tabela 14 Descrição da estrutura de dados do campo fault Parâmetro
Tipo
Descrição
message
String
Especifica as informações sobre falhas.
code
Integer
Especifica o código de falha.
details
String
Especifica os detalhes da falha.
created
String
Especifica a hora em que ocorreu uma falha.
O formato de carimbo de data/hora é AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por exemplo, 2019-05-22T03:30:52Z.
- Exemplo de resposta
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
{ "server": { "tenant_id": "c685484a8cc2416b97260938705deb65", "addresses": { "08a7715f-7de6-4ff9-a343-95ba4209f24a": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", "OS-EXT-IPS:type": "fixed", "OS-EXT-IPS:port_id": "0c111191-9785-49e6-8b42-66ef2802bd8f", "addr": "192.168.0.107", "version": 4 } ] }, "metadata": { "op_svc_userid": "1311c433dd9b408886f57d695c229cbe" }, "OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "az-dc-1", "links": [ { "rel": "self", "href": "https://bms.az0.dc1.domainname.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" }, { "rel": "bookmark", "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd" } ], "OS-EXT-STS:power_state": 1, "id": "95bf2490-5428-432c-ad9b-5e3406f869dd", "os-extended-volumes:volumes_attached": [ { "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" }, { "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" }, { "id": "86e801c3-acc6-465d-890c-d43ba493f553" }, { "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" } ], "OS-EXT-SRV-ATTR:host": "bms.az-dc-1", "image": { "links": [ { "rel": "bookmark", "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" } ], "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" }, "OS-SRV-USG:terminated_at": null, "accessIPv4": "", "accessIPv6": "", "created": "2017-05-24T06:14:05Z", "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", "key_name": "KeyPair-JX", "flavor": { "links": [ { "rel": "bookmark", "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" } ], "id": "physical.83.medium" }, "security_groups": [ { "name": "0011b620-4982-42e4-ad12-47c95ca495c4" } ], "config_drive": "", "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", "user_id": "1311c433dd9b408886f57d695c229cbe", "name": "bms-83", "progress": 0, "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", "updated": "2017-05-25T03:40:25Z", "status": "ACTIVE" } }
Valores retornados
Valores retornados |
Descrição |
---|---|
200 |
A solicitação foi processada com sucesso. |
Para obter detalhes sobre outros valores retornados, consulte Códigos de status.
Códigos de erro
Consulte Códigos de erro.