Consulta de detalhes do BMS
Função
Essa API é usada para consultar detalhes do BMS.
As informações que podem ser consultadas incluem o modo de cobrança do BMS e se o BMS está congelado.
URI
Tabela 1 lista os parâmetros GET.
/v1/{project_id}/baremetalservers/{server_id}
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 de 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
Resposta
- Parâmetros de resposta
Parâmetro
Tipo
Descrição
server
Object
Especifica as informações do BMS. Para mais detalhes, consulte Tabela 2.
Tabela 2 Descrição da estrutura de dados do campo server Parâmetro
Tipo
Descrição
id
String
Especifica o ID do BMS no formato UUID.
user_id
String
Especifica o ID do usuário ao qual o BMS pertence. O valor está no formato UUID.
name
String
Especifica o nome de BMS.
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.
O formato de carimbo de data/hora é AAAA-MM-DDTHH:MM:SSZ (ISO 8601), por exemplo, 2019-05-22T04:30:52Z.
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.
hostId
String
Especifica o ID do host do BMS.
addresses
Map<String,Array of address objects>
Especifica a VPC usada pelo BMS.
key: indica o ID da VPC usado pelo BMS.
value: indica os detalhes da VPC.
key_name
String
Especifica o par de chaves usado para autenticar o BMS.
image
Object
Especifica a imagem do BMS. Para mais detalhes, consulte Tabela 4.
flavor
Object
Especifica o flavor do BMS. Para mais detalhes, consulte Tabela 6.
security_groups
Array of objects
Especifica os grupos de segurança aos quais o BMS pertence. Para mais detalhes, consulte Tabela 7.
accessIPv4
String
Este é um atributo reservado.
accessIPv6
String
Este é um atributo reservado.
status
String
Especifica o status do BMS.
Intervalo de valores:
- 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
progress
Integer
Este é um atributo reservado.
config_drive
String
Especifica se deve configurar a partição da unidade de config para o BMS.
O valor pode ser True ou uma cadeia vazia.
metadata
MetadataList object
Especifica os metadados do BMS. Para mais detalhes, consulte Tabela 11.
NOTA:Os metadados incluem campos padrão do sistema e os campos definidos pelos usuários.
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 estável. 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-EXT-SRV-ATTR:host
String
Especifica o nome do host do BMS. Este é um atributo estendido.
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-SRV-ATTR:hypervisor_hostname
String
Especifica o nome do host no qual o BMS está implementado.
OS-EXT-AZ:availability_zone
String
Especifica a AZ onde o BMS está localizado.
OS-DCF:diskConfig
String
Especifica a 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.
fault
Object
Especifica a causa da falha do BMS. Para mais detalhes, consulte Tabela 8.
OS-SRV-USG:launched_at
String
Especifica a hora em que o BMS foi iniciado.
O formato do carimbo de data/hora é ISO 8601, por exemplo, 2019-05-22T03:23:59.000000.
OS-SRV-USG:terminated_at
String
Especifica a hora em que o BMS foi excluído.
O formato do carimbo de data/hora é ISO 8601, por exemplo, 2019-05-22T04:23:59.000000.
os-extended-volumes:volumes_attached
Array of objects
Especifica os discos anexados ao BMS. Para mais detalhes, consulte Tabela 9.
Descrição
Cadeia
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 do BMS, por exemplo, /dev/sda.
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.
- verdadeiro: o BMS está bloqueado.
- falso: o BMS não está bloqueado.
tags
Array of strings
Especifica as tags do BMS.
os:scheduler_hints
Object
Especifica as informações de agendamento do BMS. Para mais detalhes, consulte Tabela 10.
enterprise_project_id
String
Especifica o ID do projeto corporativo ao qual o BMS pertence.
sys_tags
Array of objects
Especifica as tags do sistema do BMS. Para mais detalhes, consulte Tabela 12.
Tabela 3 Descrição da estrutura de dados do campo address Parâmetro
Tipo
Descrição
version
String
Especifica a versão do endereço IP.
- 4: indica IPv4.
- 6: indica IPv6.
addr
String
Especifica o endereço IP.
OS-EXT-IPS:type
String
Especifica o tipo de endereço IP.
- fixed: indica o endereço IP privado.
- floating: indica o EIP.
OS-EXT-IPS-MAC:mac_addr
String
Especifica o endereço MAC.
OS-EXT-IPS:port_id
String
Especifica o ID da porta correspondente ao endereço IP.
Tabela 4 Descrição da estrutura de dados do campo image Parâmetro
Tipo
Descrição
id
String
Especifica o ID da imagem no formato UUID.
name
String
Especifica o nome de imagem.
__os_type
String
Especifica o tipo de imagem.
O valor pode ser:
- Linux (incluindo SUSE, Red Hat, CentOS, Oracle Linux, EulerOS e Ubuntu)
- Windows
- Other (ESXi)
links
Array of objects
Especifica links de atalho da imagem. Para mais detalhes, consulte Tabela 5.
Tabela 5 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.
href
String
Especifica o link de atalho correspondente.
Tabela 6 Descrição da estrutura de dados do campo flavor Parâmetro
Tipo
Descrição
id
String
Especifica o ID de flavor do BMS.
name
String
Especifica o nome do flavor do BMS.
disk
String
Especifica o tamanho do disco do sistema em flavors do BMS. O valor 0 indica que o tamanho do disco não é limitado.
vcpus
String
Especifica o número de núcleos de CPU no flavor do BMS.
ram
String
Especifica o tamanho da memória (MB) no flavor do BMS.
Tabela 7 Descrição da estrutura de dados do campo security_groups Parâmetro
Tipo
Descrição
name
String
Especifica o nome do grupo de segurança.
id
String
Especifica o ID do grupo de segurança.
Tabela 8 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 a falha ocorreu. A hora está no formato ISO 8601.
Tabela 9 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 no formato UUID.
delete_on_termination
String
Especifica se o disco deve ser excluído ao excluir o BMS.
- true: sim
- false: não
bootIndex
String
Especifica se é um disco de inicialização. 0 especifica um disco de inicialização, e -1 especifica um disco não-inicialização.
device
String
Especifica o nome do dispositivo do disco, por exemplo, /dev/sdb.
Tabela 10 Descrição da estrutura de dados do campo os:scheduler_hints Parâmetro
Tipo
Descrição
dec_baremetal
Array of strings
Especifica se o BMS deve ser criado em um DeC. O valor pode ser shared ou dedicate.
Tabela 11 Descrição da estrutura de dados do campo metadata Parâmetro
Tipo
Descrição
chargingMode
String
Especifica o tipo de faturamento do BMS.
1: modo de faturação anual/mensal (pré-pago)
metering.order_id
String
Especifica o ID do pedido para um BMS anual/mensal.
metering.product_id
String
Especifica o ID do produto para um BMS anual/mensal.
vpc_id
String
Especifica o ID da VPC onde o BMS está localizado.
metering.image_id
String
Especifica o ID da imagem do BMS.
metering.imagetype
String
Especifica o tipo de imagem. Os seguintes tipos são suportados:
- Imagem pública: o valor é gold.
- Imagens privadas: o valor é private.
- Imagem compartilhada: o valor é shared.
baremetalPortIDList
String
Especifica as NICs do BMS.
metering.resourcespeccode
String
Especifica o código do flavor do BMS no formato {Flavor ID}.{os_type}, por exemplo, physical.o2.medium.linux.
metering.resourcetype
String
Especifica o tipo de recurso do BMS. O valor é __type_baremetal.
image_name
String
Especifica o nome da imagem do BMS.
op_svc_userid
String
Especifica o ID do usuário. Você pode obter o ID do usuário em My Credential no console de gerenciamento.
os_type
String
Especifica o tipo de SO. O valor pode ser Linux ou Windows.
__bms_support_evs
String
Especifica se o BMS suporta discos do EVS.
os_bit
String
Especifica o número de bits no SO: 32 ou 64.
- 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 89
{ "server": { "id": "53206ed0-56de-4d6b-b7ee-ffc62ca26f43", "name": "bms-test", "addresses": { "5849fdf1-9d79-4589-80c2-fe557990c417": [ { "version": "4", "addr": "192.168.1.216", "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:25:56:c3", "OS-EXT-IPS:port_id": "9e62503b-094e-4c6e-bc95-f10bbfb455d5", "OS-EXT-IPS:type": "fixed" }, { "version": "4", "addr": "10.154.72.77", "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:25:56:c3", "OS-EXT-IPS:port_id": "9e62503b-094e-4c6e-bc95-f10bbfb455d5", "OS-EXT-IPS:type": "floating" } ] }, "flavor": { "disk": "9309", "vcpus": "32", "ram": "193047", "id": "physical.o2.medium", "name": "physical.o2.medium" }, "accessIPv4": "", "accessIPv6": "", "status": "ACTIVE", "progress": 0, "hostId": "cd243addb5d2c64e89218180b7a3ed95abe6882e81c337cc563137df", "updated": "2018-09-18T09:29:44Z", "created": "2018-09-18T02:43:26Z", "metadata": { "metering.order_id": "CS1809181040HCFC2", "metering.image_id": "8589958c-6bc7-40c6-b81b-3fe4cd2e3d85", "baremetalPortIDList": "[9e62503b-094e-4c6e-bc95-f10bbfb455d5]", "metering.resourcespeccode": "physical.o2.medium.linux", "image_name": "redhat_7_2", "op_svc_userid": "745973c535ec4d4caba86f6f9419ff6d", "metering.resourcetype": "__type_baremetal", "metering.product_id": "00301-74069-0--0", "os_bit": "64", "vpc_id": "5849fdf1-9d79-4589-80c2-fe557990c417", "os_type": "Linux", "chargingMode": "1" }, "tags": [ "__type_baremetal" ], "description": "bms-6e18", "locked": false, "image": { "id": "8589958c-6bc7-40c6-b81b-3fe4cd2e3d85" }, "config_drive": "", "tenant_id": "bbf1946d374b44a0a2a95533562ba954", "user_id": "3fc5ab2b0c544979abcaafd86edd80e6", "OS-EXT-STS:power_state": 1, "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:host": "bms.dc1", "OS-EXT-SRV-ATTR:instance_name": "instance-00154f94", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova002@2", "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "az-dc-1", "os:scheduler_hints": {}, "OS-EXT-SRV-ATTR:root_device_name": "/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id": "", "enterprise_project_id": "2c7b6d77-9013-4d74-a221-2f612fc56372", "OS-EXT-SRV-ATTR:user_data": "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiRtTGM1REEkN3IvWFVZaEI0VG1YZ0FCT1F2SE4wOHNoWTVZcDYzUXFDTTVyMHpmWjhJLkJlNW92UlU2QW85a25QNlZUVnhkckF5RTJtdC40S0NxcXBBNUVuUVppNC4nIHwgY2hwYXNzd2QgLWU7", "OS-SRV-USG:launched_at": "2018-09-18T02:46:07.954587", "OS-EXT-SRV-ATTR:kernel_id": "", "OS-EXT-SRV-ATTR:launch_index": 0, "host_status": "UP", "OS-EXT-SRV-ATTR:reservation_id": "r-08tuyo8v", "OS-EXT-SRV-ATTR:hostname": "bms-6e18", "sys_tags": [ { "key": "_sys_enterprise_project_id", "value": "2c7b6d77-9013-4d74-a221-2f612fc56372" } ] } }
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.