Consulta de imagens_Image Management Service

Função

Essa API é usada para consultar imagens usando critérios de pesquisa e para exibir as imagens em uma lista.

URI

OBTENHA /v2/cloudimages{?__isregistered,__imagetype,__whole_image,__system__cmkid,protected,visibility,owner,id,status,name,flavor_id,container_format,disk_format,min_ram,min_disk,__os_bit,__platform,marker,limit,sort_key,sort_dir,__os_type,tag,member_status,__support_kvm,__support_xen,__support_largememory,__support_diskintensive,__support_highperformance,__support_xen_gpu_type,__support_kvm_gpu_type,__support_xen_hana,__support_kvm_infiniband,virtual_env_type,enterprise_project_id,created_at,updated_at}

Você pode digitar um ponto de interrogação (?) e um E comercial (&) no final do URI para definir vários critérios de pesquisa. Para obter detalhes, consulte a solicitação de exemplo.

**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. NOTA: O __imagetype de imagens que você compartilha com outros inquilinos ou que outros inquilinos compartilham com você e você aceitou é shared. Você pode usar o campo owner para distinguir os dois tipos de imagens compartilhadas. Você pode usar member_status para filtrar imagens compartilhadas que você aceitou.
__imagem_inteira	Não	Booleano	Especifica se a imagem é uma imagem de ECS inteiro. O valor pode ser true ou false.
__sistema__cmkid	Não	Cadeia	Especifica a ID da chave usada para encriptar a imagem. Você pode obter a ID no console do IMS ou chamando a API do Consulta de detalhes de uma imagem (API OpenStack nativo).
Protegida	Não	Booleano	Especifica se a imagem está protegida. O valor pode ser 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 upload 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 upload 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.
flavor_id	Não	Cadeia	Especifica o ID de variante do ECS usada para filtrar imagens públicas disponíveis. Nota: Você pode especificar apenas um ID de variante. Você pode especificar apenas um ID de variação ECS e não pode especificar um ID de variação BMS. Para filtrar imagens públicas suportadas por uma variação do BMS, use __support_s4l=true filter criterion. s4l indicates board_type de variante do BMS physical.s4.large. Consulte Métodos Comuns de Consulta para obter um exemplo de chamada.
formato_contêiner	Não	Cadeia	Especifica o tipo de contêiner. O valor é bare.
formato_do_disco	Não	Cadeia	Especifica o formato da imagem. O valor pode servhd, raw, zvhd,iso, ou qcow2. O valor padrão é zvhd2.
min_ram	Não	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.
disco_mínimo	Não	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 bit.
__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 inteiro e é 500 por padrão.
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 created_at. O valor padrão é created_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 (padrão) 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. Os valores disponíveis incluem: Linux janelas Outros
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 memória grande. Se a imagem suportar os ECS de memória grande, o valor é true. Caso contrário, este parâmetro não é necessário. Para os SO compatíveis, consulte Os SO suportados por diferentes tipos dos ECS.
__suporte_disco intensivo	Não	Cadeia	Especifica se a imagem oferece suporte aos 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 aos 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. Veja Tabela 2 para cujo valor. 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	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 ECSs 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.
tipo_virtual_env	Não	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 do ISO, o valor é IsoImage.
id_do_projeto_da_empresa	Não	Cadeia	Especifica o projeto empresarial ao qual pertencem as imagens a serem consultadas. Se o valor for 0, as imagens padrão do projeto empresarial default devem ser consultadas. Se o valor for UUID, as imagens do projeto empresarial correspondente ao UUID devem ser consultadas. Se o valor for all_granted_eps, as imagens de todos os projetos empresariais devem ser consultadas. Para obter mais informações sobre projetos corporativos e como obter os ID de projeto corporativo, consulte Centro Empresarial
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 da seguinte forma: created_at=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 da seguinte forma: updated_at=lt:2018-10-28T10:00:00Z

Solicitação

Parâmetros de solicitação
Nenhum

Exemplo de solicitação

GET https://{Endpoint}/v2/cloudimages?__imagetype=gold&sort_key=name&limit=1

Métodos Comuns de Consulta

Imagem pública:
OBTENHA /v2/cloudimages?__imagetype=gold&visibility=public&protected=true
Imagens privadas
OBTENHA /v2/cloudimages?proprietário={project_id}
Imagens compartilhadas disponíveis
OBTENHA /v2/cloudimages?member_status=accepted&visibility=shared&__imagetype=shared
Imagem recusada
OBTENHA /v2/cloudimages?member_status=rejected&visibility=shared&__imagetype=shared
Imagens não aceitas
OBTENHA /v2/cloudimages?member_status=pending&visibility=shared&__imagetype=shared
Imagens públicas suportadas por um flavor BMS
OBTENHA /v2/cloudimages?__imagetype=gold&__support_xxx=true&virtual_env_type=Irônico

Resposta

Parâmetros de resposta

Parâmetro	Tipo	Descrição
Imagens	Matriz de objetos	Especifica os detalhes da imagem. Para mais detalhes, consulte Tabela 2.

Parâmetro

Tipo

Descrição

Imagens

Matriz de objetos

Especifica os detalhes da imagem.

Para mais detalhes, consulte Tabela 2.

