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/ Elastic Cloud Server/ Referência de API/ As API da Nova do OpenStack/ Gerenciamento de ciclo de vida/ Consulta de detalhes sobre os ECS

Atualizado em 2022-11-08 GMT+08:00

Consulta de detalhes sobre os ECS

Função

Essa API é usada para consultar detalhes sobre os ECS.

URI

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

Tabela 1 descreve os parâmetros no URI.

**Tabela 1** Parâmetros de caminho
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.

**Tabela 2** Parâmetros de consulta
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 variante 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 fora 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. Cada página contém os 25 ECS por padrão, e um máximo dos 1000 ECS são retornados. Para grandes volumes de dados, é aconselhável definir o valor como 100.
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. O valor pode ser created_at, auto_disk_config, availability_zone, display_description, display_name, host, host_name, image_ref, instance_type_id, kernel_id, key_name, launch_index, launched_at, locked_by, node, power_state, project_id, ramdisk_id, reservation_id, root_device_name, task_state, terminated_at, user_id, updated_at, uuid, ou 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.

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

**Tabela 4** descrição do campo **servers**
Parâmetro	Tipo	Descrição
name	String	Especifica o nome de ECS.
id	String	Especifica um ECS exclusivamente.
status	String	Especifica o status do ECS. Opções: ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PAUSED, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, SUSPENDED, e VERIFY_RESIZE Para mais detalhes, consulte Estados de ECS.
created	String	Especifica a hora em que o ECS foi criado. Esta hora está no formato "2019-05-22T07:48:53Z".
updated	String	Especifica a hora em que o ECS foi atualizado pela última vez. Esta hora está no formato "2019-05-22T07:48:53Z".
flavor	Object	Especifica a variante de ECS. Para mais detalhes, consulte Tabela 5.
image	Object	Especifica as informações da imagem de ECS. Para um ECS criado usando uma imagem, o ID da imagem e o link são retornados. Para mais detalhes, consulte Tabela 11.
tenant_id	String	Especifica a ID do locatário ao qual o ECS pertence. O valor do parâmetro é o mesmo que o ID do projeto especificado por project_id.
key_name	String	Especifica o nome da chave SSH.
user_id	String	Especifica a ID do usuário ao qual um ECS pertence.
metadata	Object	Especifica os metadados do ECS.
hostId	String	Especifica a ID do host do ECS.
addresses	Object	Especifica os endereços de rede de um ECS. A estrutura é Map<String, Object>. A chave indica o ID da sub-rede da VPC. O valor indica os atributos de rede especificados em Tabela 7.
security_groups	Array of objects	Especifica os grupos de segurança aos quais o ECS pertence. Para mais detalhes, consulte Tabela 9.
links	Array of objects	Especifica links de atalho do ECS. Para mais detalhes, consulte Tabela 6.
os:scheduler_hints	Object	Especifica as informações de agendamento do ECS. Para mais detalhes, consulte Tabela 12. Este parâmetro só está disponível para os DeH.
OS-DCF:diskConfig	String	Especifica o modo de configuração do disco. Este é um atributo estendido. Este campo é válido para o ECS início do uso de uma imagem. Opções: AUTO: Essa API usa uma única partição para criar um ECS com o tamanho do disco de destino. A API ajusta automaticamente o sistema de arquivos para se adaptar a toda a partição. MANUAL: Essa API usa o esquema de particionamento na imagem de origem e no sistema de arquivos para criar o ECS. Se o tamanho do disco de destino for grande, a API não particionará o espaço em disco restante.
OS-EXT-AZ:availability_zone	String	Especifica o ID da AZ. Este é um atributo estendido.
OS-EXT-SRV-ATTR:host	String	Especifica o nome do host no qual o ECS é implantado. Este é um atributo estendido.
OS-EXT-SRV-ATTR:hypervisor_hostname	String	Especifica o nome do host do hipervisor. Este é um atributo estendido.
OS-EXT-SRV-ATTR:instance_name	String	Especifica a ID de ECS. Este é um atributo estendido.
OS-EXT-STS:power_state	Integer	Especifica o status de energia do ECS. Este é um atributo estendido. Opções: 0, 1, 2, 3, e 4 0: pendente 1: correndo 2: pausado 3: desligamento 4: caiu
OS-EXT-STS:task_state	String	Especifica o status da tarefa ECS. Este é um atributo estendido. Para obter detalhes sobre opções, consulte.
OS-EXT-STS:vm_state	String	Especifica o status do ECS. Este é um atributo estendido. Opções: ACTIVE, BUILDING, STOPPED, RESIZED, PAUSED, SUSPENDED, RESCUED, ERROR, DELETED, SOFT_DELETED, SHELVED, e SHELVED_OFFLOADED Para mais detalhes, consulte Estados de ECS.
OS-SRV-USG:launched_at	String	Especifica a hora em que o ECS foi iniciado. Este é um atributo estendido. Esta hora está no formato "2019-05-22T07:48:19.000000".
OS-SRV-USG:terminated_at	String	Especifica a hora em que o ECS foi excluído. Este é um atributo estendido. Esta hora está no formato "2019-05-22T07:48:19.000000".
os-extended-volumes:volumes_attached	Array of objects	Especifica informações sobre os discos EVS anexados ao ECS. Para mais detalhes, consulte Tabela 8.
fault	Object	Descreve falhas de ECS. Este parâmetro é opcional. Ele é retornado quando ocorre um erro em um ECS. Para mais detalhes, consulte Tabela 10.
description	String	Descreve o ECS. Este parâmetro é suportado no microversion 2.19 e posterior.
host_status	String	Especifica o status do nova-compute. UP: O estado de computação nova é normal. UNKNOWN: O estado da nova-computação é desconhecido. DOWN: o status da nova-computação é anormal. MAINTENANCE: O nova-computador está em estado de manutenção. String vazia: Não há informações de host no ECS. Este parâmetro é suportado na microversão 2.16 e posterior.
OS-EXT-SRV-ATTR:hostname	String	Especifica o nome do host que acomoda o ECS. Este parâmetro é suportado na microversão 2.3 e posterior.
OS-EXT-SRV-ATTR:reservation_id	String	Especifica o ID de ECS reservado se os vários ECS forem criados em um lote. Este parâmetro é suportado na microversão 2.3 e posterior.
OS-EXT-SRV-ATTR:launch_index	Integer	Especifica a seqüência na qual os ECS criados em um início de lote. Este parâmetro é suportado na microversão 2.3 e posterior.
OS-EXT-SRV-ATTR:kernel_id	String	Especifica o UUID da imagem do kernel se uma imagem AMI for usada. Em outros cenários, deixe esse parâmetro em branco. Este parâmetro é suportado na microversão 2.3 e posterior.
OS-EXT-SRV-ATTR:ramdisk_id	String	Especifica o UUID da imagem Ramdisk se uma imagem AMI for usada. Em outros cenários, deixe esse parâmetro em branco. Este parâmetro é suportado na microversão 2.3 e posterior.
OS-EXT-SRV-ATTR:root_device_name	String	Especifica o nome do dispositivo do disco do sistema ECS. Este parâmetro é suportado na microversão 2.3 e posterior.
OS-EXT-SRV-ATTR:user_data	String	Especifica os dados do usuário especificados durante a criação de ECS. Este parâmetro é suportado na microversão 2.3 e posterior.
tags	Array of strings	Especifica as tags de ECS. Este parâmetro é suportado no microversion 2.26 e posterior. Se a microversão não for usada para consulta, a resposta não conterá o campo tags. As funções de tag foram atualizadas na nuvem pública. Após a atualização, os valores de tag retornados pelo sistema estão em conformidade com as seguintes regras: 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.
locked	Boolean	Especifica o status do bloqueio do ECS, que é True quando o ECS está bloqueado e False quando o ECS está desbloqueado. Este parâmetro é suportado no microversion 2.9 e posterior.
accessIPv4	String	Reservado
accessIPv6	String	Reservado
config_drive	String	Reservado
progress	Integer	Reservado

