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> APIs OpenStack nativo Nova V2.1> Gerenciamento do ciclo de vida do BMS> Consulta de detalhes sobre os BMSs (API OpenStack nativo)
Atualizado em 2023-03-20 GMT+08:00
Ver PDF

Consulta de detalhes sobre os BMSs (API OpenStack nativo)

Função

Essa API é usada para consultar detalhes sobre os BMS.

Restrições

  • O resultado da consulta retornado por essa interface inclui detalhes do ECS e do BMS. Você precisa filtrar os detalhes do BMS usando o flavor usado para criar os BMSs ou as tags adicionadas aos BMSs durante a criação do BMS.
  • Se a imagem for usada como critério de pesquisa, outros critérios de pesquisa e critérios de paginação não serão suportados. Se a imagem e outros critérios de pesquisa forem usados, os detalhes do BMS serão filtrados por imagem. Se a imagem não for usada como critério de pesquisa, esta interface não tem restrições.

URI

GET /v2.1/{project_id}/servers/detail{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}&not-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}}

A Tabela 1 lista os parâmetros.

Tabela 1 Descrição do parâmetro

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.

Solicitação

  • Parâmetros de solicitação

    Parâmetro

    Obrigatório

    Tipo

    Descrição

    changes-since

    Não

    String

    Especifica o carimbo de data/hora da última atualização de status do BMS. O parâmetro está no formato de hora ISO 8601, por exemplo, 2013-06-09T06:42:18Z.

    image

    Não

    String

    Especifica o ID da imagem.

    Você pode obter o ID da imagem no console do IMS ou chamando a API de Consulta de imagens.

    NOTA:

    Se a imagem for usada como critério de pesquisa, outros critérios de pesquisa e critérios de paginação não serão suportados. Se a imagem e outros critérios de pesquisa forem usados, os detalhes do BMS serão filtrados por imagem. Se a imagem não for usada como critério de pesquisa, esta interface não tem restrições.

    flavor

    Não

    String

    Especifica o ID do flavor.

    Você pode obter o ID do flavor no console do BMS ou usando a API de Consulta de flavors do BMS (API OpenStack nativo).

    name

    Não

    String

    Especifica o nome de BMS. Este parâmetro suporta correspondência difusa.

    Por exemplo, a expressão regular ?name=bob retornará bob e bobb. Para obter apenas bob, você pode usar uma expressão regular que combine com a sintaxe básica do banco de dados, como MySQL ou PostgreSQL (site oficial: https://www.postgresql.org/docs/9.2/static/functions-matching.html).

    status

    Não

    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

    limit

    Não

    Integer

    Especifica o número de BMSs exibidos em cada página.

    marker

    Não

    String

    Especifica o ID do BMS ao qual o marcador corresponde. A consulta começará a partir do próximo ID.

    tags

    Não

    String

    Consulta os BMSs com tags especificadas.

    Adicionado na versão micro 2.26.

    not-tags

    Não

    String

    Consulta os BMSs com tags que não contêm o valor especificado. O valor é uma lista de chaves de tag.

    NOTA:

    Se as tags adicionadas antes da atualização da função estiverem no formato "Key.Value", consulte as tags usando "Key".

    Por exemplo, uma tag existente é a.b. Após a atualização da função tag, consulte a tag usando "not-tags=a".

    Adicionado na versão micro 2.26.

    reservation_id

    Não

    String

    Especifica o ID reservado, que pode ser usado para consultar BMSs criados em um lote.

    Adicionado na versão micro 2.26.

    sort_key

    Não

    String

    Especifica o atributo de classificação do BMS, que pode ser o UUID do BMS (uuid), status do BMS (vm_state), nome do BMS (display_name), status da tarefa do BMS (task_state), status da energia (power_state), tempo de criação (created_at), última vez quando o BMS é atualizado (updated_at) e AZ (availability_zone). Você pode especificar vários pares sort_key e sort_dir.

    A classificação padrão é a ordem inversa por created_at.

    sort_dir

    Não

    String

    Especifica a direção de classificação.

    • asc: os resultados da consulta são exibidos em ordem crescente.
    • desc (valor padrão): os resultados da consulta são exibidos em ordem decrescente.
  • Exemplo de solicitação
    • Sem nenhum parâmetro opcional 
      1
      		 
      https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail
    • Com um parâmetro opcional 
      1
      		 
      https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal
    • Com vários parâmetros opcionais 
      1
      		 
      https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01

Resposta

  • Parâmetros de resposta

    Parâmetro

    Tipo

    Descrição

    servers

    Array of objects

    Especifica detalhes sobre o BMS. Para mais detalhes, consulte Tabela 2.
    Tabela 2 Descrição da estrutura de dados do campo server

    Parâmetro

    Tipo

    Descrição

    name

    String

    Especifica o nome de BMS.

    id

    String

    Especifica o ID exclusivo do BMS.

    status

    String

    Especifica o status do BMS.

    Intervalo de valores:

    • ACTIVE: o BMS está em execução, parado ou sendo excluído.
    • BUILD: o BMS está sendo criado.
    • ERROR: o BMS está com defeito.
    • HARD_REBOOT: o BMS está sendo reiniciado à força.
    • REBOOT: o BMS está sendo reiniciado.
    • SHUTOFF: o BMS está parado, sendo iniciado, sendo excluído, sendo reconstruído, sendo reinstalado, falha ao ser reinstalado ou congelado.

    created

    String

    Especifica quando 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 última vez 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.

    flavor

    Object

    Especifica o flavor do BMS. Para mais detalhes, consulte Tabela 3.

    image

    Object

    Especifica a imagem do BMS. Para mais detalhes, consulte Tabela 4.

    tenant_id

    String

    Especifica o ID do locatário proprietário do BMS. O valor está no formato UUID.

    Este parâmetro é igual a project_id.

    key_name

    String

    Especifica o nome da chave SSH.

    user_id

    String

    Especifica o ID do usuário do BMS.

    metadata

    Map<String,String>

    Especifica os metadados do BMS.

    É um par chave-valor de metadados definido pelo usuário. Cada chave ou valor contém no máximo 255 caracteres.

    hostId

    String

    Especifica o ID do host do BMS.

    addresses

    Map<String,Array of address objects>

    Especifica o endereço de rede do BMS. Especifica a VPC usada pelo BMS.

    • key: indica o ID da VPC usado pelo BMS.
    • value: indica os detalhes da VPC.

    security_groups

    Array of objects

    Especifica os grupos de segurança do BMS. Para mais detalhes, consulte Tabela 7.

    links

    Array of objects

    Especifica os links de atalho do BMS. Para mais detalhes, consulte Tabela 5.

    OS-DCF:diskConfig

    String

    Especifica o método de configuração do disco. Este é um atributo estendido. O valor pode ser:

    • MANUAL: o BMS é criado usando o esquema de particionamento e o sistema de arquivos na imagem. Se o flavor de destino tiver um disco grande, a API não particionará o espaço em disco restante.
    • AUTO: o BMS é criado usando uma única partição com o mesmo tamanho do disco do flavor alvo. A API ajusta automaticamente o sistema de arquivos para se adaptar a toda a partição.

    OS-EXT-AZ:availability_zone

    String

    Especifica o nome da AZ onde o BMS é implementado. Este é um atributo estendido.

    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 do hipervisor. Este é um atributo estendido fornecido pelo driver Nova virt.

    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.

    Intervalo de valores:

    • 0: pendente
    • 1: correndo
    • 2: pausado
    • 3: desligamento
    • 4: caiu

    OS-EXT-STS:task_state

    String

    Especifica o status da tarefa do BMS. Este é um atributo estendido.

    Intervalo de valores:

    • 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 de estabilidade do BMS. Este é um atributo estendido.

    Intervalo de valores:

    • 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 do carimbo de data/hora está em conformidade com a 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. Este é um atributo estendido.

    O formato do carimbo de data/hora está em conformidade com a ISO 8601, por exemplo, 2019-05-22T04:23:59.000000.

    os-extended-volumes:volumes_attached

    Array of objects

    Especifica os discos EVS anexados do BMS. Para mais detalhes, consulte Tabela 8.

    accessIPv4

    String

    Este é um atributo reservado.

    accessIPv6

    String

    Este é um atributo reservado.

    fault

    Object

    Especifica a causa da falha. Se o BMS estiver com defeito, este campo será retornado. Para mais detalhes, consulte Tabela 9.

    config_drive

    String

    Este é um atributo reservado.

    progress

    Integer

    Este é um atributo reservado.

    description

    String

    Especifica a descrição sobre o BMS.

    Este é um novo parâmetro na versão micro 2.19.

    host_status

    String

    Especifica o status do host do BMS.

    • UP: o host é normal.
    • UNKNOWN: o status do host é desconhecido.
    • DOWN: o host é anormal.
    • MAINTENANCE: o host está sendo mantido.
    • Cadeia vazia: não há informações de host do BMS.

    Este é um novo parâmetro na micro versão 2.16.

    OS-EXT-SRV-ATTR:hostname

    String

    Especifica o nome do host do BMS.

    Este é um novo parâmetro na micro versão 2.3.

    OS-EXT-SRV-ATTR:reservation_id

    String

    Especifica os IDs do BMS reservados quando os BMSs são criados em lotes.

    Este é um novo parâmetro na micro versão 2.3.

    OS-EXT-SRV-ATTR:launch_index

    Integer

    Especifica a sequência de inicialização dos BMSs criados em lotes.

    Este é um novo parâmetro na micro versão 2.3.

    OS-EXT-SRV-ATTR:kernel_id

    String

    Especifica o UUID da imagem do kernel quando uma imagem AMI é usada. Em outros casos, deixe este parâmetro em branco.

    Este é um parâmetro na versão micro 2.3.

    OS-EXT-SRV-ATTR:ramdisk_id

    String

    Especifica o UUID de uma imagem Ramdisk quando a imagem AMI é usada. Em outros casos, deixe este parâmetro em branco.

    Este é um novo parâmetro na micro versão 2.3.

    OS-EXT-SRV-ATTR:root_device_name

    String

    Especifica o nome do dispositivo do disco do sistema do BMS, por exemplo, /dev/sda.

    Este é um novo parâmetro na micro versão 2.3.

    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.

    Este é um novo parâmetro na versão micro 2.9.

    tags

    Array of strings

    Especifica as tags do BMS.

    Este é um novo parâmetro na versão 2.26 do micro. Se você não estiver usando essa versão micro, a resposta não conterá o parâmetro tags.

    Uma tag deve atender aos seguintes requisitos:

    • A chave e o valor de uma tag são conectados usando um sinal de igual (=), por exemplo, key=value.
    • Se o valor estiver vazio, somente a chave é retornada.

    sys_tags

    Array of objects

    Especifica as tags do sistema do BMS. Para mais detalhes, consulte Tabela 3.

    enterprise_project_id

    String

    Especifica o ID do projeto empresarial.

    os:scheduler_hints

    Object

    Especifica as informações de agendamento do BMS. Para mais detalhes, consulte Tabela 4.
    Tabela 3 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 4 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 5 Descrição da estrutura de dados do campo flavor

    Parâmetro

    Tipo

    Descrição

    id

    String

    Especifica o ID do tipo do BMS.

    links

    Array of objects

    Especifica links de atalho do tipo do BMS.

    Para mais detalhes, consulte Tabela 5.
    Tabela 6 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 5.
    Tabela 7 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 8 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 tipo de endereço IP. Este é um atributo estendido.

    • fixed: indica o endereço IP privado.
    • floating: indica o EIP.
    Tabela 9 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.
    • Se um grupo de segurança for especificado quando você criar o BMS, o valor desse parâmetro será o nome do grupo de segurança.
    Tabela 10 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 EVS.

    delete_on_termination

    Boolean

    Especifica se o disco deve ser excluído ao excluir o BMS.

    • true: sim
    • false: não

    Adicionado na micro versão 2.3.
    Tabela 11 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.
  • 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
    		 
    {
    "servers": [
{
            "tenant_id": "c685484a8cc2416b97260938705deb64",
            "addresses": {
                "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
{
                        "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77",
                        "OS-EXT-IPS:type": "fixed",
                        "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://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
                },
{
                    "rel": "bookmark",
                    "href": "https://openstack.example.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.az1",
            "image": {
                "links": [
{
                        "rel": "bookmark",
                        "href": "https://openstack.example.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://openstack.example.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",
            "progress": 0, 
            "OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078",
            "updated": "2017-05-25T03:40:25Z",
            "status": "ACTIVE"
                    }
    ]
}

Valores retornados

Valores normais

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.