Consulta de BMSs (API OpenStack nativo)

Função

Essa API é usada para consultar BMSs.

Restrições

• O resultado da consulta retornado por essa interface inclui ECSs e BMSs. Você precisa filtrar os BMSs 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 BMSs 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{?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.

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	GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers

  • Com um parâmetro opcional

    1	GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal

  • Com vários parâmetros opcionais

    1	GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers?tags=__type_baremetal&name=bms-test01

Resposta

• Parâmetros de resposta

  Parâmetro	Tipo	Descrição
  servers	Array of objects	Especifica a lista do BMS. Para mais detalhes, consulte Tabela 2.

  Tabela 2 Descrição da estrutura de dados do campo servers

  Parâmetro	Tipo	Descrição
  name	String	Especifica o nome de BMS.
  id	String	Especifica o ID exclusivo do BMS.
  links	Array of objects	Especifica os links de atalho do BMS. Para mais detalhes, consulte Tabela 3.

  Tabela 3 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.

• Exemplo de resposta

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

  { "servers": [ { "name": "bms", "links": [ { "rel": "self", "href": "https://openstack.example.com/v2.1/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8b-4bc5-ae46-69cacfd4fbaa" }, { "rel": "bookmark", "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ], "id": "820abbd0-2d8e-4bc5-ae46-69cacfd4fbaa" } ] }

Valores retornados

Para obter detalhes sobre outros valores retornados, consulte Códigos de status.

Códigos de erro

Consulte Códigos de erro.