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/ Image Management Service/ Referência de API/ As API OpenStack nativo/ Imagem (As API OpenStack nativo)/ Consulta de imagens (API OpenStack nativo)

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

Ver PDF

Consulta de imagens (API OpenStack nativo)

Função

Esta API é usada para obter a lista de imagens.

Esta API não retorna o resultado completo de uma só vez, mas usa paginação.

Paginação

A paginação refere-se à função de retornar um subconjunto de um grupo de imagens, um link para obter o próximo conjunto de imagens e um link do conjunto de imagens. Por padrão, um conjunto contém 25 imagens. Você também pode usar os parâmetros limit e marker para paginar as imagens manualmente e especificar o número de imagens que podem ser retornadas.

O parâmetro first na resposta indica o URLda primeira página de imagens, e o parâmetro next indica o URLda próxima página de imagens. Quando a última página de imagens é consultada, não há nenhum parâmetro next.

URI

GET /v2/images

Você pode digitar um ponto de interrogação (?) e um (&) comercial no final do URI para definir vários critérios de pesquisa. Para obter detalhes, consulte a solicitação de exemplo.
Se você precisar da API da versão do Queens do OpenStack, o cabeçalho da solicitação deve conter X-Api-Version. Se o valor de X-Api-Version for qualquer letra depois de M no alfabeto, a API da versão Queens é retornada. Se o valor for M ou uma letra antes de M, a API da versão Mitaka é retornada.

Tabela 1 lista os parâmetros.

