Consulta dos ECS
Função
Esta API é usada para consultar os ECS.
URI
GET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
Parâmetro |
Obrigatório |
Descrição |
---|---|---|
project_id |
Sim |
Especifica a ID do projeto. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de um ID de projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
changes-since |
Não |
String |
Especifica o carimbo de data/hora da última atualização de status de ECS, que é usado para filtrar os ECS com status atualizados mais tarde do que o carimbo de data/hora. O formato deve estar em conformidade com a norma ISO 8601 no formato CCYY-MM-DDThh:mm:ss+/-hh:mm, por exemplo, 2018-01-17T03:03:32Z. |
image |
Não |
String |
Especifica o ID da imagem. Quando a imagem é usada como critério de filtro, outros critérios de filtro e critérios de paginação não são suportados. Se a imagem e outros critérios de filtro forem especificados, o critério de filtro de imagem será usado. Se os critérios de consulta não contiverem o critério de filtro de imagem, as funções da API não serão restritas. |
flavor |
Não |
String |
Especifica o ID de tipo de ECS, que é correspondido fuzzy. |
name |
Não |
String |
Especifica o nome do ECS, que é correspondido fuzzy. |
status |
Não |
String |
Especifica o status do ECS. Opções: ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, e VERIFY_RESIZE Na microversão 2.37, o sistema retornará uma lista vazia para o campo de status das opções anteriores. Na microversão 2.38 e posterior, o sistema retornará o erro 400. Para mais detalhes, consulte Estados de ECS. |
limit |
Não |
Integer |
Especifica o limite superior do número de resultados retornados. O valor padrão em cada página é 25, e as informações de um máximo dos 1000 ECS são exibidas em cada página. |
marker |
Não |
String |
Especifica a ID de ECS para a qual o marcador aponta. A consulta será iniciada a partir de seu próximo ID. |
tags |
Não |
String |
Consulta os ECS com tags contendo o valor especificado. |
not-tags |
Não |
String |
Consulta os ECS com tags que não contenham o valor especificado. O valor é a chave da tag.
NOTA:
As funções de tag foram atualizadas na nuvem pública. 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". |
reservation_id |
Não |
String |
Especifica a ID retornada quando os ECS são criados em um lote. Esse parâmetro é usado para consultar os ECS criados em um lote. |
sort_key |
Não |
String |
Classifica os resultados da consulta por ECS atributo. A ordem de classificação padrão é a ordem inversa de created_at. Opções: created_at, availability_zone, display_name, host, instance_type_id, key_name, project_id, user_id, updated_at, uuid, e vm_state |
ip |
Não |
String |
Indica o resultado da filtragem para endereços IPv4, que são combinados fuzzy. |
Solicitação
Nenhum
Resposta
Tabela 3 descreve os parâmetros de resposta.
Parâmetro |
Tipo |
Descrição |
---|---|---|
servers |
Array of objects |
Especifica os ECS a serem consultados. Para mais detalhes, consulte Tabela 4. |
servers_links |
Array of objects |
Especifica o link da próxima página na consulta de paginação. Para mais detalhes, consulte Tabela 5. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Especifica o nome de ECS. |
id |
String |
Especifica um ECS exclusivamente. |
links |
Array of objects |
Especifica links de atalho do ECS. Para mais detalhes, consulte Tabela 5. |
Exemplo de solicitação
GET https://{endpoint}/v2.1/{project_id}/servers
Exemplo de resposta
{ "servers": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", "links": [ { "href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", "rel": "self" }, { "href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", "rel": "bookmark" } ], "name": "new-server-test" } ] }