Criação de uma instância de banco de dados

Descrição da API

Essa API é usada para criar instâncias de cluster e conjunto de réplicas.

Restrições

Essa API é compatível com instâncias de banco de dados anuais/mensais e de pagamento por uso.

Depuração

Você pode depurar essa API no API Explorer.

URI

Formato de URI
POST https://{Endpoint}/v3/{project_id}/instances
Exemplo de URI
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances

**Tabela 1** Parâmetros de solicitação
Nome	Tipo	IN	Obrigatório	Descrição
x-auth-token	string	header	Sim	Token do usuário
project_id	string	path	Sim	ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.

Solicitações

Descrição do parâmetro

**Tabela 2** Descrição do parâmetro
Nome	Tipo	Obrigatório	Descrição
name	String	Sim	O nome da instância de banco de dados. O nome da ocorrência pode ser igual a um nome existente. O nome da ocorrência deve conter de 4 a 64 caracteres e deve começar com uma letra. É sensível a maiúsculas e minúsculas e pode conter letras, dígitos, hífens (-) e sublinhados (_). Não pode conter outros caracteres especiais.
datastore	Object	Sim	As informações do banco de dados. Para mais detalhes, consulte Tabela 3.
region	String	Sim	A ID da região. O valor não pode estar vazio. Para obter detalhes sobre como obter esse valor de parâmetro, consulte Regiões e pontos de extremidade.
availability_zone	String	Sim	A identificação da AZ. Você pode selecionar várias AZs para criar um cluster entre AZ com base em az_status retornado pela API descrita em Consulta de especificações do banco de dados. O valor não pode estar vazio. Para obter detalhes sobre como obter esse valor de parâmetro, consulte Regiões e pontos de extremidade.
vpc_id	String	Sim	O ID da VPC. Para obter esse valor de parâmetro, use um dos seguintes métodos: Método 1: Faça login no console da VPC e visualize o ID da VPC na página de detalhes da VPC. Método 2: Consulte o ID da VPC por meio da API da VPC. Para obter detalhes, consulte Consulta de VPCs.
subnet_id	String	Sim	A ID de rede da sub-rede. Para obter esse valor de parâmetro, use um dos seguintes métodos: Método 1: Faça login no console da VPC e clique na sub-rede de destino na página Subnets. Você pode visualizar o ID da rede na página exibida. Método 2: Consulte o ID da rede por meio da API da VPC. Para obter detalhes, consulte Consulta de sub-redes.
security_group_id	String	Sim	O ID do grupo de segurança. Para obter o ID do grupo de segurança, execute um dos seguintes métodos: Método 1: Faça login no console da VPC. Escolha Access Control > Security Groups no painel de navegação à esquerda. Na página exibida, clique no grupo de segurança de destino. Você pode exibir o ID do grupo de segurança na página exibida. Método 2: Consulte o grupo de segurança por meio da API da VPC. Para obter detalhes, consulte Consulta de grupos de segurança.
port	String	Não	Porta de acesso ao banco de dados Intervalo de valores: 2100-9500, 27017, 27018 e 27019. Se este parâmetro não for transferido, a porta da instância de banco de dados criada será 8635 por padrão.
password	String	Não	A senha do banco de dados. O valor deve ter de 8 a 32 caracteres e conter letras maiúsculas (A a Z), minúsculas (a a z), dígitos (0 a 9) e caracteres especiais, como ~!@#%^*-_=+? Digite uma senha forte para melhorar a segurança, evitando riscos de segurança, como quebra de força bruta. Se esse parâmetro não for transferido, defina uma senha para a instância antes de se conectar à instância. Para obter detalhes, consulte Redefinição da senha do administrador.
disk_encryption_id	String	Não	A ID da chave usada para criptografia de disco. A cadeia deve concordar com as regras de expressão regular do UUID. Se esse parâmetro não for transferido, a criptografia de disco não será executada.
mode	String	Sim	O tipo de instância. Instâncias de cluster e conjunto de réplicas são suportadas. Valor válido: Sharding ReplicaSet Single
configurations	Array of objects	Não	Informações de configuração do grupo de parâmetros. Para mais detalhes, consulte Tabela 4. Se este parâmetro não for transferido, o grupo de parâmetros padrão é usado.
flavor	Array of objects	Sim	As especificações da instância. Para obter mais informações, consulte Tabela 5. Para obter detalhes sobre como obter o valor, consulte os valores de resposta do flavor em Consulta de especificações do banco de dados.
backup_strategy	Object	Não	A política de backup avançada. Para obter mais informações, consulte Tabela 6.
enterprise_project_id	String	Não	A ID do projeto corporativo. Este parâmetro não é transferido para usuários que não habilitaram o serviço multiprojeto corporativo. Se esse parâmetro não for transferido para um usuário que habilitou o serviço multiprojeto corporativo, o valor será o projeto corporativo padrão. Para obter a ID do projeto empresarial, consulte o valor de id na tabela enterprise_project field data structure na seção "Consulta da lista do projeto corporativo" da Referência de API do Enterprise Management.
ssl_option	String	Não	Especifica se deve habilitar ou desabilitar o SSL. Valor válido: O valor 0 indica que o SSL está desabilitado por padrão. O valor 1 indica que o SSL está habilitado por padrão. Se esse parâmetro não for transferido, o SSL será desabilitado por padrão.
dss_pool_id	String	Não	O ID de armazenamento dedicado do usuário de DeC. O valor é deixado em branco por padrão. Somente os usuários de DeC suportam este parâmetro.
server_group_policies	Array of strings	Não	Os nomes das políticas associadas ao grupo do ECS do usuário de DeC. Somente os usuários de DeC suportam este parâmetro. Os valores são os seguintes: anti-affinity indica que a implantação de anti-afinidade está ativada para a instância do DDS. Para garantir alta disponibilidade, os nós primários, secundários e ocultos são criados em diferentes máquinas físicas. Se esse parâmetro não for especificado para usuários de dezembro, a implantação de antiafinidade será desabilitada por padrão.
tags	Array of objects	Não	Tags Um máximo de 20 tags podem ser adicionadas para cada instância. Para mais detalhes, consulte Tabela 7.
charge_info	Object	Não	Modo de cobrança, que inclui anual/mensal e pagamento por uso. O modo de cobrança padrão é pagamento por uso. Para mais detalhes, consulte Tabela 8.