**Tabela 1** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
__está cadastrado	Não	Cadeia	Especifica se a imagem está disponível. O valor pode ser true. O valor é true para todas as API de extensão por padrão. Os usuários comuns podem consultar apenas as imagens para as quais o valor deste parâmetro é true.
__tipo de imagem	Não	Cadeia	Especifica o tipo de imagem. Há suporte para as seguintes funções: Imagem pública: O valor é gold. Imagens privadas O valor é private. Imagem compartilhada: O valor é shared.
Protegida	Não	Booleano	Especifica se a imagem está protegida. O valor é true ou false. Defina-o como true quando você consulta imagens públicas. Este parâmetro é opcional quando você consulta imagens privadas.
Visibilidade	Não	Cadeia	Especifica se a imagem está disponível para outros locatários. Os valores disponíveis incluem: public: imagem pública private: imagem privada shared: imagem compartilhada
Proprietário	Não	Cadeia	Especifica o locatário ao qual a imagem pertence.
ID	Não	Cadeia	Especifica o ID da imagem.
estado	Não	Cadeia	Especifica a tag de imagem. O valor pode ser um dos seguintes: queued: indica que os metadados da imagem já foram criados e que estão prontos para o carregamento do arquivo de imagem. saving: indica que o arquivo de imagem está sendo carregado para o armazenamento de backend. deleted: indica que a imagem foi excluída. killed: indica que ocorre um erro no carregamento da imagem. active: indica que a imagem está disponível para uso.
Nome	Não	Cadeia	Especifica o nome de imagem. A correspondência exata é usada. Para uma descrição detalhada, consulte Atributos da imagem.
formato_contêiner	Não	Cadeia	Especifica o tipo de contêiner. O valor padrão é bare.
formato_do_disco	Não	Cadeia	Especifica o formato da imagem. O valor pode ser vhd, raw, zvhd, ou qcow2. O valor padrão é vhd.
min_ram	No	Integer	Especifica o tamanho mínimo de memória (MB) necessário para executar a imagem. O valor do parâmetro depende das especificações do ECS. Geralmente, o valor é 0.
disco_mínimo	No	número inteiro	Especifica o espaço mínimo em disco (GB) necessário para executar a imagem. O valor varia de 40 GB a 255 GB.
__os_bit	Não	Cadeia	Especifica a arquitetura do SO, 32 ou 64 bits.
__plataforma	Não	Cadeia	Especifica o tipo de plataforma da imagem. O valor pode ser Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, ou EulerOS.
Marcador	Não	Cadeia	Especifica o número inicial a partir do qual as imagens são consultadas. O valor é o ID da imagem.
Limite	Não	número inteiro	Especifica o número de imagens a serem consultadas. O valor é um número inteiro. Por padrão, 25 imagens podem ser consultadas.
chave_classificação	Não	Cadeia	Especifica o campo para classificar os resultados da consulta. O valor pode ser um atributo da imagem: name, container_format, disk_format, status, id, size, ou create_at. O valor padrão é create_at.
dir_classificação	Não	Cadeia	Especifica se os resultados da consulta são classificados em ordem crescente ou decrescente. Cujo valor pode ser desc (default) ou asc. Este parâmetro é usado junto com o parâmetro sort_key. O valor padrão é desc.
__os_tipo	Não	Cadeia	Especifica o tipo de imagem. O valor pode ser Linux, Windows, ou Other.
Tag	Não	Cadeia	Especifica uma tag adicionada a uma imagem. As tags podem ser usadas como um filtro para consultar imagens. NOTA: A função de marcação foi atualizada. Se as tags adicionadas antes da atualização da função estiverem no formato de "Key.Value", consulte as tags usando "Key=Value". Por exemplo, uma tag existente é a.b. Após a atualização da função tag, consulte a tag usando "tag=a=b".
estado_membro	Não	Cadeia	Especifica o status de imagem. O valor pode ser accepted, rejected, ou pending. accepted: indica que a imagem compartilhada é aceita. rejected indica que a imagem compartilhada por outras pessoas é rejeitada. pending indica que a imagem compartilhada por outras pessoas precisa ser confirmada. Para usar esse parâmetro, defina visibility para shared durante a consulta.
__suporte_kvm	Não	Cadeia	Especifica se a imagem suporta KVM. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_xen	Não	Cadeia	Especifica se a imagem suporta Xen. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_largememória	Não	Cadeia	Especifica se a imagem suporta os ECS de ampla memória. Se a imagem suportar os ECS de ampla memória, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_disco intensivo	Não	Cadeia	Especifica se a imagem oferece suporte a os ECS com uso intenso de disco. Se a imagem suportar os ECS com uso intenso de disco, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_alto desempenho	Não	Cadeia	Especifica se a imagem suporta os ECS de alto desempenho. Se a imagem oferecer suporte a os ECS de alto desempenho, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_xen_gpu_type	Não	Cadeia	Especifica se a imagem suporta os ECS acelerados por GPU na plataforma Xen. Para obter detalhes sobre os sistemas operacionais de imagem suportados por os ECS acelerados por GPU, consulte Tabela 2. Se a imagem não oferecer suporte a os ECS acelerados por GPU na plataforma Xen, esse parâmetro não será necessário. Este atributo não pode coexistir com __support_xen ou __support_kvm.
__suporte_kvm_gpu_type	Não	Cadeia	Especifica se a imagem suporta os ECS acelerados por GPU na plataforma KVM. Veja Tabela 3 para cujo valor. Se a imagem não suportar os ECS acelerados por GPU na plataforma KVM, esse parâmetro não é necessário. Este atributo não pode coexistir com __support_xen ou __support_kvm.
__suporte_xen_hana	Não	Cadeia	Especifica se a imagem suporta os ECS HANA na plataforma Xen. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário. Este atributo não pode coexistir com __support_xen ou __support_kvm.
__suporte_kvm_infiniband	Não	Cadeia	Especifica se a imagem suporta os ECS com a NIC InfiniBand na plataforma KVM. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário. Este atributo não pode coexistir com __support_xen.
criado_em	Não	Cadeia	Especifica a hora em que a imagem foi criada. As imagens podem ser consultadas por tempo. O valor está no formato de Operator:UTC time. Os seguintes valores são suportados: gt: é superior a gte: é superior ou igual a lt: menos que lte: é menos ou igual a eq: igual a neq: não é igual a O formato da hora é yyyy-MM-ddThh:mm:ssZ ou yyyy-MM-dd hh:mm:ss. Por exemplo, para consultar imagens criadas antes de 28 de outubro de 2018 10:00:00, defina o valor de created_at como lt:2018-10-28T10:00:00Z.
atualizado_em	Não	Cadeia	Especifica a hora em que a imagem foi atualizada. As imagens podem ser consultadas por tempo. O valor está no formato de Operator:UTC time. Os seguintes valores são suportados: gt: é superior a gte: é superior ou igual a lt: menos que lte: é menos ou igual a eq: igual a neq: não é igual a O formato da hora é yyyy-MM-ddThh:mm:ssZ ou yyyy-MM-dd hh:mm:ss. Por exemplo, para consultar imagens atualizadas antes de 28 de outubro de 2018 10:00:00, defina o valor de updated_at como lt:2018-10-28T10:00:00Z.

