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

Função

Esta API é usada para criar uma única instância de banco de dados do RDS, instância de banco de dados primária/em espera ou réplica de leitura.

• Antes de chamar uma API, você precisa entender a API em Autenticação.

URI

• Formato de URI

  POST /v3/{project_id}/instances

• Descrição do parâmetro

  Tabela 1 Descrição do parâmetro

  Nome	Obrigatório	Descrição
  project_id	Sim	Especifica o ID do projeto de um locatário em uma região. Para obter detalhes sobre como obter o ID do projeto, consulte Obtenção de um ID de projeto.

Solicitação

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

• Exemplo

  POST https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances

• Exemplo de solicitação

  Criação de uma única instância de banco de dados:

  {
  	"name": "rds-instance-rep2",
  	"datastore": {
  		"type": "MySQL",
  		"version": "5.6"
  	},
  	"flavor_ref": "rds.mysql.s1.large",
  	"volume": {
  		"type": "ULTRAHIGH",
  		"size": 100
  	},
  	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
  	"region": "aaa",
  	"availability_zone": "bbb",
  	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  	"data_vip": "192.168.0.147",
  	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  	"port": 8635,
  	"backup_strategy": {
  		"start_time": "08:15-09:15",
  		"keep_days": 12
  	},
  	"charge_info": {
  		"charge_mode": "postPaid"
  	},
  	"password": "****",
  	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
  	"enterprise_project_id": "fdsa-3rds",
  	"time_zone": "UTC+04:00",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	],
          "dry_run": false,
          "count": 12
  }

  Criação de uma única instância de banco de dados do MySQL 8.0 com parâmetros de inicialização especificados:

  {
  	"name": "rds-instance-rep2",
  	"datastore": {
  		"type": "MySQL",
  		"version": "8.0"
  	},
  	"flavor_ref": "rds.mysql.s1.large",
  	"volume": {
  		"type": "ULTRAHIGH",
  		"size": 100
  	},
  	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
  	
  	"region": "aaa",
  	
  	"availability_zone": "bbb",
  	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  	"data_vip": "192.168.0.147",
  	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  	"port": 8635,
  	"backup_strategy": {
  		"start_time": "08:15-09:15",
  		"keep_days": 12
  	},
  	"charge_info": {
  		"charge_mode": "postPaid"
  	},
  	"password": "****",
  	"configuration_id": "452408-ef4b-44c5-94be-305145fg"
  	"enterprise_project_id": "fdsa-3rds",
  	"time_zone": "UTC+04:00",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	],
  	"unchangeable_param": {
  		"lower_case_table_names": "1"
  	},
          "dry_run": false,
          "count": 12
  }

  Criação de uma única instância de banco de dados do SQL Server com agrupamento especificado:

  {
  	"name": "rds-instance-rep2",
  	"datastore": {
  		"type": "SQLServer",
  		"version": "2014_SE"
  	},
  	"flavor_ref": "rds.mssql.se.m3.large.8",
  	"volume": {
  		"type": "ULTRAHIGH",
  		"size": 100
  	},
  	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
  	"region": "aaa",
  	"availability_zone": "bbb",
  	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  	"data_vip": "192.168.0.147",
  	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  	"port": 8635,
  	"backup_strategy": {
  		"start_time": "08:15-09:15",
  		"keep_days": 12
  	},
  	"charge_info": {
  		"charge_mode": "postPaid"
  	},
          "collation": "Cyrillic_General_CI_AS",
  	"password": "****",
  	"configuration_id": "452408-ef4b-44c5-94be-305145fg"
  	"enterprise_project_id": "fdsa-3rds",
  	"time_zone": "UTC+04:00",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	],
  }

  Criação de uma instância primária/em espera:

  {
  	"name": "rds-instance-rep2",
  	"datastore": {
  		"type": "MySQL",
  		"version": "5.6"
  	},
  	"ha": {
  		"mode": "ha",
  		"replication_mode": "semisync"
  	},
  	"flavor_ref": "rds.mysql.s1.large.ha",
  	"volume": {
  		"type": "ULTRAHIGH",
  		"size": 100
  	},
  	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
  	"region": "aaa",
  	"availability_zone": "bbb,ccc",
  	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  	"data_vip": "192.168.0.147",
  	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  	"port": 8635,
  	"backup_strategy": {
  		"start_time": "08:15-09:15",
  		"keep_days": 12
  	},
  	"charge_info": {
  		"charge_mode": "postPaid"
  	},
  	"password": "****",
  	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
  	"enterprise_project_id": "fdsa-3rds",
  	"time_zone": "UTC+04:00",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	],
          "dry_run": false,
          "count": 12
  }

  Criação de uma réplica de leitura:

  {
  	"name": "rds-instance-rep2",
  	"replica_of_id": "afdsad-fds-fdsagin01",
  	"flavor_ref": "rds.mysql.s1.large.rr",
  	"volume": {
  		"type": "ULTRAHIGH"
  	},
  	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
  	"region": "aaa",
  	"availability_zone": "bbb",
  	"enterprise_project_id": "fdsa-3rds",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	]
  }