**Tabela 3** Estrutura de dados do campo datastore
Nome	Tipo	Obrigatório	Descrição
type	String	Sim	O tipo de banco de dados. O valor é DDS-Community.
version	String	Sim	A versão do banco de dados. As versões 4.2, 4.0 e 3.4 são suportadas. O valor pode ser 4.2, 4.0 ou 3.4. NOTA: O DDS 4.2 é restrito para uso comercial. Para obter detalhes, consulte Avisos do DDS. Para garantir que você tenha uma boa experiência usando o DDS, crie uma instância do DDS 4.0.
storage_engine	String	Sim	O motor de armazenamento. O DDS suporta os mecanismos de armazenamento WiredTiger e RocksDB. Se a versão do banco de dados for 4.2 e o mecanismo de armazenamento for RocksDB, o valor será rocksDB. Se a versão do banco de dados for 4.0 ou 3.4 e o mecanismo de armazenamento for WiredTiger o valor será wiredTiger.

**Tabela 4** Estrutura de dados do campo Configurations
Parâmetro	Tipo	Obrigatório	Descrição
type	String	Sim	Tipo de nó. Valor válido: Para uma instância de cluster, o valor pode ser mongos, shard ou config. Para uma instância de conjunto de réplicas, o valor é replica. Para uma instância de nó único, o valor é single. Valores enumerados: mongos shard config replica single
configuration_id	String	Sim	ID do grupo de parâmetros. Para mais detalhes, consulte Tabela 4.