**Tabela 2** Descrição da estrutura de dados do campo links
Parâmetro	Tipo	Descrição
Arquivo	Cadeia	Especifica a URL para upload e download do arquivo de imagem.
Proprietário	Cadeia	Especifica o locatário ao qual a imagem pertence.
ID	Cadeia	Especifica o ID da imagem.
Tamanho	Longitude	Este parâmetro não está disponível no momento.
próprio	Cadeia	Especifica o URL da imagem.
Esquema	Cadeia	Especifica o esquema de 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 upload 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 upload da imagem. active: indica que a imagem está disponível para uso.
Tags	Matriz de strings	Especifica as tags da imagem, por meio das quais você pode gerenciar imagens privadas de sua própria maneira. Você pode usar a API de tag de imagem para adicionar tags diferentes a cada imagem e filtrar imagens por tag.
Visibilidade	Cadeia	Especifica se a imagem está disponível para outros locatários. Os valores disponíveis incluem: private: imagem privada public: imagem pública shared: imagem compartilhada
Nome	Cadeia	Especifica o nome de imagem. Para uma descrição detalhada, consulte Atributos da imagem.
soma de verificação	Cadeia	Este parâmetro não está disponível no momento.
Protegida	Booleano	Especifica se a imagem está protegida. A imagem protegida não pode ser excluída. O valor pode ser true ou false.
formato_contêiner	Cadeia	Especifica o tipo de contêiner.
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. Você pode definir esse parâmetro com base nas especificações do ECS. Geralmente, você não precisa definir esse parâmetro.
atualizado_em	Cadeia	Especifica a hora em que a imagem foi atualizada. O valor está no formato UTC.
__os_bit	Cadeia	Especifica a arquitetura do SO, 32 ou 64 bits.
__os_versão	Cadeia	Especifica a versão do SO.
__descrição	Cadeia	Especifica a descrição da imagem. Para uma descrição detalhada, consulteAtributos da imagem.
formato_do_disco	Cadeia	Especifica o formato da imagem. O valor pode servhd, raw, zvhd,iso, ou qcow2. O valor padrão é vhd.
__está cadastrado	Cadeia	Especifica se a imagem foi registrada. O valor pode ser true ou false.
__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.
__os_tipo	Cadeia	Especifica o tipo de OS. O valor pode ser Linux, Windows, ou Other.
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.
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, o valor é FusionCompute. Para uma imagem de disco de dados, o valor é DataImage. Para uma imagem do BMS, o valor é Ironic. Para uma imagem ISO, o valor é IsoImage.
__imagem_tipo_fonte	Cadeia	Especifica o tipo de armazenamento de back-end da imagem. Somente UDS é suportado atualmente.
__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.
criado_em	Cadeia	Especifica a hora em que a imagem foi criada. O valor está no formato UTC.
tamanho_virtual	número inteiro	Este parâmetro não está disponível no momento.
__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, esse valor é deixado em branco.
__id_de_backup	Cadeia	Especifica o ID de backup. Para criar uma imagem usando um backup, defina o valor como o ID de backup. Caso contrário, este valor é deixado vazio.
__código do produto	Cadeia	Especifica o ID do produto de uma imagem do Marketplace.
__tamanho_da_imagem	Cadeia	Especifica o tamanho (bytes) do arquivo de imagem.
__origem_de_dados	Cadeia	Especifica a origem da imagem. Se a imagem é uma imagem pública, este parâmetro é deixado em branco.
__carregamento lento	Cadeia	Especifica se a imagem suporta carregamento lento. O valor pode ser true ou false.
ativo_em	Cadeia	Especifica o horário em que o status da imagem ficou active.
__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.
__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 memória grande. Se a imagem suportar os ECS de memória grande, o valor é true. Caso contrário, este parâmetro não é necessário.
__suporte_disco intensivo	Cadeia	Especifica se a imagem oferece suporte aos 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 aos 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. Veja Tabela 2 para cujo valor. 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 ECSs 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.
__mercado_de_suporte_do_sistema	Booleano	Especifica se uma imagem pode ser publicada no Marketplace. true: suportado false: não suportado
__é_offshelved	Cadeia	Especifica se a imagem do Marketplace foi desativada. true: A imagem foi desativada. false: A imagem não foi desativada.
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. Para obter mais informações sobre projetos corporativos, consulte Centro Empresarial.
__origem_raiz	Cadeia	Especifica que a imagem é criada a partir de um arquivo de imagem externo. Valor: file
__num_sequência	Cadeia	Especifica o ECSnúmero de classificação de disco do sistema 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.
hw_firmware_type	Cadeia	Especifica o ECSmodo de inicialização. Os valores disponíveis incluem: bios indica o modo de inicialização do BIOS. uefi indica o modo de inicialização do UEFI.
hw_vif_ativado_multifila	Cadeia	Especifica se a imagem suporta multifila NIC. O valor pode ser true ou false.
__sistema__cmkid	Cadeia	Especifica a ID da chave usada para encriptar a imagem.
__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.

Exemplo de resposta

CÓDIGO DE STATUS 200

      
       
         
         
           {
  "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",
      "__support_fc_inject":"true"
    },
    {
      "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",
      "__support_fc_inject":"true"
    }
  ]
}

          

        

      
     

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.

Consulta de imagens

Função

URI

Solicitação

Métodos Comuns de Consulta

Resposta

Valores retornados

Feedback

Esta página foi útil?