Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda> Elastic Cloud Server> Referência de API> Estrutura de dados> Estrutura de dados para criação dos ECS
Atualizado em 2022-11-08 GMT+08:00

Estrutura de dados para criação dos ECS

Notas

As API do ECS podem ser V1 ou V1.1. As API V1 só podem ser usadas para criar os ECS pagos por uso, enquanto as API V1.1 podem ser usadas para criar os ECS pagos por uso e anuais/mensais.

Para os campos descritos nesta seção, use as API V1.1 para os ECS anuais/mensais.

Conteúdo

Descrição do Campo publicip

Este campo é usado pelas seguintes API:
  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 1 descrição do campo publicip

Parâmetro

Obrigatório

Tipo

Descrição

id

Não

String

Especifica a ID do EIP existente atribuído ao ECS a ser criado. O valor está no formato UUID.

Somente os EIP no estado DOWN podem ser atribuídos.

eip

Não

Object

Especifica um EIP que será atribuído automaticamente a um ECS.

Para mais detalhes, consulte Tabela 3.

delete_on_termination

Não

Boolean

Especifica se o EIP é liberado quando o ECS ao qual o EIP está vinculado é excluído.

  • true: O EIP é liberado quando o ECS é excluído.
  • false: O EIP não é liberado quando o ECS é excluído.

O valor padrão é false.

NOTA:

Esse parâmetro está disponível apenas para os EIP de pagamento por uso.

id ou eip no campo publicip podem ser configurados.

descrição do campo security_groups

Este campo é usado pelas seguintes API:

  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 2 descrição do campo security_groups

Parâmetro

Obrigatório

Tipo

Descrição

id

Não

String

Especifica o ID do grupo de segurança ao qual um ECS deve ser adicionado. A configuração terá efeito nas NIC do ECS. Você precisa especificar o ID de um grupo de segurança existente no formato UUID. Caso contrário, o grupo de segurança padrão será usado na camada subjacente.

Descrição do campo eip

Este campo é usado pelas seguintes API:
  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 3 Descrição do campo eip

Parâmetro

Obrigatório

Tipo

Descrição

iptype

Sim

String

Especifica o tipo de EIP.

Para obter detalhes, consulte a descrição do campo publicip em Atribuição de um EIP.

bandwidth

Sim

Object

Especifica a largura de banda EIP.

Para mais detalhes, consulte bandwidth descrição do campo.

bandwidth descrição do campo

Este campo é usado pelas seguintes API:
  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 4 descrição do campo de bandwidth

Parâmetro

Obrigatório

Tipo

Descrição

size

Sim

Integer

Especifica o tamanho da largura de banda.

Especifica a largura de banda (Mbit/s). O valor varia de 1 a 300.

O intervalo específico pode variar dependendo da configuração em cada região. Você pode ver a faixa de largura de banda de cada região no console de gerenciamento.

O incremento mínimo para ajuste de largura de banda varia dependendo da faixa de largura de banda.
  • O incremento mínimo é de 1 Mbit/s se a largura de banda permitida varia de 0 Mbit/s a 300 Mbit/s (com 300 Mbit/s incluídos).
  • O incremento mínimo é de 50 Mbit/s se a largura de banda permitida varia de 300 Mbit/s a 1000 Mbit/s (com 1000 Mbit/s incluídos).
  • O incremento mínimo é de 500 Mbit/s se a largura de banda permitida for maior que 1000 Mbit/s.
NOTA:

Este parâmetro é obrigatório quando sharetype é definido como PER e é opcional quando sharetype é definido como WHOLE com um ID especificado.

sharetype

Sim

String

Especifica o tipo de compartilhamento de largura de banda.

Valores enumerados: PER (indica largura de banda exclusiva) e WHOLE (indica compartilhamento)

chargemode

Não

String

Especifica o modo de faturamento da largura de banda.

  • Se o valor do campo for traffic, o ECS será cobrado pelo tráfego.
  • Se o valor do campo for outro, a criação de ECS falhará.