Resposta

• Resposta normal

  Tabela 12 Descrição do parâmetro

  Nome	Tipo	Descrição
  instance	Object	Indica as informações da instância de banco de dados. Para mais detalhes, consulte Tabela 13.
  job_id	String	Indica o ID da tarefa de criação da instância de banco de dados. Para obter detalhes sobre como consultar detalhes da tarefa, consulte Obtenção de informações sobre uma tarefa com um ID especificado. Esse parâmetro é retornado somente quando instâncias de banco de dados pagamento por uso são criadas.
  order_id	String	Indica o ID do pedido. Este parâmetro é retornado para a criação de uma instância de banco de dados anual/mensal.

  Tabela 13 Descrição da estrutura de dados do campo instance

  Nome	Tipo	Descrição
  id	String	Indica o ID da instância de banco de dados. Se as instâncias forem criadas em lotes, vários IDs de instância separados por vírgulas (,) serão retornados para o mecanismo de banco de dados MySQL. Para outros mecanismos de banco de dados, esse parâmetro é deixado em branco.
  name	String	Indica o nome da instância de banco de dados. Instâncias de banco de dados do mesmo tipo podem ter os mesmos nomes sob o mesmo locatário. Valor válido: O nome da instância de banco de dados deve ter de 4 a 64 bytes, começar com uma letra e conter apenas letras (sensíveis a maiúsculas e minúsculas), dígitos, hifens (-) e sublinhados (_).
  status	String	Indica o status da instância de banco de dados. Por exemplo, BUILD indica que a instância de banco de dados está sendo criada. Esse parâmetro é retornado somente quando instâncias de banco de dados pagamento por uso são criadas.
  datastore	Object	Indica as informações de banco de dados. Para mais detalhes, consulte Tabela 14.
  ha	Object	Indica os parâmetros de configuração de HA. Esse parâmetro é retornado somente quando instâncias de banco de dados primárias/em espera são criadas. Para mais detalhes, consulte Tabela 15.
  configuration_id	String	Indica o ID do modelo de parâmetro. Esse parâmetro é retornado somente quando um modelo de parâmetro personalizado é usado durante a criação da instância de banco de dados.
  port	String	Indica a porta de banco de dados, que é a mesma que o parâmetro de solicitação.
  backup_strategy	Object	Indica a política de backup automático. Para mais detalhes, consulte Tabela 16.
  enterprise_project_id	String	Indica o ID do projeto.
  disk_encryption_id	String	Indica o ID da chave para criptografia de disco. Por padrão, esse parâmetro está vazio, e é retornado somente quando é especificado durante a criação da instância de banco de dados.
  flavor_ref	String	Indica o código de especificação. O valor não pode estar vazio. Para obter detalhes, consulte spec_code em Tabela 3 na seção Consulta de especificações de banco de dados.
  volume	Object	Indica as informações de volume. Para mais detalhes, consulte Tabela 17.
  region	String	Indica o ID da região.
  availability_zone	String	Indica o ID da AZ.
  vpc_id	String	Indica o ID da VPC. Para obter esse valor de parâmetro, use um dos seguintes métodos: Método 1: faça logon no console da VPC e visualize o ID da VPC nos detalhes da VPC. Método 2: para obter detalhes, consulte a seção "Consulta das VPCs" na Referência de API da Virtual Private Cloud.
  subnet_id	String	Indica o ID da rede. Para obter esse valor de parâmetro, use um dos seguintes métodos: Método 1: faça logon no console da VPC e clique na sub-rede de destino na página Subnets. Você pode exibir o ID da rede na página exibida. Método 2: para obter detalhes, consulte a seção "Consulta das VPCs" na Referência de API da Virtual Private Cloud.
  security_group_id	String	Indica o grupo de segurança ao qual a instância de banco de dados RDS pertence. Para obter esse valor de parâmetro, use um dos seguintes métodos: Método 1: faça logon 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 a seção "Consulta de grupos de segurança" na Referência de API da Virtual Private Cloud.
  charge_info	Object	Indica as informações de cobrança, que são anuais/mensais ou pagamento por uso. Para mais detalhes, consulte Tabela 18.
  collation	String	Indica o conjunto de agrupamento para RDS for SQL Server.
  restore_point	Object	Indica as informações de restauração. Este parâmetro é obrigatório quando os dados são restaurados para uma nova instância. Para mais detalhes, consulte Tabela 19.

  Tabela 14 Descrição da estrutura de dados do campo datastore

  Nome	Tipo	Descrição
  type	String	Indica o mecanismo de banco de dados. valor: MySQL PostgreSQL SQLServer
  version	String	Indica a versão de banco de dados. Para obter detalhes sobre as versões de banco de dados suportadas, consulte a seção Consulta de informações de versão sobre um mecanismo de banco de dados.

  Tabela 15 Descrição da estrutura de dados do campo ha

  Nome	Tipo	Descrição
  mode	String	Indica o tipo de instância primária/em espera ou cluster. O valor é Ha.
  replication_mode	String	Indica o modo de replicação para a instância de banco de dados em espera. Esse parâmetro é válido somente quando a instância é uma instância de HA. Valor: Para RDS for MySQL, o valor é async ou semisync. Para o RDS for PostgreSQL, o valor é async ou sync. Para o RDS for SQL Server, o valor é sync. NOTA: async indica o modo de replicação assíncrona. semisync indica o modo de replicação semi-síncrona. sync indica o modo de replicação síncrona.

  Tabela 16 Descrição da estrutura de dados de campo backupStrategy

  Nome	Tipo	Descrição
  start_time	String	Indica a janela de tempo de backup. Os backups automáticos 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, 15, 30 ou 45. Valor de exemplo 08:15-09:15 23:00-00:00 Se backup_strategy no corpo da solicitação estiver vazio, 02:00-03:00 será retornado para start_time por padrão.
  keep_days	Integer	Indica os dias de retenção para arquivos de backup específicos. O intervalo de valores é de 0 a 732. Se esse parâmetro não for especificado ou definido como 0, a política de backup automático será desativada. Para estender o período de retenção, entre em contato com o atendimento ao cliente. Os backups automáticos podem ser mantidos por até 2.562 dias. Se backup_strategy no corpo da solicitação estiver vazio, 7 será retornado para keep_days por padrão.

  Tabela 17 Descrição da estrutura de dados do campo volume

  Nome	Tipo	Descrição
  type	String	Indica o tipo de volume. Seu valor pode ser qualquer um dos seguintes e diferencia maiúsculas de minúsculas: ULTRAHIGH: Armazenamento SSD (ultra-alta I/O). LOCALSSD: armazenamento SSD local. CLOUDSSD: armazenamento SSD em nuvem. Este tipo de armazenamento é suportado apenas com instâncias de banco de dados dedicadas e de uso geral. ESSD: armazenamento SSD extrema.
  size	Integer	Indica o tamanho do volume. O intervalo de valor é de 40 GB a 4.000 GB. O valor deve ser um múltiplo de 10.

  Tabela 18 Descrição da estrutura de dados do campo chargeInfo

  Nome	Tipo	Descrição
  charge_mode	String	Indica as informações de cobrança, que é anuais/mensais ou pagamento por uso.
  period_num	Integer	Indica o período de subscrição, que é calculado por mês. Esse parâmetro é válido quando charge_mode está definido como prePaid (criação de instâncias de banco de dados anuais/mensais).

  Tabela 19 Descrição da estrutura de dados do restore_point

  Nome	Tipo	Descrição
  instance_id	String	Especifica o ID da instância de origem.
  type	String	Especifica o modo de restauração. backup: indica o uso de arquivos de backup para restauração. timestamp: indica a restauração de ponto no tempo.
  backup_id	String	Especifica o ID do backup a ser restaurado.
  restore_time	Integer	Especifica o ponto de tempo da restauração de dados no carimbo de data/hora UNIX. A unidade é milissegundo e o fuso horário é UTC.
  database_name	Map<String,String>	Este parâmetro é suportado apenas para bases de dados do Microsoft SQL Server. Se esse parâmetro for especificado, você poderá restaurar bancos de dados específicos e renomear novos bancos de dados.

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

