Importação rápida de um arquivo de imagem
Função
Essa API é usada para criar rapidamente uma imagem privada a partir de um arquivo de imagem externo superdimensionado que foi carregado no bucket do OBS. Atualmente, apenas arquivos de imagem ZVHD2 e RAW são suportados, e o tamanho de um arquivo de imagem não pode exceder 1 TB.
A função de criação rápida de imagens está disponível apenas para arquivos de imagem no formato RAW ou ZVHD2. Para outros formatos de arquivos de imagem menores que 128 GB, é aconselhável importar esses arquivos com o método comum.
A API é assíncrona. Se for chamado com sucesso, o sistema de serviço em nuvem recebe a solicitação. No entanto, você precisa usar a API de consulta de trabalho assíncrono para consultar o status de criação da imagem. Para mais detalhes, consulte Consulta dos trabalhos assíncronos.
Restrições
- Os arquivos de imagem RAW foram otimizados e os arquivos bitmap foram gerados.
- Os arquivos de imagem ZVHD2 foram otimizados conforme necessário.
Para obter detalhes sobre como converter o formato de arquivo de imagem e gerar um arquivo bitmap, consulte Importação rápida de um arquivo de imagem.
URI
POST /v2/cloudimages/quickimport/action
Solicitação
- Parâmetros no corpo da solicitação quando um arquivo de imagem é usado para criar uma imagem de disco do sistema
Parâmetro
Obrigatório
Tipo
Descrição
Nome
Sim
Cadeia
Especifica o nome de imagem.
Para uma descrição detalhada, consulte Atributos da imagem.
Descrição
Não
Cadeia
Fornece informações suplementares sobre a imagem.
Para uma descrição detalhada, consulte Atributos da imagem.
O valor contém um máximo de 1024 caracteres e consiste apenas em letras e dígitos. Não são permitidos retornos de carro e colchetes angulares (< >). Este parâmetro é deixado em branco por padrão.
os_version
Sim
Cadeia
Especifica a versão do SO.
Esse parâmetro é válido se um arquivo de imagem externo carregado no bucket do OBS for usado para criar uma imagem. Para cujo valor, veja Valores de parâmetros relacionados.
image_url
Sim
Cadeia
Especifica a URL do arquivo de imagem externo no intervalo do OBS.
Esse parâmetro é obrigatório se um arquivo de imagem externo no bucket do OBS for usado para criar uma imagem. O formato é nome de bucket do OBS:nome de arquivo de imagem.
NOTA:A classe de armazenamento do bucket do OBS deve ser Standard.
disco_mínimo
Sim
número inteiro
Especifica o tamanho mínimo (GB) do disco do sistema.
- Esse parâmetro é obrigatório se um arquivo de imagem externo no bucket do OBS for usado para criar uma imagem.
- O valor varia de 1 a 1024 e deve ser maior que o tamanho do arquivo de imagem selecionado.
Tags
Não
Matriz de strings
Lista as tags de imagem. Este parâmetro é deixado em branco por padrão.
Defina tags ou image_tags.
image_tags
Não
Matriz de objetos
Lista as tags de imagem. O valor é deixado em branco por padrão.
Defina tags ou image_tags.
Tipo
Não
String
Especifica o tipo de imagem. O valor do parâmetro é ECS/BMS para imagens de disco do sistema. O valor padrão é ECS.
enterprise_project_id
No
String
Especifica o projeto da empresa ao qual a imagem pertence.
- Se o valor for 0 ou deixado em branco, a imagem pertence ao projeto empresarial 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 e como obter os ID de projeto corporativo, consulte Centro Empresarial
Arquitetura
No
Cadeia
Especifica o tipo de arquitetura de imagem. Os valores disponíveis incluem:
- x86
- Arm
O valor padrão é x86.
NOTA:Se a arquitetura da imagem for ARM, o modo de inicialização é automaticamente alterado para UEFI.
- Descrição de parâmetros quando um arquivo de imagem carregado no bucket do OBS é usado para criar uma imagem
Parâmetro
Obrigatório
Tipo
Descrição
Nome
SIM
Cadeia
Especifica o nome de imagem. Para uma descrição detalhada, consulte Atributos da imagem.
Descrição
Não
Cadeia
Fornece informações suplementares sobre a imagem. Para uma descrição detalhada, consulte Atributos da imagem. O valor contém um máximo de 1024 caracteres e consiste apenas em letras e dígitos. Não são permitidos retornos de carro e colchetes angulares (< >). Este parâmetro é deixado em branco por padrão.
os_type
Não
Cadeia
Especifica a versão do SO.
Quando uma imagem de disco de dados é criada, o valor pode ser Linux ou Windows. O padrão é Linux.
image_url
Sim
Cadeia
Especifica a URL do arquivo de imagem externo no intervalo do OBS.
Esse parâmetro é obrigatório se um arquivo de imagem externo no bucket do OBS for usado para criar uma imagem. O formato é nome de bucket do OBS:nome de arquivo de imagem.
NOTA:A classe de armazenamento do bucket do OBS deve ser Standard.
disco_mínimo
Sim
número inteiro
Especifica o tamanho mínimo do disco do sistema na unidade de GB.
Esse parâmetro é obrigatório se um arquivo de imagem externo no bucket do OBS for usado para criar uma imagem. O valor varia de 1 a 1024.
Tags
Não
Matriz de strings
Lista as tags de imagem. Este parâmetro é deixado em branco por padrão.
Defina tags ou image_tags.
image_tags
Não
Matriz de objetos
Lista as tags de imagem. O valor é deixado em branco por padrão.
Defina tags ou image_tags.
Tipo
Sim
Cadeia
Especifica o tipo de imagem. O valor do parâmetro é DataImage para imagens de disco de dados.
id_do_projeto_da_empresa
Não
Cadeia
Especifica o projeto da empresa ao qual a imagem pertence.
- Se o valor for 0 ou deixado em branco, a imagem pertence ao projeto empresarial 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 e como obter os ID de projeto corporativo, consulte Centro Empresarial
- Exemplo de solicitações
- Criando uma imagem de disco do sistema usando um arquivo de imagem externo
POST https://{Endpoint}/v2/cloudimages/quickimport/action
Se o parâmetro tags for usado:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
{ "name": "ims_test_file", "description": "Create an image using a file in the OBS bucket.", "image_url": "ims-image:centos70.zvhd2", "os_version": "CentOS 7.0 64bit", "min_disk": 40, "type": "ECS", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
Se o parâmetro image_tags for usado:
1 2 3 4 5 6 7 8 9
{ "name": "ims_test_file", "description": "Create an image using a file in the OBS bucket.", "image_url": "ims-image:centos70.zvhd2", "os_version": "CentOS 7.0 64bit", "min_disk": 40, "type": "ECS", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
- Criando uma imagem de disco de dados usando um arquivo de imagem externo
POST https://{Endpoint}/v2/cloudimages/quickimport/action
Se o parâmetro tags for usado:
1 2 3 4 5 6 7 8 9 10 11 12 13
{ "name": "ims_test_file", "description": "Create an image using a file in the OBS bucket.", "image_url": "ims-image:centos70.qcow2", "os_type": "Linux", "min_disk": 40, "type": "DataImage", "tags": [ "aaa.111", "bbb.333", "ccc.444" ] }
Se o parâmetro image_tags for usado:
1 2 3 4 5 6 7 8 9
{ "name": "ims_test_file", "description": "Create an image using a file in the OBS bucket.", "image_url": "ims-image:centos70.qcow2", "os_type": "Linux", "min_disk": 40, "type": "DataImage", "image_tags": [{"key":"key2","value":"value2"},{"key":"key1","value":"value1"}] }
- Criando uma imagem de disco do sistema usando um arquivo de imagem externo
Resposta
- Parâmetros de resposta
Parâmetro
Tipo
Descrição
trabalho_id
Cadeia
Especifica a ID do trabalho assíncrono.
Para mais detalhes, consulte Consulta dos trabalhos assíncronos.
- Exemplo de resposta
CÓDIGO DE STATUS 200
1 2 3
{ "job_id": "8a12fc664fb4daa3014fb4e581380005" }
Valores retornados
- Normal
- Anormal
Valor de retorno
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.