**Tabela 5** Estrutura de dados do campo de flavor
Nome	Tipo	Obrigatório	Descrição
type	String	Sim	O tipo de nó. Valor válido: Para uma instância de cluster, o valor pode ser mongos, shard ou config. Para uma instância do conjunto de réplicas, o valor é replica. Para uma instância de nó único, o valor é single.
num	String	Sim	Número de nós ou grupos. Valor válido: Se o valor de type for mongos, num indica o número de nós mongos na instância do cluster. O valor varia de 2 a 16. Se o valor do type for shard, num indica o número de grupos de estilhaços na instância do cluster. O valor varia de 2 a 16. Se o valor de type for config, num indica o número de grupos de configuração na instância do cluster. O valor só pode ser 1. Se o valor do tipo for type for replica, num indica o número de nós de réplica na instância do conjunto de réplicas. O valor pode ser 3, 5 ou 7. Se o valor de type for single, num indica o número de nós em uma única instância de nó. O valor só pode ser 1.
storage	String	Não	O tipo de disco. Valor válido: ULTRAHIGH, que indica o tipo do SSD. Esse parâmetro é válido para os nós de shard e configuração de uma instância de cluster e para instâncias de conjunto de réplicas. Este parâmetro é inválido para nós mongos. Portanto, você não precisa especificar o espaço de armazenamento para os nós mongos.
size	String	Não	O tamanho do disco. Este parâmetro é obrigatório para todos os nós, exceto mongos. Este parâmetro é inválido para os nós mongos. O valor deve ser um múltiplo de 10. A unidade é GB. Para uma instância de cluster, o espaço de armazenamento de um nó de shard pode ser de 10 a 2.000 GB e o espaço de armazenamento de configuração é de 20 GB. Este parâmetro é inválido para nós mongos. Portanto, você não precisa especificar o espaço de armazenamento para os nós mongos. Para uma instância de conjunto de réplicas, o valor varia de 10 a 3000. Para uma única instância de nó, o valor varia de 10 a 1000.
spec_code	String	Sim	O código de especificação do recurso. Para obter detalhes sobre como obter o valor, consulte os valores de resposta de spec_code em Consulta de especificações do banco de dados. Em uma instância de cluster, várias especificações precisam ser especificadas. Todas as especificações devem ser da mesma série, isto é, de uso geral (s6), melhorada (c3) ou melhorada II (c6). Exemplo: dds.mongodb.s6.large.4.mongos e dds.mongodb.s6.large.4.config têm as mesmas especificações. dds.mongodb.s6.large.4.mongos e dds.mongodb.c3.large.4.config não têm as mesmas especificações.

**Tabela 6** Estrutura de dados do campo backup_strategy
Nome	Tipo	Obrigatório	Descrição
start_time	String	Sim	A janela de tempo de backup. Os backups automatizados serão acionados durante a janela de tempo de backup. O valor não pode estar vazio. Deve ser um valor válido no formato "hh:mm-HH:MM". A hora atual está no formato UTC. O valor de HH deve ser 1 maior que o valor de hh. Os valores de mm e MM devem ser os mesmos e devem ser definidos como 00. Se esse parâmetro não for transferido, a janela de tempo de backup padrão será definida como 00:00-01:00. Valor de exemplo 23:00-00:00
keep_days	String	Não	O número de dias para reter os arquivos de backup gerados. A faixa de valores é de 0 a 732. Se esse parâmetro for definido como 0, a política de backup automatizado não será definida. Se esse parâmetro não for transferido, a política de backup automático será ativada por padrão. Os arquivos de backup são armazenados por sete dias por padrão.

**Tabela 7** Estrutura de dados do campo tags
Nome	Tipo	Obrigatório	Descrição
key	String	Sim	Chave da tag. O valor pode conter um máximo de 36 caracteres Unicode. A chave não pode ser deixada em branco ou uma cadeia vazia. O conjunto de caracteres é o seguinte: A-Z, a-z, 0-9, hífens (-) e caracteres sublinhados (_), e Unicode (\u4E00-\u9FFF).
value	String	Sim	Valor da tag. Ele contém um máximo de 43 caracteres Unicode. O valor pode ser uma cadeia vazia. O conjunto de caracteres é o seguinte: A-Z, a-z, 0-9, hífens (-) e caracteres de sublinhado (_), e Unicode (\u4E00-\u9FFF).