• Exemplo de resposta normal

  Criação de uma única instância de banco de dados do MySQL:

  {
  	"instance": {
  		"id": "dsfae23fsfdsae3435in01",
  		"name": "trove-instance-rep2",
  		"datastore": {
  			"type": "MySQL",
  			"version": "5.6"
  		},
  		"flavor_ref": "rds.mysql.s1.large",
  		"volume": {
  			"type": "ULTRAHIGH",
  			"size": 100
  		},
  		"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
                  "region": "aaa",
  		"availability_zone": "bbb",
  		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  		"port": "8635",
  		"backup_strategy": {
  			"start_time": "08:15-09:15",
  			"keep_days": 3
  		},
  		"configuration_id": "452408-44c5-94be-305145fg",
  		"charge_info": {
  			"charge_mode": "postPaid"
  		}
  	},
  	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
  }

  Criação de uma única instância de banco de dados do SQL Server:

  {
  	"instance": {
  		"id": "dsfae23fsfdsae3435in01",
  		"name": "trove-instance-rep2",
  		"datastore": {
  			"type": "sqlserver",
  			"version": "2014_SE"
  		},
  		"flavor_ref": "rds.mssql.2014.se.s3.large.2",
  		"volume": {
  			"type": "ULTRAHIGH",
  			"size": 100
  		},
  		"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
                  "region": "aaa",
  		"availability_zone": "bbb",
  		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
  		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
  		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
  		"port": "8635",
  		"backup_strategy": {
  			"start_time": "08:15-09:15",
  			"keep_days": 3
  		},
  		"configuration_id": "452408-44c5-94be-305145fg",
  		"charge_info": {
  			"charge_mode": "postPaid"
  		},
                 "collation": "Cyrillic_General_CI_AS" 
  	},
  	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
  }

  Criação de uma instância de banco de dados primária/em espera:

  {
    "instance":{ 
             "id": "dsfae23fsfdsae3435in01",
             "name": "trove-instance-rep2", 
             "datastore": { 
               "type": "MySQL", 
               "version": "5.6" 
              }, 
             "ha": {
               "mode": "ha",
               "replication_mode": "semisync"
             },
             "flavor_ref": "rds.mysql.s1.large.ha",
             "volume": { 
                 "type": "ULTRAHIGH", 
                 "size": 100 
               },
             "disk_encryption_id":  "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
             "region": "aaa",
             "availability_zone": "bbb,ccc",
             "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
             "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
             "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
             "port": "8635", 
             "backup_strategy": { 
               "start_time": "08:15-09:15", 
               "keep_days": 3 
              }, 
             "configuration_id": "452408-44c5-94be-305145fg",
             "charge_info": {
                     "charge_mode": "postPaid"
                                 },
           },
    "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" 
  }

  Criação de uma réplica de leitura:

  {
    "instance":{ 
              "id": "dsfae23fsfdsae3435in01",
              "name": "trove-instance-rep2", 
              "flavor_ref": "rds.mysql.s1.large.rr",
               "volume": { 
                 "type": "ULTRAHIGH", 
                 "size": 100 
               },
             "disk_encryption_id":  "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
             "region": "aaa",
             "availability_zone": "bbb",
             "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
             "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
             "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
             "port": "8635", 
             "configuration_id": "452408-44c5-94be-305145fg"
           },
   "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"  
  }

• Resposta anormal

  Para mais detalhes, consulte Resultados anormais da solicitação.

Código de status

• Normal

  202

• Anormal

  Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.