Atualização de informações da imagem (API OpenStack nativo)
Função
Essa API é usada para modificar informações de imagem.
Restrições
Somente atributos personalizados, nome da imagem e descrição da imagem podem ser modificados.
URI
PATCH /v2/images/{image_id}
Tabela 1 lista os parâmetros.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id_imagem |
Sim |
Cadeia |
Especifica o ID da imagem. Para obter detalhes de como conseguir o ID de domínio, clique em Consulta de imagens. |
Solicitação
- Parâmetros de solicitação
Glance tem dois métodos de atualização de informações de imagem. O método é especificado por Content-Type no cabeçalho HTTP. application/openstack-images-v2.0-json-patch e application/openstack-images-v2.1-json-patch são suportados. Os tipos de conteúdo diferem apenas no formato do corpo da mensagem de solicitação.
Tabela 2 v2.1 body da mensagem de solicitação Parâmetro
Obrigatório
Tipo
Descrição
[Array]
Sim
Matriz de objetos
Para mais detalhes, consulte Tabela 3.
Tabela 3 Descrição da estrutura de dados do campo [Array] Parâmetro
Tipo
Obrigatório
Descrição
OP
Cadeia
Sim
Indica o tipo da operação de atualização, incluindo a substituição, adição e exclusão de um atributo.
O valor pode ser replace, add, ou remove.
Caminho
String
SIM
Indica o nome do atributo de destino.
Para replace e remove, o valor só pode ser um atributo existente da imagem. Para add, o valor pode ser um atributo existente ou um novo. Se o valor for um atributo existente, add terá o mesmo efeito que replace. Se o valor for um novo atributo, a operação de add é executada. Adicione uma barra (/) antes do nome do atributo.
Valor
Cadeia
Não
Indica o valor do atributo a ser atualizado ou adicionado.
Obrigatório para replace e add, e não para remove
Tabela 4 Body da mensagem de solicitação v2.0 Parâmetro
Obrigatório
Tipo
Descrição
[Array]
Sim
Matriz de objetos
Para mais detalhes, consulte Tabela 5.
Tabela 5 Descrição da estrutura de dados do campo [Array] Parâmetro
Tipo
Obrigatório
Descrição
SUBSTITUIÇÃO
Cadeia
Obrigatório para qualquer um dos três valores
Indica que um atributo de imagem será substituído. O valor é o atributo a ser substituído e uma barra (/) deve ser adicionada na frente do nome do atributo.
Adicionar
Cadeia
Indica que um atributo de imagem será adicionado. O valor é o atributo a ser adicionado e uma barra (/) deve ser adicionada na frente do nome do atributo.
remover
Cadeia
Indica que um atributo de imagem será excluído. O valor é o atributo a ser excluído e uma barra (/) deve ser adicionada na frente do nome do atributo.
Valor
Cadeia
Obrigatório para replace e add, e não para remove
Indica o valor do atributo a ser atualizado ou adicionado. Para uma descrição detalhada, consulte Atributos da imagem.
- Exemplo de solicitação
PATCH https://{Endpoint}/v2/images/33ad552d-1149-471c-8190-ff6776174a00
- Corpo da solicitação v2.1
1 2 3 4 5 6 7 8
"Content-Type:application/openstack-images-v2.1-json-patch" [ { "op": "replace", "path": "/name", "value": "test01" } ]
- Corpo da solicitação v2.0
1 2 3 4 5 6 7
"Content-Type:application/openstack-images-v2.0-json-patch" [ { "replace": "/name", "value": "test01" } ]
- Corpo da solicitação v2.1
Resposta
- Parâmetros de resposta
Parâmetro
Tipo
Descrição
Arquivo
Cadeia
Especifica o 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:
- 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. O valor pode ser:
- 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. O valor padrão é 0.
max_ram
Cadeia
Especifica a memória máxima (MB) da imagem. O valor do parâmetro depende das especificações do ECS e não é configurado por padrão.
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, consulte Atributos da imagem.
formato_do_disco
Cadeia
Especifica o formato da imagem. O valor pode vhd, zvhd, zvhd2, raw,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.
__sistema__cmkid
Cadeia
Especifica o ID da chave usada para encriptar a 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.
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.
__imagem_tipo_fonte
Cadeia
Especifica o armazenamento de backend 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, o valor será deixado vazio.
__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.
__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. O valor deve ser maior que 0.
__origem_de_dados
Cadeia
Especifica a origem da imagem.
Se a imagem for uma imagem pública, o valor é deixado vazio.
__origem_raiz
Cadeia
Especifica que a imagem é criada a partir de um arquivo de imagem externo. Valor: arquivo
__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.
__código_da_conta
Cadeia
Especifica o identificador de cobrança para a imagem.
hw_firmware_type
Cadeia
Especifica o modo de inicialização do ECS. O valor pode ser:
- bios indica o modo de inicialização do BIOS. Este valor será usado por falha se este parâmetro não existir na resposta.
- uefi indica o modo de inicialização UEFI.
hw_vif_ativado_multifila
Cadeia
Especifica se a imagem suporta multifila NIC. O valor pode ser true ou false.
__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 pode ser usada para criar 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.
Para os SOs compatíveis, consulte Os SO suportados por diferentes tipos dos ECS.
__suporte_disco intensivo
Cadeia
Especifica se a imagem pode ser usada para criar os ECS com uso intensivo 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 pode ser usada para criar 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 parâmetro 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 parâmetro 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 parâmetro 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 parâmetro não pode coexistir com __support_xen.
__é_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.
__num_sequência
Cadeia
Especifica o número de classificação de disco do sistema do ECS correspondente à imagem.
Este parâmetro não está disponível no momento.
__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.
__localização_da_imagem
Cadeia
Especifica o local onde a imagem é armazenada.
__is_config_init
Cadeia
Especifica se a configuração inicial está concluída. O valor pode ser true ou false.
__apoio_amd
Cadeia
Especifica se a imagem usa a arquitetura x86 da AMD. O valor pode ser true ou false.
__lista_de_apoio_agente
Cadeia
Especifica os agentes configurados para a imagem.
- hss: O agente do Host Security Service (HSS) é configurado para a imagem.
- ces: O agente de monitoramento do host é configurado para a imagem.
Exemplo:
"__lista_do_agente_de_suporte": "hss,ces"
NOTA:Se a resposta não contiver esse campo, o HSS e os agentes de monitoramento de host não serão configurados para a imagem.
- Exemplo de resposta
CÓDIGO DE STATUS 200
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
{ "file": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00/file", "owner": "0b1e494e2660441a957313163095fe5c", "id": "33ad552d-1149-471c-8190-ff6776174a00", "size": 2, "self": "/v2/images/33ad552d-1149-471c-8190-ff6776174a00", "schema": "/v2/schemas/image", "status": "active", "tags": [], "visibility": "private", "name": "ims_test", "checksum": "99914b932bd37a50b983c5e7c90ae93b", "protected": false, "container_format": "bare", "min_ram": 0, "updated_at": "2015-12-08T02:30:49Z", "__os_bit": "64", "__os_version": "Ubuntu 14.04 server 64bit", "__description": "ims test", "disk_format": "vhd", "__isregistered": "true", "__platform": "Ubuntu", "__os_type": "Linux", "min_disk": 40, "virtual_env_type": "FusionCompute", "__image_source_type": "uds", "__imagetype": "private", "created_at": "2015-12-04T09:45:33Z", "virtual_size": 0, "__originalimagename": "33ad552d-1149-471c-8190-ff6776174a00", "__backup_id": "", "__productcode": "", "__image_size": "449261568", "__data_origin": null, "hw_firmware_type":"bios" }
Valores retornados
- Normal
- Anormal
Valor retornado
Descrição
400 Solicitação inválida
Erro na solicitação. Para mais detalhes, 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.