Todos os produtos
Search
Central de documentação

Tair (Redis® OSS-Compatible):CreateTairInstance

Última atualização: Sep 10, 2026

Cria uma instância nativa da nuvem do Tair (Enhanced Edition).

Descrição da operação

Para obter informações sobre a seleção de instâncias, consulte o Guia de seleção do ApsaraDB for Tair (compatível com Redis® OSS).

Certifique-se de compreender totalmente os métodos de cobrança e os preços do ApsaraDB for Tair (compatível com Redis® OSS) antes de invocar esta operação.

Nota

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

  • API: A API que você pode chamar para executar a ação.

  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

kvstore:CreateTairInstance

create

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/*

  • kvstore:InstanceClass
  • kvstore:InstanceType
Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

RegionId

string

Sim

O ID da região. Você pode chamar DescribeRegions para consultar as regiões disponíveis. Use este parâmetro para especificar a região na qual a instância será criada.

cn-hangzhou

InstanceName

string

Não

O nome da instância. O nome deve atender aos seguintes requisitos:

  • O nome deve ter de 2 a 80 caracteres.

  • O nome deve começar com uma letra ou um caractere chinês e não pode conter espaços ou os seguintes caracteres especiais: @/:="<>{[]}.

apitest

Password

string

Não

A senha da instância. A senha deve atender aos seguintes requisitos:

  • A senha deve ter de 8 a 32 caracteres.

  • A senha deve conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, caracteres especiais e dígitos. Os caracteres especiais suportados são !@#$%^&*()_+-=.

Pass!123456

InstanceClass

string

Sim

O tipo de instância. Para obter mais informações, consulte:

tair.scm.standard.4m.32d

ZoneId

string

Não

O ID da zona primária. Você pode chamar DescribeRegions para consultar as zonas disponíveis. Use este parâmetro para especificar a zona na qual a instância será criada.

Nota

Você também pode especificar o parâmetro SecondaryZoneId para definir uma zona secundária. Os nós primário e secundário são implantados nas zonas primária e secundária especificadas para implementar uma arquitetura primária/secundária de centro duplo na mesma cidade. Por exemplo, defina ZoneId como cn-hangzhou-h e SecondaryZoneId como cn-hangzhou-g.

cn-hangzhou-h

SecondaryZoneId

string

Não

O ID da zona secundária. Você pode chamar DescribeRegions para consultar as zonas disponíveis.

Nota

O valor deste parâmetro deve ser diferente do valor de ZoneId. Você não pode definir este parâmetro como o ID de uma multizona.

cn-hangzhou-g

ChargeType

string

Não

O método de cobrança. Valores válidos:

  • PrePaid (padrão): assinatura.

  • PostPaid: pós-pago.

Valores válidos:

  • PostPaid :

    PostPaid.

  • PrePaid :

    PrePaid.

PrePaid

VpcId

string

Sim

O ID da VPC. Você pode chamar a operação DescribeVpcs da VPC para consultar os IDs de VPC.

vpc-bp1nme44gek34slfc****

VSwitchId

string

Sim

O ID do vSwitch na VPC especificada. Você pode chamar a operação DescribeVpcs da VPC para consultar os IDs de vSwitch.

vsw-bp1e7clcw529l773d****

Period

integer

Não

O período de assinatura. Unidade: meses. Valores válidos: 1 a 9, 12, 24, 36 e 60.

Nota

Este parâmetro é obrigatório quando ChargeType é definido como PrePaid.

1

BusinessInfo

string

Não

O ID da atividade e as informações comerciais.

000000000

CouponNo

string

Não

O código do cupom.

youhuiquan_promotion_option_id_for_blank

SrcDBInstanceId

string

Não

Para criar uma instância a partir de um conjunto de backups de uma instância existente, especifique o ID da instância de origem neste parâmetro.

Nota

Em seguida, use o parâmetro BackupId, ClusterBackupId (recomendado para instâncias de cluster nativas da nuvem) ou RestoreTime para especificar o conjunto de backups ou o ponto no tempo. Este parâmetro deve ser usado em conjunto com um dos três parâmetros anteriores.

r-bp1zxszhcgatnx****

BackupId

string

Não

O ID do conjunto de backups da instância de origem. O sistema usa os dados armazenados no conjunto de backups para criar a instância. Você pode invocar DescribeBackups para consultar o BackupId. Se a instância de origem for uma instância de cluster, especifique os IDs dos conjuntos de backups de todos os shards da instância de origem, separados por vírgulas (,). Exemplo: "10**,11**,15**".

Nota

Se a sua instância for uma instância de cluster de arquitetura nativa da nuvem, recomendamos que você invoque DescribeClusterBackupList para obter o ID do conjunto de backups do cluster, como "cb-xx", e então especifique o parâmetro de solicitação ClusterBackupId para clonar a instância de cluster. Dessa forma, você não precisa especificar os IDs dos conjuntos de backups de shards individuais.

2158****20

ClusterBackupId

string

Não

O ID do conjunto de backups do cluster. Algumas novas arquiteturas de cluster suportam IDs de conjuntos de backups de cluster. Você pode chamar a operação DescribeClusterBackupList para obter o ID.

  • Se suportado, especifique o ID do conjunto de backups do cluster. Você não precisa especificar o parâmetro BackupId.

  • Se não for suportado, especifique os IDs dos conjuntos de backups de todos os shards da instância de origem no parâmetro BackupId, separados por vírgulas (,). Exemplo: "2158****20,2158****22".

cb-hyxdof5x9kqb****

RecoverConfigMode

string

Não

Especifica se devem ser restauradas as informações de conta, parâmetro de kernel (config) ou lista de permissões do conjunto de backups original ao criar uma instância a partir de um conjunto de backups especificado. Por exemplo, para restaurar as informações da conta, defina este parâmetro como account.

O valor padrão é vazio, o que indica que as informações de conta, parâmetro de kernel e lista de permissões não são restauradas do conjunto de backups original.

Nota

Este parâmetro é aplicável apenas a instâncias nativas da nuvem. O conjunto de backups original deve conter as informações de conta, parâmetro de kernel ou lista de permissões. Você pode chamar a operação DescribeBackups para verificar se o parâmetro RecoverConfigMode do conjunto de backups especificado contém as informações anteriores.

whitelist,config,account

PrivateIpAddress

string

Não

O endereço IP privado da instância.

Nota

O endereço IP deve estar dentro do bloco CIDR do vSwitch ao qual a instância pertence. Você pode chamar a operação DescribeVSwitches da VPC para consultar as informações do bloco CIDR.

172.16.88.***

AutoUseCoupon

string

Não

Especifica se deve ser usado um cupom. Valores válidos:

  • true: usa um cupom.

  • false (padrão): não usa um cupom.

true

AutoRenew

string

Não

Especifica se a renovação automática deve ser ativada. Valores válidos:

  • true: ativa a renovação automática.

  • false (padrão): desativa a renovação automática.

true

AutoRenewPeriod

string

Não

O período de renovação automática. Unidade: meses. Valores válidos: 1, 2, 3, 6 e 12.

Nota

Este parâmetro é obrigatório quando AutoRenew é definido como true.

3

ResourceGroupId

string

Não

O ID do grupo de recursos ao qual a instância pertence.

Nota

rg-acfmyiu4ekp****

AutoPay

boolean

Não

Especifica se o pagamento automático deve ser ativado. O valor é fixo como true.

true

ClientToken

string

Não

O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o valor. Certifique-se de que o token seja exclusivo entre diferentes solicitações. O token diferencia maiúsculas de minúsculas e pode conter até 64 caracteres ASCII.

ETnLKlblzczshOTUbOCz****

StorageType

string

Não

O tipo de armazenamento. Valores válidos: essd_pl1, essd_pl2 e essd_pl3.

Nota

Este parâmetro é obrigatório apenas quando InstanceType é definido como tair_essd e você está criando uma instância baseada em ESSD.

essd_pl1

Storage

integer

Não

A capacidade de armazenamento de uma instância baseada em disco. Os valores válidos variam de acordo com o tipo de instância. Para obter mais informações, consulte Tipos de instâncias baseadas em disco.

Nota

Este parâmetro é obrigatório apenas quando InstanceType é definido como tair_essd e você está criando uma instância baseada em ESSD. Para instâncias SSD baseadas em disco do Tair, a capacidade de armazenamento é um valor fixo determinado pelo tipo de instância. Você não precisa especificar este parâmetro.

60

ShardType

string

Não

O tipo de instância. Valores válidos:

  • MASTER_SLAVE (padrão): alta disponibilidade. A instância usa uma arquitetura primária/secundária para garantir a disponibilidade.

  • STAND_ALONE: réplica única. A instância usa uma arquitetura de nó único. Se o nó falhar, os dados serão perdidos e o sistema criará automaticamente uma nova instância vazia. Este valor é suportado apenas em uma zona única e não suporta arquiteturas de cluster ou de divisão de leitura/gravação.

MASTER_SLAVE

ShardCount

integer

Não

O número de nós de dados na instância. Valores válidos:

Nota

Você pode definir este parâmetro com um valor de 2 a 32 apenas quando InstanceType é definido como tair_rdb ou tair_scm. Apenas instâncias otimizadas para memória e otimizadas para memória persistente suportam a arquitetura de cluster.

2

ReplicaCount

integer

Não

O número de nós de réplica na zona primária. Este parâmetro é aplicável apenas a instâncias de cluster nativas da nuvem com múltiplas réplicas. Você pode usar este parâmetro para personalizar o número de nós de réplica. Valores válidos: 1 a 4.

Nota

Se você criar uma instância multizona, poderá usar este parâmetro em conjunto com o parâmetro SlaveReplicaCount para personalizar o número de nós de réplica nas zonas primária e secundária. A soma deste parâmetro e do parâmetro SlaveReplicaCount não pode exceder 4.

2

SlaveReplicaCount

integer

Não

O número de nós de réplica na zona secundária.

2

ReadOnlyCount

integer

Não

O número de nós de somente leitura na zona primária. Este parâmetro é aplicável apenas a instâncias de divisão de leitura/gravação nativas da nuvem.

  • Para uma instância de arquitetura padrão, os valores válidos são de 1 a 9.

  • Para uma instância de arquitetura de cluster, os valores válidos são de 1 a 4, o que indica o número de nós de somente leitura por shard de dados.

Nota

Se você criar uma instância multizona, poderá usar este parâmetro em conjunto com o parâmetro SlaveReadOnlyCount para personalizar o número de nós de somente leitura nas zonas primária e secundária.

  • Para uma instância de arquitetura padrão, a soma deste parâmetro e do SlaveReadOnlyCount não pode exceder 9.

  • Para uma instância de arquitetura de cluster, a soma deste parâmetro e do SlaveReadOnlyCount não pode exceder 4.

5

SlaveReadOnlyCount

integer

Não

O número de nós de somente leitura na zona secundária.

1

EngineVersion

string

Não

A versão do mecanismo de banco de dados. Valor padrão: 1.0. Os valores válidos variam de acordo com o tipo de produto Tair:

  • Tair_rdb: As instâncias otimizadas para memória do Tair são compatíveis com os protocolos Redis 5.0, Redis 6.0 e Redis 7.0. Defina este parâmetro como 5.0, 6.0 ou 7.0.

  • Tair_scm: As instâncias otimizadas para memória persistente do Tair são compatíveis com o protocolo Redis 6.0. Defina este parâmetro como 1.0.

  • Tair_essd: As instâncias baseadas em disco (ESSD/SSD) do Tair são compatíveis com o protocolo Redis 6.0. Defina este parâmetro como 1.0 para instâncias baseadas em ESSD ou 2.0 para instâncias baseadas em SSD.

1.0

InstanceType

string

Sim

O meio de armazenamento. Valores válidos:

  • tair_rdb: otimizado para memória.

  • tair_scm: otimizado para memória persistente.

  • tair_essd: baseado em disco.

tair_scm

GlobalInstanceId

string

Não

Especifica se a nova instância deve ser adicionada como uma instância filha de uma instância distribuída.

  • Para adicionar a nova instância como a primeira instância filha, defina este parâmetro como true.

  • Para adicionar a nova instância como a segunda ou terceira instância filha, defina este parâmetro como o ID da instância distribuída, como gr-bp14rkqrhac****.

  • Se você não quiser criar uma instância distribuída, deixe este parâmetro vazio.

Nota

Para criar uma instância distribuída, a nova instância deve ser uma instância otimizada para memória do Tair.

gr-bp14rkqrhac****

Tag

array<object>

Não

As tags da instância.

object

Não

As informações da tag.

Key

string

Não

A chave da tag. A chave e o valor juntos formam um par chave-valor para a tag.

Nota

Você pode especificar até 5 pares chave-valor de tags por vez.

key1_test

Value

string

Não

O valor da tag.

Nota

N indica o número de sequência do valor da tag. Por exemplo, Tag.1.Value indica o valor da primeira tag, e Tag.2.Value indica o valor da segunda tag.

value1_test

DryRun

boolean

Não

Especifica se deve ser realizado um dry run para esta solicitação. Valores válidos:

  • true: realiza um dry run sem criar a instância. O sistema verifica itens como os parâmetros da solicitação, o formato da solicitação, os limites do serviço e os recursos disponíveis. Se a verificação falhar, o erro correspondente será retornado. Se a verificação for bem-sucedida, o código de erro DryRunOperation será retornado.

  • false (padrão): envia a solicitação. Após a verificação ser bem-sucedida, a instância é criada.

false

Port

integer

Não

A porta de serviço da instância. Valores válidos: 1 a 65535. Valor padrão: 6379.

6379

GlobalSecurityGroupIds

string

Não

Os modelos globais de lista de permissões de IP para a instância. Separe vários modelos com vírgulas (,). Valores duplicados não são permitidos.

g-zsldxfiwjmti0kcm****

ParamGroupId

string

Não

O ID do modelo de parâmetros. A instância é criada com base nos parâmetros do modelo de parâmetros especificado. Valores duplicados não são permitidos.

g-50npzjcqb1ua6q6j****

RestoreTime

string

Não

Se o flashback de dados estiver ativado para a instância de origem, você poderá especificar um ponto no tempo dentro do período de retenção de backups da instância de origem. O sistema usa os dados de backup da instância de origem no ponto no tempo especificado para criar a instância. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ (UTC).

2021-07-06T07:25:57Z

ConnectionStringPrefix

string

Não

O prefixo do endpoint. O prefixo deve consistir em letras minúsculas e dígitos, começar com uma letra minúscula e ter de 8 a 40 caracteres.

Nota

O endpoint está no seguinte formato: <prefixo-ID da instância>.redis.rds.aliyuncs.com.

r-bp1zxszhcgatnx****

InstanceEndpointType

string

Não

O tipo de endpoint usado ao criar uma instância de divisão de leitura/gravação com implantação em zona dupla nativa da nuvem. Se este parâmetro não for especificado explicitamente, o valor padrão é AzIndependentEndpoint.

  • AzIndependentEndpoint: valor padrão. Endpoints independentes de zona. As zonas primária e secundária fornecem endpoints independentes. Você pode usar diferentes endpoints para obter o acesso mais próximo à zona ativa.

  • UnifiedEndpoint: endpoint unificado. Um endpoint unificado é fornecido para acessar nós nas zonas primária e secundária. No entanto, pode ocorrer acesso entre zonas.

Importante Este parâmetro é aplicável apenas a instâncias de divisão de leitura/gravação com implantação em zona dupla nativas da nuvem. Para outros tipos de instância, apenas endpoints independentes de zona são suportados. Mesmo que você confirme UnifiedEndpoint, a configuração não terá efeito.
Importante O valor UnifiedEndpoint está disponível apenas para usuários na lista de permissões. Se você não estiver na lista de permissões e invocar este valor, a invocação falhará. Para solicitar acesso, abra um ticket.

AzIndependentEndpoint

MaintainStartTime

string

Não

A hora de início da janela de manutenção. Especifique a hora no formato HH:mmZ (UTC). Por exemplo, para definir a hora de início como 01:00 (UTC+8), especifique 17:00Z.

Nota

Se este parâmetro não for especificado, o valor padrão é 18:00Z (UTC), que corresponde a 02:00 (UTC+8).

MaintainEndTime

string

Não

A hora de término da janela de manutenção. Especifique a hora no formato HH:mmZ (UTC). Por exemplo, para definir a hora de término como 02:00 (UTC+8), especifique 18:00Z.

Nota

O intervalo entre a hora de início e a hora de término deve ser de pelo menos 1 hora.

Nota

Se este parâmetro não for especificado, o valor padrão é 22:00Z (UTC), que corresponde a 06:00 (UTC+8).

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

O objeto de resposta.

Bandwidth

integer

A largura de banda máxima da instância. Unidade: MB/s.

96

ChargeType

string

O método de cobrança da instância. Valores válidos:

  • PrePaid: assinatura.

  • PostPaid: pós-pago.

PrePaid

Config

string

As configurações detalhadas da instância. O valor é uma string JSON. Para obter mais informações sobre os parâmetros, consulte Configurações de parâmetros.

{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}

ConnectionDomain

string

O endpoint de rede interna da instância.

r-bp13ac3d047b****.tairpena.rds.aliyuncs.com

Connections

integer

O número máximo de conexões para a instância.

10000

InstanceId

string

O ID da instância.

r-bp13ac3d047b****

InstanceName

string

O nome da instância.

Nota

Este parâmetro é retornado apenas quando o parâmetro de solicitação InstanceName é especificado.

redistest

InstanceStatus

string

O status atual da instância. O valor de retorno é fixo como Creating.

Creating

OrderId

integer

O ID do pedido.

2084452111111

Port

integer

O número da porta da instância.

6379

QPS

integer

O número máximo de operações de leitura e gravação por segundo. Unidade: operações por segundo. Este é o valor teórico para o tipo de instância atual.

100000

RegionId

string

O ID da região.

cn-hangzhou

RequestId

string

O ID da solicitação.

12123216-4B00-4378-BE4B-08005BFC****

TaskId

string

O ID da tarefa.

10****

ZoneId

string

O ID da zona.

cn-hangzhou-h

Exemplos

Resposta de sucesso

JSON formato

{
  "Bandwidth": 96,
  "ChargeType": "PrePaid",
  "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"list-max-ziplist-entries\\\":512,\\\"list-max-ziplist-value\\\":64,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
  "ConnectionDomain": "r-bp13ac3d047b****.tairpena.rds.aliyuncs.com",
  "Connections": 10000,
  "InstanceId": "r-bp13ac3d047b****",
  "InstanceName": "redistest",
  "InstanceStatus": "Creating",
  "OrderId": 2084452111111,
  "Port": 6379,
  "QPS": 100000,
  "RegionId": "cn-hangzhou",
  "RequestId": "12123216-4B00-4378-BE4B-08005BFC****",
  "TaskId": "10****",
  "ZoneId": "cn-hangzhou-h"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 MissingParameter Period is mandatory for this action.
400 InvalidToken.Malformed The Specified parameter Token is not valid.
400 InvalidInstanceName.Malformed The Specified parameter InstanceName is not valid.
400 InvalidPassword.Malformed The Specified parameter Password is not valid.
400 InsufficientBalance Your account does not have enough balance.
400 QuotaExceed.AfterpayInstance Living afterpay instances quota exceeded.
400 InvalidCapacity.NotFound The Capacity provided does not exist in our records.
400 ResourceNotAvailable Resource you requested is not available for finance user.
400 PaymentMethodNotFound No payment method has been registered on the account.
400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. A verificação de idempotência falhou.
400 QuotaNotEnough Quota not enough in this zone.
400 QuotaExceed Living afterpay instances quota exceed.
400 VpcServiceError Invoke vpc service failed.
400 IzNotSupportVpcError Specify iz not support vpc.
400 InvalidvSwitchId The vpc does not cover the vswitch.
400 InvalidIzNo.NotSupported The Specified vpc zone not supported.
400 InvalidAccountPassword.Format Specified account password is not valid.
400 InstanceClass.NotMatch Current instance class and instance type is not match.
400 InvalidVPCId.NotFound Specified virtual vpc is not found. A VPC não foi encontrada. Verifique se o ID da VPC está correto.
400 AccountMoneyValidateError Account money validate error.
400 RequestTokenConflict Specified request token conflict.
400 InvalidIPNotInSubnet Error ip not in subnet.
400 InvalidEngineVersion.Malformed Specified engine version is not valid. A versão do mecanismo DPI é inválida.
400 Zone.Closed The specified zone is closed.
400 VSwithNotBelongToNotVpcFault The vSwitch does not belong to current vpc.
400 PayIllegalAgreement Pay mayi with holding agreement illegal.
400 IllegalParamError validateSaleConditionWithSubArticle failed.
400 CASH_BOOK_INSUFFICIENT No payment method is specified for your account. We recommend that you add a payment method or maitain a minimum prepayment balance of INR 1000.
400 InvalidRegion.Format Specified Region is not valid. A região especificada é inválida.
403 RealNameAuthenticationError Your account has not passed the real-name authentication yet.
403 AuthorizationFailure The request processing has failed due to authorization failure.
403 TokenServiceError The specified token is duplicated, please change it.
403 UserCannotBuyNotInnerCommodity The user can not buy this commodity without alibaba group tag.
404 InvalidCapacity.NotFound The Capacity provided does not exist in our records. A especificação de armazenamento especificada não existe.
404 InvalidvSwitchId The Specified vSwitchId zone not supported.
404 InvalidVpcIdOrVswitchId.NotSupported The Specified vpcId or vSwitchId not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.