Descrição do Campo ipv6_bandwidth

Este campo é usado pelas seguintes API:
  • Criação dos ECS: /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 5 Descrição do campo ipv6_bandwidth

Parâmetro

Obrigatório

Tipo

Descrição

id

Não

String

Especifica a ID de uma largura de banda IPv6.

Descrição do campo extendparam para atribuição dos EIP

Este campo é usado pela seguinte API:

Criando os ECS /v1.1/{project_id}/cloudservers

Tabela 6 descrição do campo extendparam para atribuição dos EIP

Parâmetro

Obrigatório

Tipo

Descrição

chargingMode

Não

String

Especifica o modo de faturamento de um EIP.

Opções:

  • prePaid: indica o modo de faturamento anual/mensal.
  • postPaid: indica o modo de faturamento pay-per-use.
    NOTA:

    Se sharetype no parâmetro bandwidth com um ID especificado for definido como WHOLE, somente os EIP de pagamento por uso serão permitidos e o parâmetro prePaid não estará disponível.

Descrição do Campo extendparam para Criação de Discos

Este campo é usado pelas seguintes API:

  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 7 Descrição do campo extendparam para criar discos

Parâmetro

Obrigatório

Tipo

Descrição

resourceSpecCode

Não

String

Especifica o código das especificações do disco, como SATA, SAS ou SSD.

NOTA:

Este campo foi descartado.

resourceType

Não

String

Especifica o tipo de recurso.

NOTA:

Este campo foi descartado.

snapshotId

Não

String

Especifica o ID do instantâneo ou o ID do disco de dados original contido na imagem ECS completa.

Cenários de Aplicação:

Esse parâmetro é usado se um ECS for criado usando uma imagem ECS completa e a imagem contiver um ou mais discos de dados.

Se você usar uma imagem ECS completa para criar um ECS, o sistema restaurará automaticamente o tipo de dados e os dados dos discos de dados na imagem. O parâmetro snapshotId permite especificar o tipo de disco para o disco de dados original após a restauração.

NOTA:
  • É aconselhável definir snapshotId para cada disco de dados original. Caso contrário, os discos de dados originais sem snapshotId especificado usarão as configurações padrão.
  • Se for necessário alterar um tamanho de disco, verifique se o tamanho do disco alterado é maior ou igual ao tamanho do disco de dados original. Caso contrário, a restauração dos dados do disco de dados original falhará.

Regras de trabalho:

O snapshotId identifica exclusivamente um disco de dados original contido em uma imagem ECS completa. Você pode usar snapshotId para obter as informações do disco de dados original para restauração de dados.

Obtendo snapshotId por meio do console de gerenciamento:

Faça login no console de gerenciamento, escolha Elastic Volume Service > Snapshot. Em seguida, use o nome do disco de dados original para localizar o ID do instantâneo ou o ID do disco original.

Obtenção de snapshotId por meio da API:

Se você obteve o ID de imagem do ECS completo, obtenha o ID de backup do CBR (Cloud Backup and Recovery) ou do CSBS (Cloud Server Backup Service) associado ao ID de imagem do ECS completo seguindo as instruções fornecidas na API para consultar os detalhes da imagem.
  • Se o backup do CBR for usado, use o ID de backup do CBR para obter o backup. O resource_id ou snapshot_id contido no campo filhos na resposta é o snapshotId desejado. Para obter detalhes, consulte a API para "Consulta de um backup especificado" no Guia de usuário do Cloud Backup and Recovery.
  • Se o backup do CSBS for usado, use o ID de backup do CSBS para obter o backup. O source_volume_id ou snapshot_id contido no campo volume_backups na resposta é o snapshotId desejado. Para obter detalhes, consulte a API para "Consultar um único backup" no Guia de usuário do Cloud Server Backup Service.

Descrição do Campo extendparam para Criação dos ECS