**Tabela 5** descrição do campo de **flavor**
Parâmetro	Tipo	Descrição
id	String	Especifica a ID de ECS. Este parâmetro não é suportado no microversion 2.47 e posterior.
links	Array of objects	Especifica links de atalho para tipos de ECS. Para mais detalhes, consulte Tabela 6. Este parâmetro não é suportado no microversion 2.47 e posterior.
vcpus	Integer	Especifica o número das vCPU na variante de ECS. Este parâmetro é suportado na microversão 2.47 e posterior.
ram	Integer	Especifica o tamanho da memória (MB) na variante de ECS. Este parâmetro é suportado na microversão 2.47 e posterior.
disk	Integer	Especifica o tamanho do disco do sistema na variante de ECS. O valor 0 indica que o tamanho do disco não é limitado. Este parâmetro é suportado na microversão 2.47 e posterior.
ephemeral	Integer	Reservado Este parâmetro é suportado na microversão 2.47 e posterior.
swap	Integer	Reservado Este parâmetro é suportado na microversão 2.47 e posterior.
original_name	String	Especifica o nome do variante de ECS. Este parâmetro é suportado na microversão 2.47 e posterior.
extra_specs	Object	Campo de sabor estendido Para mais detalhes, consulte Estrutura de dados para detalhes da consulta sobre especificações. Este parâmetro é suportado na microversão 2.47 e posterior.