**Tabela 8** Estrutura de dados do campo ChargeInfo
Parâmetro	Tipo	Obrigatório	Descrição
charge_mode	String	Sim	Modo de cobrança. Intervalo de valores: prePaid: indica o modo de cobrança anual/mensal. postPaid: indica o modo de cobrança de pagamento por uso.
period_type	String	Não	Período de subscrição. Esse parâmetro é válido e obrigatório somente quando charge_mode estiver definido como prePaid. Intervalo de valores: month: o serviço é subscrito por mês. year: o serviço é subscrito por ano.
period_num	Integer	Não	Este parâmetro é válido e obrigatório se charge_mode estiver definido como prePaid. Intervalo de valores: Se period_type for definido como month, o valor do parâmetro varia de 1 a 9. Se period_type for definido como year, o valor do parâmetro varia de 1 a 3.
is_auto_renew	Boolean	Não	Se a renovação automática está ativada para instâncias anuais/mensais. O período de renovação é o mesmo que o período original e o pedido será pago automaticamente durante a renovação da assinatura. Intervalo de valores: true: indica que a assinatura é renovada automaticamente. false: indica que a assinatura não é renovada automaticamente. O valor padrão é false.
is_auto_pay	Boolean	Não	Método de pagamento. Ao criar uma instância de banco de dados anual/mensal, você pode especificar se deseja pagar automaticamente com sua conta. Este parâmetro não afeta o método de pagamento de renovação automática. Intervalo de valores: true: indica que a taxa é paga automaticamente da conta. false: indica que a taxa é paga manualmente a partir da conta. Este método de pagamento é usado por padrão.

Os valores de region e availability_zone são usados como exemplos.

Exemplo de solicitação

Criar uma instância de cluster:

{
  "name": "test-cluster-01",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.2",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "availability_zone": "az1xahz",
  "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
  "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
  "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
  "password": "******",
  "mode": "Sharding",
  "configurations": [
    {
      "type": "mongos",
      "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02"
    },
    {
      "type": "shard",
      "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02"
    },
    {
      "type": "config",
      "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02"
    }
  ],
  "flavor": [
    {
      "type": "mongos",
      "num": 2,
      "spec_code": "dds.mongodb.c6.medium.4.mongos"
    },
    {
      "type": "shard",
      "num": 2,
      "storage": "ULTRAHIGH",
      "size": 20,
      "spec_code": "dds.mongodb.c6.medium.4.shard"
    },
    {
      "type": "config",
      "num": 1,
      "storage": "ULTRAHIGH",
      "size": 20,
      "spec_code": "dds.mongodb.c6.large.2.config"
    }
  ],
  "backup_strategy": {
    "start_time": "08:15-09:15",
    "keep_days": 8
  },
  "ssl_option": 1,
  "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
  "server_group_policies": [
    "anti-affinity"
  ],
  "tags": [
    {
      "key": "dds001",
      "value": "dds001"
    }
  ]
}

Criar uma instância de cluster cross-AZ.

{
  "name": "test-cluster-01",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.4",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "availability_zone": "aaa,bbb,ccc",
  "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
  "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
  "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
  "password": "******",
  "mode": "Sharding",
  "flavor": [
    {
      "type": "mongos",
      "num": 2,
      "spec_code": "dds.mongodb.c6.medium.4.mongos"
    },
    {
      "type": "shard",
      "num": 2,
      "storage": "ULTRAHIGH",
      "size": 20,
      "spec_code": "dds.mongodb.c6.medium.4.shard"
    },
    {
      "type": "config",
      "num": 1,
      "storage": "ULTRAHIGH",
      "size": 20,
      "spec_code": "dds.mongodb.c6.large.2.config"
    }
  ],
  "backup_strategy": {
    "start_time": "23:00-00:00",
    "keep_days": "8"
  },
  "ssl_option":"1",
  "tags" : [{ 
    "key" : "dds001", 
    "value" : "dds001" 
  }]
}

Criação de uma instância de conjunto de réplicas

{
  "name": "test-replicaset",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.2",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "availability_zone": "az1xahz",
  "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
  "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
  "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
  "password": "******",
  "mode": "ReplicaSet",
  "configurations": [
    {
      "type": "replica",
      "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02"
    }
  ],
  "flavor": [
    {
      "type": "replica",
      "num": 1,
      "storage": "ULTRAHIGH",
      "size": 30,
      "spec_code": "dds.mongodb.c6.medium.4.repset"
    }
  ],
  "backup_strategy": {
    "start_time": "08:15-09:15",
    "keep_days": 8
  },
  "ssl_option": 1,
  "tags": [
    {
      "key": "dds001",
      "value": "dds001"
    }
  ]
}

Criação de uma instância de nó único