Métodos Comuns de Consulta

Imagem pública:
GET /v2/images?__imagetype=gold&visibility=public&protected=true
Imagens privadas
GET /v2/images?owner={project_id}
Imagens compartilhadas disponíveis
GET /v2/images?member_status=accepted&visibility=shared&__imagetype=shared
Imagem recusada
GET /v2/images?member_status=rejected&visibility=shared&__imagetype=shared
Imagens não aceitas
GET /v2/images?member_status=pending&visibility=shared&__imagetype=shared

Solicitação

Parâmetros de solicitação
Nenhum
Exemplo de solicitação
```
GET https://{Endpoint}/v2/images
```

Resposta

Parâmetros de resposta

Parâmetro	Tipo	Descrição
first	Cadeia	Especifica o URL da primeira página de imagens.
Avançar	Cadeia	Especifica o URL da próxima página de imagens. Quando a última página de imagens é consultada, não há nenhum parâmetro next.
Esquema	Cadeia	Especifica o URL do esquema que descreve uma lista de imagens.
Imagens	Matriz de objetos	Especifica o tipo de recurso. Para mais detalhes, consulte Tabela 2.

**Tabela 2** Descrição da estrutura de dados do campo links
Parâmetro	Tipo	Descrição
__id_de_backup	Cadeia	Especifica o ID de backup. Se a imagem for criada a partir de um backup, defina o valor como o ID de backup. Caso contrário, este parâmetro não é necessário.
__origem_de_dados	Cadeia	Especifica a origem da imagem. Se a imagem for uma imagem pública, o valor é deixado vazio.
__descrição	Cadeia	Especifica a descrição da imagem.
__localização_da_imagem	Cadeia	Especifica o local onde a imagem é armazenada.
__tamanho_da_imagem	Cadeia	Especifica o tamanho (bytes) do arquivo de imagem. O valor é maior que 0.
__imagem_tipo_fonte	Cadeia	Especifica o armazenamento de back-end da imagem. Somente UDS é suportado atualmente.
__is_config_init	Cadeia	Especifica se a configuração inicial está concluída. O valor pode ser true ou false.
__está cadastrado	Cadeia	Especifica se a imagem está disponível. O valor pode ser true. O valor é true para todas as API de extensão por padrão. Os usuários comuns podem consultar apenas as imagens para as quais o valor deste parâmetro é true.
__carregamento lento	Cadeia	Especifica se a imagem suporta carregamento lento.
__Nome original de imagem	Cadeia	Especifica o ID da imagem pai. Se a imagem for uma imagem pública ou criada a partir de um arquivo de imagem, o valor será deixado vazio.
__tipo de imagem	Cadeia	Especifica o tipo de imagem. Há suporte para as seguintes funções: Imagem pública: O valor é gold. Imagens privadas O valor é private. Imagem compartilhada: O valor é shared.
Protegida	Booleano	Especifica se a imagem está protegida. Defina-o como true quando você consulta imagens públicas. Este parâmetro é opcional quando você consulta imagens privadas.
tipo_virtual_env	Cadeia	Especifica o ambiente em que a imagem é usada. O valor pode ser FusionCompute, Ironic, DataImage, ou IsoImage. Para uma imagem do ECS (imagem de disco do sistema), o valor é FusionCompute. Para uma imagem de disco de dados, o valor é DataImage. Para uma imagem do BMS, o valor é Ironic. Para uma imagem de ISO, o valor é IsoImage.
tamanho_virtual	número inteiro	Este parâmetro não está disponível no momento.
Visibilidade	Cadeia	Especifica se a imagem está disponível para outros locatários. O valor pode ser um dos seguintes: public: imagem pública private: imagem privada shared: imagem compartilhada
Proprietário	Cadeia	Especifica o locatário ao qual a imagem pertence.
ID	Cadeia	Especifica o ID da imagem.
estado	Cadeia	Especifica a tag de imagem. O valor pode ser um dos seguintes: queued: indica que os metadados da imagem já foram criados e que estão prontos para o carregamento do arquivo de imagem. saving: indica que o arquivo de imagem está sendo carregado para o armazenamento de backend. deleted: indica que a imagem foi excluída. killed: indica que ocorre um erro no carregamento da imagem. active: indica que a imagem está disponível para uso.
Nome	Cadeia	Especifica o nome de imagem. Para uma descrição detalhada, consulte Atributos da imagem.
formato_contêiner	Cadeia	Especifica o tipo de contêiner.
formato_do_disco	Cadeia	Especifica o formato da imagem. O valor pode ser vhd, raw, zvhd, ou qcow2. O valor padrão é vhd.
min_ram	número inteiro	Especifica o tamanho mínimo de memória (MB) necessário para executar a imagem. O valor do parâmetro depende das especificações do ECS. Geralmente, o valor é 0.
max_ram	Cadeia	Especifica a memória máxima (MB) da imagem.
disco_mínimo	número inteiro	Especifica o espaço mínimo em disco (GB) necessário para executar a imagem. O valor varia de 40 GB a 255 GB.
__os_bit	Cadeia	Especifica a arquitetura do SO, 32 ou 64 bits.
__os_lista_de_características	Cadeia	Especifica atributos adicionais da imagem. O valor é uma lista (em formato JSON) de recursos avançados suportados pela imagem.
__plataforma	Cadeia	Especifica o tipo de plataforma da imagem. O valor pode ser Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, ou EulerOS.
Esquema	Cadeia	Especifica o esquema de imagem.
próprio	Cadeia	Especifica o URL da imagem.
Tamanho	número inteiro	Este parâmetro não está disponível no momento.
__os_tipo	Cadeia	Especifica o tipo de imagem. O valor pode ser Linux, Windows, ou Other.
__os_versão	Cadeia	Especifica a versão do SO.
Tags	Matriz de strings	Especifica as tags da imagem, por meio das quais você pode gerenciar imagens privadas de sua própria maneira.
__suporte_kvm	Cadeia	Especifica se a imagem suporta KVM. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_xen	Cadeia	Especifica se a imagem suporta Xen. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_largememória	Cadeia	Especifica se a imagem suporta os ECS de ampla memória. Se a imagem suportar os ECS de ampla memória, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_disco intensivo	Cadeia	Especifica se a imagem oferece suporte a os ECS com uso intenso de disco. Se a imagem suportar os ECS com uso intenso de disco, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_alto desempenho	Cadeia	Especifica se a imagem suporta os ECS de alto desempenho. Se a imagem oferecer suporte a os ECS de alto desempenho, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_xen_gpu_type	Cadeia	Especifica se a imagem suporta os ECS acelerados por GPU na plataforma Xen. Para obter detalhes sobre os sistemas operacionais de imagem suportados por os ECS acelerados por GPU, consulte Tabela 2. Se a imagem não oferecer suporte aos ECS acelerados por GPU na plataforma Xen, esse parâmetro não será necessário. Este atributo não pode coexistir com __support_xen ou __support_kvm.
__suporte_kvm_gpu_type	Cadeia	Especifica se a imagem suporta os ECS acelerados por GPU na plataforma KVM. Veja Tabela 3 para cujo valor. Se a imagem não suportar os ECS acelerados por GPU na plataforma KVM, esse parâmetro não é necessário. Este atributo não pode coexistir com __support_xen ou __support_kvm.
__suporte_xen_hana	Cadeia	Especifica se a imagem suporta os ECS HANA na plataforma Xen. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário. Este atributo não pode coexistir com __support_xen ou __support_kvm.
__suporte_kvm_infiniband	Cadeia	Especifica se a imagem suporta os ECS com a NIC InfiniBand na plataforma KVM. Se sim, o valor é true. Caso contrário, este parâmetro não é necessário. Este atributo não pode coexistir com __support_xen.
__código do produto	Cadeia	Especifica o ID do produto de uma imagem do Marketplace.
__origem_raiz	Cadeia	Especifica que a imagem é criada a partir de um arquivo de imagem externo. Valor: file
__num_sequência	Cadeia	Especifica o número de classificação de disco do sistema do ECS correspondente à imagem. Valor de exemplo 0
__suporte_fc_inject	Cadeia	Especifica se a imagem suporta injeção de senha/chave privada usando o Cloud-Init. Se o valor for definido como true, a injeção de senha/chave privada usando o Cloud-Init não é suportada. NOTA: Esse parâmetro é válido somente para imagens de disco do sistema ECS.
__é_offshelved	Cadeia	Especifica se a imagem do Marketplace foi desativada. true: A imagem foi desativada. false: A imagem não foi desativada.
criado_em	Cadeia	Especifica a hora em que a imagem foi criada. O valor está no formato UTC.
atualizado_em	Cadeia	Especifica a hora em que a imagem foi atualizada. O valor está no formato UTC.
ativo_em	Cadeia	Especifica o horário em que o status da imagem ficou active.
soma de verificação	Cadeia	Este parâmetro não está disponível no momento.
hw_firmware_type	Cadeia	Especifica o modo de inicialização do ECS. Os valores disponíveis incluem: bios indica o modo de inicialização do BIOS. uefi indica o modo de inicialização do UEFI.
Arquivo	Cadeia	Especifica o URL para carregamento e download do arquivo de imagem.
id_do_projeto_da_empresa	Cadeia	Especifica o projeto empresarial ao qual a imagem pertence. Se o valor for 0 ou deixado em branco, a imagem pertence ao projeto corporativo padrão. Se o valor for um UUID, a imagem pertence ao projeto empresarial correspondente ao UUID.
__código_da_conta	Cadeia	Especifica o identificador de cobrança para a imagem.
__apoio_amd	Cadeia	Especifica se a imagem usa a arquitetura x86 da AMD. O valor pode ser true ou false.
__sistema__cmkid	Cadeia	Especifica o ID da chave usada para encriptar a imagem.
hw_vif_ativado_multifila	Cadeia	Especifica se a imagem suporta multifila NIC. O valor pode ser true ou false.

