Consulta das tags
Função
Essa API é usada para consultar tags de imagem usando critérios de pesquisa e exibi-las em uma lista.
URI
GET /v1/cloudimages/tags{?__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 (&) comercial no final do URI para definir vários critérios de pesquisa. Para obter detalhes, consulte a solicitação de exemplo.
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:
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:
|
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:
|
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:
|
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:
|
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.
|
id_do_projeto_da_empresa |
Não |
Cadeia |
Especifica o projeto empresarial ao qual pertencem as imagens a serem consultadas.
|
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:
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:
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
Resposta
- Parâmetros de resposta
Parâmetro
Tipo
Descrição
Tags
Matriz de strings
Lista as tags.
- Exemplo de resposta
CÓDIGO DE STATUS 200
1 2 3 4 5 6 7 8 9
{ "tags": [ "jjjj.11111", "uuuu.22222", "234.4", "test", "image" ] }
Na nova especificação, sinais iguais são usados como separadores.
Valor retornado
- Normal
- 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.