{
  "name": "test-singlenode",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.2",
    "storage_engine": "wiredTiger"
  },
  "region": "aaa",
  "availability_zone": "az1xahz",
  "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
  "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007",
  "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
  "password": "******",
  "mode": "Single",
  "configurations": [
    {
      "type": "single",
      "configuration_id": "b8e962e66ede47609a94cba591735b49pr02"
    }
  ],
  "flavor": [
    {
      "type": "single",
      "num": 1,
      "storage": "ULTRAHIGH",
      "size": 30,
      "spec_code": "dds.mongodb.c6.medium.4.single"
    }
  ],
  "backup_strategy": {
    "start_time": "08:15-09:15",
    "keep_days": 8
  },
  "ssl_option": 1,
  "tags": [
    {
      "key": "dds001",
      "value": "dds001"
    }
  ]
}

Respostas

Descrição do parâmetro

**Tabela 9** Descrição do parâmetro
Nome	Tipo	Obrigatório	Descrição
id	String	Não	Indica o ID da instância de banco de dados.
name	String	Não	O mesmo que o parâmetro request.
datastore	Object	Não	Indica as informações do banco de dados, que são as mesmas que o parâmetro de solicitação. Para obter mais informações, consulte Tabela 10.
created	String	Não	Indica o tempo de criação no seguinte formato: aaaa-mm-dd hh:mm:ss.
status	String	Não	Indica o status da instância de banco de dados. O valor é creating.
region	String	Não	Indica o ID da região, que é o mesmo que o parâmetro de solicitação.
availability_zone	String	Não	Indica o ID da AZ, que é o mesmo que o parâmetro de solicitação.
vpc_id	String	Não	Indica o ID da VPC, que é o mesmo que o parâmetro de solicitação.
subnet_id	String	Não	Indica o ID de rede da sub-rede, que é o mesmo que o parâmetro de solicitação.
security_group_id	String	Não	Indica o ID do grupo de segurança, que é o mesmo que o parâmetro de solicitação.
port	Integer	Não	Indica a porta do banco de dados.
disk_encryption_id	String	Não	Indica o ID da chave de criptografia do disco, que é o mesmo que o parâmetro de solicitação.
mode	String	Não	Indica o tipo de instância, que é o mesmo que o parâmetro de solicitação.
configurations	Array of objects	Não	Informações de configuração do grupo de parâmetros. Para mais detalhes, consulte Tabela 11.
flavor	Array of objects	Não	Indica a especificação da instância, que é a mesma que o parâmetro de solicitação. Para obter mais informações, consulte Tabela 12.
backup_strategy	Object	Não	Indica a política de backup avançada, que é igual ao parâmetro de solicitação. Para obter mais informações, consulte Tabela 13.
enterprise_project_id	String	Não	Indica a ID do projeto da empresa. Se o valor for 0, o recurso pertence ao projeto corporativo padrão.
ssl_option	String	Não	Indica se o SSL deve ser ativado, que funciona da mesma forma que o parâmetro de solicitação.
dss_pool_id	String	Não	Indica o ID do pool de armazenamento DSS, que é o mesmo que o parâmetro de solicitação.
job_id	String	Não	Indica o ID do fluxo de trabalho para criar uma instância de banco de dados.
tags	Array of objects	Não	Lista de tags, que é o mesmo que o parâmetro de solicitação. Para mais detalhes, consulte Tabela 14.
order_id	String	Não	O ID do pedido para criar uma instância. Este parâmetro é retornado somente quando você cria uma instância anual/mensal.
charge_info	Object	Não	Modo de cobrança, que é o mesmo que o parâmetro de solicitação. Para mais detalhes, consulte Tabela 15.

**Tabela 10** Estrutura de dados do campo datastore
Nome	Tipo	Obrigatório	Descrição
type	String	Sim	O tipo de banco de dados. O valor é DDS-Community.
version	String	Sim	A versão do banco de dados. As versões 4.2, 4.0 e 3.4 são suportadas. O valor pode ser 4.2, 4.0 ou 3.4. NOTA: O DDS 4.2 é restrito para uso comercial. Para obter detalhes, consulte Avisos do DDS. Para garantir que você tenha uma boa experiência usando o DDS, crie uma instância do DDS 4.0.
storage_engine	String	Sim	O motor de armazenamento. O DDS suporta os mecanismos de armazenamento WiredTiger e RocksDB. Se a versão do banco de dados for 4.2 e o mecanismo de armazenamento for RocksDB, o valor será rocksDB. Se a versão do banco de dados for 4.0 ou 3.4 e o mecanismo de armazenamento for WiredTiger o valor será wiredTiger.

