Atualização de informações de imagem
Função
Essa API é usada para modificar atributos de imagem e atualizar informações de imagem.
Somente informações de imagens em estado active podem ser alteradas.
URI
PATCH /v2/cloudimages/{image_id}
Tabela 1 descreve os parâmetros no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id_imagem |
Sim |
Cadeia |
ID de imagem privada Para obter detalhes de como conseguir o ID de domínio, clique em Consulta de imagens. |
Solicitação
- Parâmetros de solicitação
Parâmetro
Obrigatório
Tipo
Descrição
[Array]
Sim
Matriz de objetos
Para mais detalhes, consulte Tabela 2.
Tabela 2 Descrição da estrutura de dados do campo [Array] Parâmetro
Obrigatório
Tipo
Descrição
OP
Sim
Cadeia
Especifica a operação. O valor pode ser add, replace, ou remove
Caminho
Sim
Cadeia
Especifica o nome do atributo a ser modificado. / precisa ser adicionado na frente dele.
Você pode modificar os seguintes atributos:
- name: especifica o nome da imagem.
- __description: especifica a descrição da imagem.
- __support_kvm: KVM é suportado.
- __support_xen: Xen é suportado.
- __support_diskintensive: O armazenamento intensivo é suportado.
- __support_highperformance: Computação de alto desempenho (HPC) é suportada.
- __support_xen_gpu_type: Os ECS acelerados por GPU que usam Xen para virtualização são suportados.
- __support_kvm_gpu_type: Os ECS acelerados por GPU que usam KVM para virtualização são compatíveis.
- __is_config_init: especifica se a configuração de inicialização está completa.
- enterprise_project_id: especifica o ID do projeto empresarial.
- min_ram: especifica a memória mínima.
- hw_vif_multiqueue_enabled A característica da multi-fila NIC é apoiada.
- hw_firmware_type: especifica o modo de inicialização. O valor pode ser BIOS ou UEFI.
Você pode adicionar ou excluir atributos de extensão.
Valor
Sim
Cadeia
Especifica o novo valor do atributo. Para uma descrição detalhada, consulte Atributos da imagem.
- Exemplo de solicitação
PATCH https://{Endpoint}/v2/cloudimages/33ad552d-1149-471c-8190-ff6776174a00
1 2 3 4 5 6 7
[ { "op": "replace", "path": "/name", "value": "ims_test" } ]
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 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. O valor pode ser um dos seguintes:
- 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
Fornece informações suplementares sobre a 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 ISO, o valor é IsoImage.
__imagem_tipo_fonte
Cadeia
Especifica o 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. 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 é uma imagem pública, este parâmetro é deixado em branco.
__origem_raiz
Cadeia
Especifica que a imagem é criada a partir de um arquivo de imagem externo. Valor: file
__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. Os seguintes valores são suportados:
- 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 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
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 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. Veja Tabela 2 para cujo valor. 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
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.
__mercado_de_suporte_do_sistema
Booleano
Especifica se uma imagem pode ser publicada no Marketplace.
- true: A imagem não pode ser publicada no Marketplace.
- false: A imagem não pode ser publicada no Marketplace.
__é_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 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.
__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
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 37 38
{ "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", "hw_vif_multiqueue_enabled": "true", "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", "__support_fc_inject":"true", "__data_origin": null, "hw_firmware_type": "bios" }
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.