Exemplo de resposta

CÓDIGO DE STATUS 200

      
       
         
         
           {
  "schema": "/v2/schemas/images",
  "next": "/v2/images?__isregistered=true&marker=0328c25e-c840-4496-81ac-c4e01b214b1f&__imagetype=gold&limit=2",
  "images": [
    {
      "schema": "/v2/schemas/image",
      "min_disk": 100,
      "created_at": "2018-09-06T14:03:27Z",
      "__image_source_type": "uds",
      "container_format": "bare",
      "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
      "updated_at": "2018-09-06T15:17:33Z",
      "protected": true,
      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
      "__support_kvm_fpga_type": "VU9P",
      "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
      "__isregistered": "true",
      "min_ram": 2048,
      "__lazyloading": "true",
      "owner": "1bed856811654c1cb661a6ca845ebc77",
      "__os_type": "Linux",
      "__imagetype": "gold",
      "visibility": "public",
      "virtual_env_type": "FusionCompute",
      "tags": [],
      "__platform": "CentOS",
      "size": 0,
      "__os_bit": "64",
      "__os_version": "CentOS 7.3 64bit",
      "name": "CentOS 7.3 64bit vivado",
      "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
      "disk_format": "zvhd2",
      "virtual_size": null,
      "hw_firmware_type": "bios",
      "status": "active"
    },
    {
      "schema": "/v2/schemas/image",
      "min_disk": 100,
      "created_at": "2018-09-06T14:03:05Z",
      "__image_source_type": "uds",
      "container_format": "bare",
      "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
      "updated_at": "2018-09-25T14:27:40Z",
      "protected": true,
      "checksum": "d41d8cd98f00b204e9800998ecf8427e",
      "__support_kvm_fpga_type": "VU9P_COMMON",
      "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
"__isregistered": "true",
      "min_ram": 2048,
      "__lazyloading": "true",
      "owner": "1bed856811654c1cb661a6ca845ebc77",
      "__os_type": "Linux",
      "__imagetype": "gold",
      "visibility": "public",
      "virtual_env_type": "FusionCompute",
      "tags": [],
      "__platform": "CentOS",
      "size": 0,
      "__os_bit": "64",
      "__os_version": "CentOS 7.3 64bit",
      "name": "CentOS 7.3 64bit with sdx",
      "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
      "disk_format": "zvhd2",
      "virtual_size": null,
      "hw_firmware_type": "bios",
      "status": "active"
    }
  ],
  "first": "/v2/images?__isregistered=true&__imagetype=gold&limit=2"
}

          

        

      
     

Valores retornados

Normal
200

Anormal

Valor retornado	Descrição
400 Solicitação inválida	Erro na solicitação. Para obter detalhes sobre o código de erro retornado, consulte Códigos de erro.
401 Não autorizado	Autenticação falhou.
403 Proibido	Você não tem os direitos para realizar a operação.
404 Não encontrado	O recurso solicitado não foi encontrado.
500 Erro de servidor interno	Erro do serviço interno.
503 Serviço indisponível	Serviço não está disponível.