**Tabela 6** **servers_links** e descrição 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.

**Tabela 7** Estrutura de dados da rede que um ECS acessa
Parâmetro	Tipo	Descrição
addr	String	Especifica o endereço IP.
version	Integer	Especifica o tipo de um endereço IP. O valor deste parâmetro 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.

**Tabela 8** descrição do campo de **os-extended-volumes:volumes_attached**
Parâmetro	Tipo	Descrição
id	String	Especifica a ID do disco do EVS.
delete_on_termination	Boolean	Especifica se devem ser excluídos discos adicionais ao excluir o ECS. Por padrão, esse parâmetro é definido como False. Este parâmetro é suportado na microversão 2.3 e posterior.

**Tabela 9** descrição do campo **security_groups**
Parâmetro	Tipo	Descrição
name	String	Especifica o nome do grupo de segurança ou UUID.

**Tabela 10** descrição do campo de **fault**
Parâmetro	Tipo	Descrição
code	Integer	Especifica o código de erro.
created	String	Especifica a hora em que ocorreu um erro.
message	String	Descreve um erro.
details	String	Especifica detalhes sobre um erro. Este parâmetro é opcional e é retornado somente quando não estiver vazio.

**Tabela 11** descrição do campo de **image**
Parâmetro	Tipo	Descrição
id	String	Especifica o ID da imagem.
links	Array of objects	Especifica links de atalho para imagens ECS. Para mais detalhes, consulte Tabela 6.

**Tabela 12** os parâmetros de **os:scheduler_hints**
Parâmetro	Obrigatório	Tipo	Descrição
tenancy	Não	Array of strings	Cria os ECS em um host dedicado ou compartilhado. O valor deste parâmetro pode ser dedicated ou shared.
dedicated_host_id	Não	Array of strings	Especifica o ID do DeH. Este parâmetro só tem efeito quando a tenancy é definida como dedicated.

Exemplo de solicitação

GET https://{endpoint}/v2.1/{project_id}/servers/detail

Exemplo de resposta

{
    "servers": [
        {
            "addresses": {
                "68269e6e-4a27-441b-8029-35373ad50bd9": [
                    {
                        "addr": "192.168.0.3", 
                        "version": 4
                    }
                ]
            }, 
            "created": "2012-09-07T16:56:37Z", 
            "flavor": {
                "id": "1", 
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1", 
                        "rel": "bookmark"
                    }
                ]
            }, 
            "hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e", 
            "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931", 
            "image": "", 
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", 
                    "rel": "self"
                }, 
                {
                    "href": "http://openstack.example.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", 
                    "rel": "bookmark"
                }
            ], 
            "metadata": {},                         
            "name": "new-server-test", 
            "progress": 0, 
            "status": "ACTIVE", 
            "tenant_id": "openstack", 
            "updated": "2012-09-07T16:56:37Z", 
            "user_id": "fake"
        }
    ]
}