Este campo é usado pelas seguintes API:
  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 8 Descrição do campo extendparam para criar os ECS (para as API V1)

Parâmetro

Obrigatório

Tipo

Descrição

chargingMode

Não

Integer

Especifica o modo de cobrança.

  • 0: indica o modo de cobrança pay-per-use. O valor padrão é 0.

regionID

Não

String

Especifica a ID da região em que o ECS reside.

Consulte Regiões e Endpoints.

CB_CSBS_BACKUP

Não

String

Especifica uma ID de política CSBS e uma ID de cofre CSBS.

Por exemplo, um ID de política CSBS obtido no console é fdcaa27d-5be4-4f61-afe3-09ff79162c04.

Um ID de cofre CSBS é 332a9408-463f-436a-9e92-78dad95d1ac4.

O valor CB_CSBS_BACKUP é "{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}".
Tabela 9 Descrição do campo extendparam para criar os ECS (para as API V1.1)

Parâmetro

Obrigatório

Tipo

Descrição

chargingMode

Não

String

Especifica o modo de cobrança.

Opções:

  • prePaid: indica o modo de faturamento anual/mensal.
  • postPaid: indica o modo de faturamento pay-per-use.
  • O valor padrão é postPaid.
    NOTA:

    Quando o chargingMode estiver definido para prePaid (indicando que o ECS criado é faturado em pagamentos anuais/mensais) e o ECS é conectado usando uma chave SSH, op_svc_userid nos metadata é obrigatório.

regionID

Não

String

Especifica a ID da região onde o ECS reside.

Consulte Regiões e Endpoints.

periodType

Não

String

Especifica o período de subscrição.

Opções:

  • month: indica que a assinatura está na unidade do mês.
  • year: indica que a assinatura está na unidade do ano.
    NOTA:

    Este parâmetro é válido e obrigatório se chargingMode estiver definido como prePaid.

periodNum

Não

Integer

Especifica o número de períodos de assinatura.

Opções:

  • Se periodType for month, o valor varia de 1 a 9.
  • Se periodType for year, o valor varia de 1 a 3.
    NOTA:
    • Este parâmetro é válido e obrigatório se chargingMode estiver definido como prePaid.
    • O valor do parâmetro deve ser um número inteiro positivo.

isAutoRenew

Não

String

Especifica se a renovação automática está ativada.

  • true: indica que a renovação automática está ativada.
  • false: indica que a renovação automática está desativada.
    NOTA:

    Este parâmetro é válido quando chargingMode é definido como prePaid. Se esse parâmetro não for especificado, a renovação automática será desativada por padrão.

isAutoPay

Não

String

Especifica se o pedido é pago automática ou manualmente.

  • true: O pedido será pago automaticamente.
  • false: O pedido deve ser pago manualmente.
NOTA:

Este parâmetro é válido quando chargingMode está definido como prePaid. Se este parâmetro não for especificado, a ordem deve ser paga manualmente por padrão.

support_auto_recovery

Não

Boolean

Especifica se a recuperação automática do ECS deve ser ativada.

  • true: ativa essa função.
  • false: desativa esta função.
NOTA:

Este parâmetro é do tipo booleano. Se um caractere não-booleano for importado, o valor do parâmetro será definido como false.

marketType

Não

String

Especifica um ECS spot. Ao criar um ECS spot, defina o valor do parâmetro como spot.

NOTA:

Este parâmetro entra em vigor apenas quando chargingMode está definido para postPaid e marketType está definido para spot.

spotPrice

Não

String

Especifica o preço mais alto por hora aceito para um ECS spot.

NOTA:
  • Este parâmetro entra em vigor apenas quando chargingMode está definido para postPaid e marketType está definido para spot.
  • Quando chargingMode é definido como postPaid e marketType é definido como spot, se o parâmetro spotPrice não for especificado ou especificado como null, o preço de pagamento por uso é usado por padrão.
  • O valor spotPrice deve ser menor ou igual ao preçECS uso e maior ou igual ao preço de mercado de ECS.