**Tabela 11** Estrutura de dados do campo Configurations
Parâmetro	Tipo	Obrigatório	Descrição
type	String	Sim	Tipo de nó. Valor válido: Para uma instância de cluster, o valor pode ser mongos, shard ou config. Para uma instância de conjunto de réplicas, o valor é replica. Para uma instância de nó único, o valor é single. Valores enumerados: mongos shard config replica single
configuration_id	String	Sim	ID do grupo de parâmetros. Para mais detalhes, consulte Tabela 4.

**Tabela 12** Estrutura de dados do campo de flavor
Nome	Tipo	Obrigatório	Descrição
type	String	Sim	O tipo de nó. Valor válido: Para uma instância de cluster, o valor pode ser mongos, shard ou config. Para uma instância do conjunto de réplicas, o valor é replica. Para uma instância de nó único, o valor é single.
num	String	Sim	Número de nós ou grupos. Valor válido: Se o valor de type for mongos, num indica o número de nós mongos na instância do cluster. O valor varia de 2 a 16. Se o valor do type for shard, num indica o número de grupos de estilhaços na instância do cluster. O valor varia de 2 a 16. Se o valor de type for config, num indica o número de grupos de configuração na instância do cluster. O valor só pode ser 1. Se o valor do tipo for type for replica, num indica o número de nós de réplica na instância do conjunto de réplicas. O valor pode ser 3, 5 ou 7. Se o valor de type for single, num indica o número de nós em uma única instância de nó. O valor só pode ser 1.
storage	String	Não	O tipo de disco. Valor válido: ULTRAHIGH, que indica o tipo do SSD. Esse parâmetro é válido para os nós de shard e configuração de uma instância de cluster e para instâncias de conjunto de réplicas. Este parâmetro é inválido para nós mongos. Portanto, você não precisa especificar o espaço de armazenamento para os nós mongos.
size	String	Não	O tamanho do disco. Este parâmetro é obrigatório para todos os nós, exceto mongos. Este parâmetro é inválido para os nós mongos. O valor deve ser um múltiplo de 10. A unidade é GB. Para uma instância de cluster, o espaço de armazenamento de um nó de shard pode ser de 10 a 2.000 GB e o espaço de armazenamento de configuração é de 20 GB. Este parâmetro é inválido para nós mongos. Portanto, você não precisa especificar o espaço de armazenamento para os nós mongos. Para uma instância de conjunto de réplicas, o valor varia de 10 a 3000. Para uma única instância de nó, o valor varia de 10 a 1000.
spec_code	String	Sim	O código de especificação do recurso. Para obter detalhes sobre como obter o valor, consulte os valores de resposta de spec_code em Consulta de especificações do banco de dados. Em uma instância de cluster, várias especificações precisam ser especificadas. Todas as especificações devem ser da mesma série, isto é, de uso geral (s6), melhorada (c3) ou melhorada II (c6). Exemplo: dds.mongodb.s6.large.4.mongos e dds.mongodb.s6.large.4.config têm as mesmas especificações. dds.mongodb.s6.large.4.mongos e dds.mongodb.c3.large.4.config não têm as mesmas especificações.

**Tabela 13** Estrutura de dados do campo backup_strategy
Nome	Tipo	Obrigatório	Descrição
start_time	String	Sim	A janela de tempo de backup. Os backups automatizados serão acionados durante a janela de tempo de backup. O valor não pode estar vazio. Deve ser um valor válido no formato "hh:mm-HH:MM". A hora atual está no formato UTC. O valor de HH deve ser 1 maior que o valor de hh. Os valores de mm e MM devem ser os mesmos e devem ser definidos como 00. Se esse parâmetro não for transferido, a janela de tempo de backup padrão será definida como 00:00-01:00. Valor de exemplo 23:00-00:00
keep_days	String	Não	O número de dias para reter os arquivos de backup gerados. A faixa de valores é de 0 a 732. Se esse parâmetro for definido como 0, a política de backup automatizado não será definida. Se esse parâmetro não for transferido, a política de backup automático será ativada por padrão. Os arquivos de backup são armazenados por sete dias por padrão.

