Cria uma instância de arquitetura clássica do Redis de código aberto, uma instância de arquitetura cloud-native do Redis de código aberto ou uma instância de arquitetura clássica do Tair com otimização de memória. Para criar uma instância cloud-native do Tair, chame a operação CreateTairInstance.
Descrição da operação
Antes de invocar esta operação, certifique-se de compreender totalmente os métodos de cobrança e os preços do banco de dados ApsaraDB for Tair (compatível com Redis OSS).
Esta operação cria instâncias do Redis de código aberto e instâncias clássicas do Tair com otimização de memória. Para criar uma instância cloud-native do Tair, invoque a operação CreateTairInstance.
Para obter informações sobre como criar uma instância no console e selecionar um tipo de instância, consulte Criar uma instância Redis.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
kvstore:CreateInstance |
create |
*DBInstance
|
|
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 a operação DescribeRegions para consultar as regiões disponíveis. Defina este parâmetro para a região onde deseja criar a instância. |
cn-hangzhou |
| Token |
string |
Não |
O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token diferencia maiúsculas de minúsculas e pode ter até 64 caracteres ASCII. |
ETnLKlblzczshOTUbOCz**** |
| InstanceName |
string |
Não |
O nome da instância. O nome deve ter de 2 a 80 caracteres e começar com uma letra ou um caractere chinês. Não pode conter espaços ou os seguintes caracteres especiais: @/:=”<>{[]}. |
apitest |
| Password |
string |
Não |
A senha da instância. A senha deve ter de 8 a 32 caracteres e conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Os caracteres especiais permitidos incluem !@#$%^&*()_+-=. |
Pass!123456 |
| Capacity |
integer |
Não |
A capacidade de armazenamento da instância. Unidade: MB. Nota
Você deve especificar pelo menos um dos parâmetros Capacity e InstanceClass ao chamar esta operação. |
16384 |
| InstanceClass |
string |
Não |
O tipo de instância. Por exemplo, redis.master.small.default indica uma instância master-replica padrão de 1 GB da Community Edition (arquitetura clássica). Para mais informações, consulte Visão geral dos tipos de instância. Nota
Você deve especificar pelo menos um dos parâmetros Capacity e InstanceClass ao chamar esta operação. |
redis.master.small.default |
| ZoneId |
string |
Não |
O ID da zona ativa primária. Você pode chamar a operação DescribeRegions para consultar a lista de zonas mais recente. Você pode usar este parâmetro para especificar a zona onde deseja criar a instância. Nota
Você também pode especificar o parâmetro SecondaryZoneId para definir a zona secundária. A implantação dos nós primário e secundário nas zonas primária e secundária especificadas implementa uma arquitetura primária/secundária de dois data centers. Por exemplo, você pode definir 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 a operação DescribeZones para consultar a lista de zonas mais recente. Nota
O valor deste parâmetro não pode ser igual ao valor do parâmetro ZoneId e não pode ser o ID de uma implantação multizona. |
cn-hangzhou-g |
| ChargeType |
string |
Não |
O método de cobrança. Valores válidos:
|
PostPaid |
| NodeType |
string |
Não |
O tipo de nó. Valores válidos:
Nota
Para instâncias cloud-native, selecione MASTER_SLAVE ou STAND_ALONE. Para instâncias clássicas, selecione double ou single. |
STAND_ALONE |
| NetworkType |
string |
Não |
O tipo de rede. Valores válidos:
|
VPC |
| VpcId |
string |
Não |
O ID da VPC. |
vpc-bp1nme44gek34slfc**** |
| VSwitchId |
string |
Não |
O ID do vSwitch. |
vsw-bp1e7clcw529l773d**** |
| Period |
string |
Não |
O período de assinatura. Unidade: meses. Valores válidos: 1 a 9, 12, 24, 36 e 60. Nota
Este parâmetro é válido e obrigatório apenas quando o parâmetro ChargeType está definido como PrePaid. |
12 |
| BusinessInfo |
string |
Não |
O ID da atividade e as informações comerciais. |
000000000 |
| CouponNo |
string |
Não |
O código do cupom. Valor padrão: default. |
youhuiquan_promotion_option_id_for_blank |
| SrcDBInstanceId |
string |
Não |
O ID da instância de origem. Se você deseja criar uma nova instância com base em um conjunto de backups de uma instância de origem, especifique o ID da instância de origem. Você pode especificar um único ID ou uma matriz de IDs. Nota
Em seguida, especifique o conjunto de backups ou o ponto no tempo usando o parâmetro BackupId, ClusterBackupId (recomendado para arquitetura de cluster cloud-native) ou RestoreTime. Este parâmetro deve ser usado em combinação 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 no conjunto de backups para criar a nova instância. Você pode invocar a operação DescribeBackups para consultar o ID do conjunto de backups. Se a instância de origem for uma instância de cluster, você deve inserir os IDs dos conjuntos de backups de todos os shards na instância de origem e separá-los por vírgulas, como "10**,11**,15**". Nota
Se a sua instância for uma instância de cluster de arquitetura cloud-native, recomendamos que você invoque a operação DescribeClusterBackupList para consultar 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. Isso poupa o trabalho de inserir o ID do conjunto de backups de cada shard. |
111111111 |
| InstanceType |
string |
Não |
O tipo de instância. Valores válidos:
|
Redis |
| EngineVersion |
string |
Não |
A versão do mecanismo da instância clássica do Redis. Valores válidos:
A versão do mecanismo da instância cloud-native do Redis. Valores válidos:
Nota
Valor padrão: 5.0. Valores válidos:
|
5.0 |
| PrivateIpAddress |
string |
Não |
O endereço IP de rede interna da nova instância. Nota
O endereço IP de rede interna deve estar dentro do bloco CIDR do vSwitch ao qual a instância pertence. |
172.16.0.*** |
| AutoUseCoupon |
string |
Não |
Especifica se deve ser usado um voucher. Valores válidos:
|
false |
| AutoRenew |
string |
Não |
Especifica se a renovação automática deve ser ativada. Valores válidos:
|
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 apenas quando o parâmetro AutoRenew está definido como true. |
3 |
| ResourceGroupId |
string |
Não |
O ID do grupo de recursos. |
rg-resourcegroupid1 |
| RestoreTime |
string |
Não |
O ponto no tempo para o qual você deseja restaurar a instância de origem. Se o recurso de 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 nova instância. Especifique a hora no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. |
2019-06-19T16:00:00Z |
| DedicatedHostGroupId |
string |
Não |
O ID do cluster dedicado. Este parâmetro é obrigatório quando você cria uma instância em um cluster dedicado. |
dhg-uv4fnk6r7zff**** |
| ShardCount |
integer |
Não |
O número de shards. Este parâmetro se aplica apenas a instâncias cloud-native. Você pode usar este parâmetro para personalizar o número de shards.
|
4 |
| ReplicaCount |
integer |
Não |
O número de nós secundários na zona primária. Este parâmetro se aplica apenas a instâncias de cluster cloud-native com múltiplas réplicas. Você pode usar este parâmetro para personalizar o número de nós secundários. Valores válidos: 1 a 4. Nota
Se você criar uma instância multizona, poderá usar este parâmetro e o parâmetro SlaveReplicaCount para personalizar o número de nós secundários 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 secundários na zona secundária. |
2 |
| ReadOnlyCount |
integer |
Não |
O número de nós somente leitura na zona primária. Este parâmetro se aplica apenas a instâncias de divisão de leitura e gravação cloud-native.
Nota
Se você criar uma instância multizona, poderá usar este parâmetro e o parâmetro SlaveReadOnlyCount para personalizar o número de nós somente leitura nas zonas primária e secundária.
|
2 |
| SlaveReadOnlyCount |
integer |
Não |
O número de nós somente leitura na zona secundária. |
2 |
| GlobalInstanceId |
string |
Não |
O ID da instância distribuída. Este parâmetro se aplica apenas ao site da China. |
gr-bp14rkqrhac**** |
| GlobalInstance |
boolean |
Não |
Especifica se a nova instância deve ser usada como a primeira instância filha de uma instância distribuída. Você pode criar uma instância distribuída dessa maneira. Valores válidos:
Nota
|
false |
| Port |
string |
Não |
A porta de serviço da instância. Valores válidos: 1 a 65535. Valor padrão: 6379. |
6379 |
| DryRun |
boolean |
Não |
Especifica se deve ser realizado um dry run antes de criar a instância. Valores válidos:
|
false |
| GlobalSecurityGroupIds |
string |
Não |
Os modelos globais de lista de permissões de endereços IP da instância. Separe vários modelos com vírgulas (,). Duplicatas não são permitidas. Importante Este parâmetro se aplica apenas a instâncias cloud-native. Instâncias clássicas não suportam o recurso de modelo de lista de permissões. |
g-zsldxfiwjmti0kcm**** |
| Appendonly |
string |
Não |
As configurações do parâmetro Append Only File (AOF) da nova instância. Valores válidos:
Nota
Este parâmetro se aplica a instâncias clássicas. Instâncias cloud-native não suportam a especificação do parâmetro AOF. Valores válidos:
|
yes |
| ConnectionStringPrefix |
string |
Não |
O prefixo do endpoint. O prefixo deve ter de 8 a 40 caracteres e pode conter letras minúsculas e dígitos. Deve começar com uma letra minúscula. Nota
O formato do endpoint é: |
r-bp1zxszhcgatnx**** |
| ParamGroupId |
string |
Não |
O ID do modelo de parâmetro, que é globalmente exclusivo. Importante Este parâmetro é suportado apenas por instâncias cloud-native. |
rpg-test** |
| Tag |
array<object> |
Não |
As informações de tag da instância. |
|
|
object |
Não |
A tag. |
||
| Key |
string |
Não |
A chave da tag. Nota
|
testkey |
| 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. |
testvalue |
| ClusterBackupId |
string |
Não |
O ID do conjunto de backups do cluster. Algumas novas arquiteturas de cluster suportam este parâmetro. Você pode chamar a operação DescribeClusterBackupList para obter o ID.
|
cb-hyxdof5x9kqb**** |
| RecoverConfigMode |
string |
Não |
Especifica se as informações de conta, parâmetros de kernel e lista de permissões devem ser restauradas do conjunto de backups original ao criar uma instância usando um conjunto de backups especificado. Por exemplo, para restaurar as informações da conta, defina o valor como account. Valor padrão: vazio, o que indica que as informações de conta, parâmetros de kernel e lista de permissões não são restauradas do conjunto de backups original. Nota
Este parâmetro se aplica apenas a instâncias cloud-native e requer que as informações de conta, parâmetros de kernel e lista de permissões estejam salvas no conjunto de backups original. Você pode chamar a operação DescribeBackups para consultar se o parâmetro RecoverConfigMode de um conjunto de backups especificado contém as informações anteriores. |
whitelist,config,account |
| InstanceEndpointType |
string |
Não |
O tipo de endpoint usado ao criar uma instância de divisão de leitura e gravação cloud-native de zona dupla ativa. Se este parâmetro não for especificado explicitamente, o valor padrão é AzIndependentEndpoint.
Importante Este parâmetro se aplica apenas a instâncias de divisão de leitura e gravação cloud-native de zona dupla ativa. Para outros tipos de instâncias, apenas endpoints independentes de zona são suportados. Mesmo que você especifique UnifiedEndpoint, isso não terá efeito. Importante O parâmetro UnifiedEndpoint está atualmente disponível apenas para usuários na lista de permissões. Se um usuário fora da lista de permissões especificar este parâmetro, um erro será retornado. Para solicitar as permissões, abra um ticket. |
AzIndependentEndpoint |
| MaintainStartTime |
string |
Não |
Configurações para a hora de início da janela de manutenção da instância. Especifique a hora no formato HH:mmZ. A hora deve estar em UTC. Por exemplo, se você deseja que a janela de manutenção comece às 01:00 UTC+8, defina o valor como 17:00Z. Nota
Se você não especificar este parâmetro, o valor padrão é 02:00 UTC+8, que corresponde a 18:00 UTC. |
03:00Z |
| MaintainEndTime |
string |
Não |
Configurações para a hora de término da janela de manutenção da instância. Especifique a hora no formato HH:mmZ. A hora deve estar em UTC. Por exemplo, se você deseja que a janela de manutenção termine às 02:00 UTC+8, defina o valor como 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 você não especificar este parâmetro, o valor padrão é 06:00 UTC+8, que corresponde a 22:00 UTC. |
07:00Z |
A seguir está um exemplo de solicitação para criar uma instância de cluster do Redis 7.0.
{
"RegionId": "cn-shenzhen",
"InstanceName": "apitest",
"Password": "D****23",
"ZoneId": "cn-shenzhen-f",
"ChargeType": "PrePaid",
"InstanceClass": "redis.shard.with.proxy.small.ce",
"NetworkType": "VPC",
"Period": "1",
"InstanceType": "Redis",
"EngineVersion": "7.0",
"ShardCount": 4,
"SourceIp": "10.10.10.10"
}
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O objeto. |
||
| Bandwidth |
integer |
O limite de largura de banda da instância. Unidade: MB/s. |
32 |
| Capacity |
integer |
A capacidade de armazenamento da instância. Unidade: MB. |
16384 |
| ChargeType |
string |
O método de cobrança. Valores válidos:
|
PostPaid |
| Config |
string |
As configurações detalhadas da instância. |
{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64} |
| ConnectionDomain |
string |
O endpoint de conexão de rede interna da instância Redis. |
r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
| Connections |
integer |
O número máximo de conexões com a instância. |
10000 |
| EndTime |
string |
A hora em que a instância pré-paga expira. Especifique a hora no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. |
2019-01-18T16:00:00Z |
| InstanceId |
string |
O ID da instância, que é globalmente exclusivo. |
r-bp1zxszhcgatnx**** |
| InstanceName |
string |
O nome da instância. |
apitest |
| InstanceStatus |
string |
O status atual da instância. O valor de retorno é fixo como Creating. |
Creating |
| NetworkType |
string |
O tipo de rede. Valores válidos:
|
VPC |
| NodeType |
string |
O tipo de nó. Valores válidos:
|
MASTER_SLAVE |
| OrderId |
integer |
O ID do pedido. |
2084452111111 |
| Port |
integer |
A porta de serviço do Redis. |
6379 |
| PrivateIpAddr |
string |
O endereço IP interno da instância. |
172.16.0.10 |
| QPS |
integer |
As consultas por segundo (QPS). Este é o valor teórico para o tipo de instância atual. |
100000 |
| RegionId |
string |
A região onde a instância reside. |
cn-hongkong |
| RequestId |
string |
O ID da solicitação. |
5DEA3CC9-F81D-4387-8E97-CEA40F09**** |
| UserName |
string |
O nome de usuário usado para conectar ao Redis. Por padrão, uma conta com o nome do ID da instância é incluída. |
r-bp1zxszhcgatnx**** |
| VSwitchId |
string |
O ID do vSwitch. |
vsw-bp1e7clcw529l773d**** |
| VpcId |
string |
O ID da VPC. |
vpc-bp1nme44gek34slfc**** |
| ZoneId |
string |
O ID da zona da instância. |
cn-hangzhou-b |
Exemplos
Resposta de sucesso
JSON formato
{
"Bandwidth": 32,
"Capacity": 16384,
"ChargeType": "PostPaid",
"Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
"ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
"Connections": 10000,
"EndTime": "2019-01-18T16:00:00Z",
"InstanceId": "r-bp1zxszhcgatnx****",
"InstanceName": "apitest",
"InstanceStatus": "Creating",
"NetworkType": "VPC",
"NodeType": "MASTER_SLAVE",
"OrderId": 2084452111111,
"Port": 6379,
"PrivateIpAddr": "172.16.0.10",
"QPS": 100000,
"RegionId": "cn-hongkong",
"RequestId": "5DEA3CC9-F81D-4387-8E97-CEA40F09****",
"UserName": "r-bp1zxszhcgatnx****",
"VSwitchId": "vsw-bp1e7clcw529l773d****",
"VpcId": "vpc-bp1nme44gek34slfc****",
"ZoneId": "cn-hangzhou-b"
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | ZoneIdNotFound | Specify iz not support switch network. | A zona correspondente não foi encontrada. |
| 400 | InvalidShardInfo.Format | Shard total number is out of range. | |
| 400 | InvalidInstancelevel | Specified Instance level dose not match gdc other member instance level. | |
| 400 | InvalidBackupLogStatus | Backup logs are not enabled for the specified source instance. | |
| 400 | InvalidStatus | Specified instance status is Modifying. | O status da instância especificado é Upgrade/Downgrade em andamento. |
| 400 | SecurityRisk.AuthVerification | we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton. | |
| 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. |
| 400 | DryRunOperation | Request validation has been passed with DryRun flag set. | A solicitação realizou um dry run e passou na verificação. Nenhuma instância é criada. |
| 400 | ResourceGroupNotExist | The Specified ResourceGroupId does not exist. | |
| 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. | |
| 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.