Descrição do campo de metadata para criação de discos

Este campo é usado pelas seguintes API:

  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 10 descrição do campo de metadata para a criação de discos

Parâmetro

Obrigatório

Tipo

Descrição

__system__encrypted

Não

String

Especifica a criptografia em metadata. O valor pode ser 0 (criptografia desativada) ou 1 (criptografia ativada).

Se este parâmetro não existir, o disco não será criptografado por padrão.

__system__cmkid

Não

String

Especifica o ID CMK, que indica criptografia nos metadata. Este parâmetro é usado com __system__encrypted.

NOTA:

Para obter detalhes sobre como obter o ID de CMK, consulte Consulta da lista dos CMK.

Descrição do campo de metadados para criação dos ECS

Este campo é usado pelas seguintes API:

  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 11 descrição do campo reservado de metadata

Parâmetro

Obrigatório

Tipo

Descrição

op_svc_userid

Não

String

Especifica o ID do usuário.

NOTA:

Quando chargingMode no parâmetro extendparam está definido como prePaid (indicando que o ECS criado é faturado em pagamentos anuais/mensais) e o ECS estiver logado usando uma chave SSH, esse campo é obrigatório.

agency_name

Não

String

Especifica o nome da agência do IAM.

Uma agência é criada por um administrador de locatários no Identity and Access Management (IAM) para fornecer credenciais temporárias para que os ECS acessem os serviços em nuvem.

Descrição do campo os:scheduler_hints

Este campo é usado pelas seguintes API:
  • Criando os ECS /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
  • Criação de ECSs (API nativa): /v2.1/{project_id}/servers
Tabela 12 descrição do campo os:scheduler_hints (parâmetros de solicitação)

Parâmetro

Obrigatório

Tipo

Descrição

group

Não

String

Especifica uma ID de grupo ECS, que está no formato UUID.

Obtenha o valor do parâmetro no console ou executando as operações fornecidas em Consulta de grupos de ECS.

NOTA:

Verifique se o grupo ECS usa a política de antiafinidade. Você não é aconselhado a usar outras políticas.

tenancy

Não

String

Cria os ECS em um host dedicado ou compartilhado.

O valor deste parâmetro pode ser dedicated ou shared.

dedicated_host_id

Não

String

Especifica o ID do host dedicado.

NOTA:

Um ID de DeH entra em vigor somente quando o tenancy é definido como dedicated.
Tabela 13 descrição do campo os:scheduler_hints (parâmetros de resposta)

Parâmetro

Tipo

Descrição

group

Array of strings

Especifica uma ID de grupo de ECS, que está no formato UUID.

Obtenha o valor do parâmetro no console ou executando as operações fornecidas em Consulta de grupos de ECS.

tenancy

Array of strings

Cria os ECS em um host dedicado ou compartilhado.

O valor deste parâmetro pode ser dedicated ou shared.

dedicated_host_id

Array of strings

Especifica o ID do host dedicado.

NOTA:

Um ID de DeH entra em vigor somente quando o tenancy é definido como dedicated.

descrição do campo server_tags

Este campo é usado pelas seguintes API:
  • Criação dos ECS: /v1/{project_id}/cloudservers
  • Criação dos ECS: /v1.1/{project_id}/cloudservers
Tabela 14 descrição do campo server_tags

Parâmetro

Obrigatório

Tipo

Descrição

key

Sim

String

Especifica a chave de marcação.

A chave pode conter um máximo de 36 caracteres Unicode. Não pode ser deixado em branco ou conter ASCII (0-31) ou os seguintes caracteres: =*<>\,|/

A chave de tag de um ECS deve ser exclusiva.

value

Sim

String

Especifica o valor da tag.

O valor pode conter um máximo de 43 caracteres Unicode e pode ser deixado em branco. Não pode conter ASCII (0-31) ou os seguintes caracteres: =*<>\,|/
Tópico principal: Estrutura de dados