**Tabela 14** Estrutura de dados do campo tags
Nome	Tipo	Obrigatório	Descrição
key	String	Sim	Chave da tag. O valor pode conter um máximo de 36 caracteres Unicode. A chave não pode ser deixada em branco ou uma cadeia vazia. O conjunto de caracteres é o seguinte: A-Z, a-z, 0-9, hífens (-) e caracteres sublinhados (_), e Unicode (\u4E00-\u9FFF).
value	String	Sim	Valor da tag. Ele contém um máximo de 43 caracteres Unicode. O valor pode ser uma cadeia vazia. O conjunto de caracteres é o seguinte: A-Z, a-z, 0-9, hífens (-) e caracteres de sublinhado (_), e Unicode (\u4E00-\u9FFF).

**Tabela 15** Estrutura de dados do campo ChargeInfo
Parâmetro	Tipo	Obrigatório	Descrição
charge_mode	String	Sim	Modo de cobrança. Intervalo de valores: prePaid: indica o modo de cobrança anual/mensal. postPaid: indica o modo de cobrança de pagamento por uso.
period_type	String	Não	Período de subscrição. Esse parâmetro é válido e obrigatório somente quando charge_mode estiver definido como prePaid. Intervalo de valores: month: o serviço é subscrito por mês. year: o serviço é subscrito por ano.
period_num	Integer	Não	Este parâmetro é válido e obrigatório se charge_mode estiver definido como prePaid. Intervalo de valores: Se period_type for definido como month, o valor do parâmetro varia de 1 a 9. Se period_type for definido como year, o valor do parâmetro varia de 1 a 3.
is_auto_renew	Boolean	Não	Se a renovação automática está ativada para instâncias anuais/mensais. O período de renovação é o mesmo que o período original e o pedido será pago automaticamente durante a renovação da assinatura. Intervalo de valores: true: indica que a assinatura é renovada automaticamente. false: indica que a assinatura não é renovada automaticamente. O valor padrão é false.
is_auto_pay	Boolean	Não	Método de pagamento. Ao criar uma instância de banco de dados anual/mensal, você pode especificar se deseja pagar automaticamente com sua conta. Este parâmetro não afeta o método de pagamento de renovação automática. Intervalo de valores: true: indica que a taxa é paga automaticamente da conta. false: indica que a taxa é paga manualmente a partir da conta. Este método de pagamento é usado por padrão.

Os valores de region e availability_zone são usados como exemplos.

Exemplo de resposta

Instância do cluster:

{
  "id": "39b6a1a278844ac48119d86512e0000bin02",
  "name": "test-cluster-01",
  "datastore": {
    "type": "DDS-Community",
    "version": "3.4",
    "storage_engine": "wiredTiger"
  },
  "created": "2019-01-16 09:34:36",
  "status": "creating",
  "region": "aaa",
  "availability_zone": "az1xahz",
  "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
  "mode": "Sharding",
  "configurations": [
    {
      "type": "mongos",
      "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02"
    },
    {
      "type": "shard",
      "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02"
    },
    {
      "type": "config",
      "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02"
    }
  ],
  "flavor": [
    {
      "type": "mongos",
      "num": 2,
      "spec_code": "dds.mongodb.c6.medium.4.mongos"
    },
    {
      "type": "shard",
      "num": 2,
      "spec_code": "dds.mongodb.c6.medium.4.shard",
      "size": 20
    },
    {
      "type": "config",
      "num": 1,
      "spec_code": "dds.mongodb.c6.large.2.config",
      "size": 20
    }
  ],
  "backup_strategy": {
    "start_time": "08:15-09:15",
    "keep_days": "8"
  },
  "enterprise_project_id": "",
  "ssl_option": "1",
  "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd",
  "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
  "tags": [
    {
      "key": "dds001",
      "value": "dds001"
    }
  ]
}

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.

Código de status

Para obter mais informações, consulte Código de status.

Código de erro

Para obter mais informações, consulte Código de erro.