ModifyInstanceSpec - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Altera as especificações de uma instância de banco de dados ApsaraDB for Tair (Redis® OSS-Compatible).

Descrição da operação

Nota

Para obter informações sobre o processo de execução, impactos, limites de recursos e cobrança de alterações de especificações, consulte Alterar configurações da instância.

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:ModifyInstanceSpec

update

*DBInstance.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	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 da instância cujas especificações você deseja alterar.	cn-hangzhou
InstanceId	string	Sim	O ID da instância. Você pode chamar DescribeInstances para consultar o ID da instância.	r-bp1zxszhcgatnx****
InstanceClass	string	Não	O novo tipo de instância. Você pode chamar DescribeAvailableResource para consultar os tipos de instância disponíveis para alteração de especificações na zona onde a instância reside. Nota Para obter mais informações sobre tipos de instância, consulte Navegação de tipos de instância.	redis.master.small.default
BusinessInfo	string	Não	O ID da atividade e as informações comerciais.	000000001
CouponNo	string	Não	O código do cupom. Valor padrão: `youhuiquan_promotion_option_id_for_blank`.	youhuiquan_promotion_option_id_for_blank
ForceUpgrade	boolean	Não	Especifica se as especificações devem ser alteradas forçadamente. Valores válidos: false: não altera forçadamente as especificações. true: altera forçadamente as especificações. Este é o valor padrão.	true
EffectiveTime	string	Não	O momento em que a alteração de especificações entra em vigor. Valores válidos: Immediately: A alteração de especificações entra em vigor imediatamente. Este é o valor padrão. MaintainTime: A alteração de especificações entra em vigor durante a janela de manutenção da instância. Você pode chamar ModifyInstanceMaintainTime para modificar a janela de manutenção.	Immediately
AutoPay	boolean	Não	Especifica se o pagamento automático deve ser ativado. Valores válidos: true: O pagamento automático está ativado. Este é o valor padrão. false: O pagamento automático está desativado. Se você definir este parâmetro como false, deverá renovar manualmente a instância antes que ela expire no console. Para obter detalhes, consulte Renovação manual.	true
OrderType	string	Não	O tipo de alteração de especificações. Este parâmetro é obrigatório quando você altera as especificações de uma instância por assinatura. Valores válidos: UPGRADE: Upgrade. Este é o valor padrão. DOWNGRADE: Downgrade. Nota Você deve definir este parâmetro como DOWNGRADE ao fazer downgrade de uma instância por assinatura. Se o preço do tipo de instância de destino for superior ao do tipo de instância atual, a alteração será um upgrade. Caso contrário, a alteração será um downgrade. Por exemplo, o preço da edição de divisão de leitura/gravação de 8 GB (5 nós somente leitura) é superior ao da edição cluster de 16 GB. Alterar desta última para a primeira é um upgrade. Valores válidos: DOWNGRADE : DOWNGRADE. UPGRADE : UPGRADE.	DOWNGRADE
MajorVersion	string	Não	A versão principal do mecanismo para upgrade de uma instância clássica. Valores válidos: 2.8, 4.0 e 5.0. Nota Ao fazer upgrade da versão, o parâmetro InstanceClass é obrigatório. Isso indica que esta operação suporta upgrades de versão apenas quando as especificações da instância também são alteradas. Para fazer upgrade apenas da versão da instância, chame ModifyInstanceMajorVersion.	5.0
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 token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	ETnLKlblzczshOTUbOCz****
SourceBiz	string	Não	A origem da solicitação. Este parâmetro é usado apenas para manutenção interna e não precisa ser especificado.	SDK
ShardCount	integer	Não	O número de shards. Este parâmetro é aplicável apenas a instâncias cluster nativas da nuvem. Você pode usar este parâmetro para especificar um número personalizado de shards. Nota Para alterar uma instância cluster nativa da nuvem para uma arquitetura padrão, defina ShardCount como 1 e defina o tipo de instância como um tipo de instância padrão. Para alterar uma instância padrão nativa da nuvem para uma arquitetura cluster, defina ShardCount como um valor maior que 1 e defina o tipo de instância como um tipo de instância cluster.	8
ReplicaCount	integer	Não	O número de nós réplica na zona primária. Este parâmetro é aplicável apenas a instâncias cluster nativas da nuvem com múltiplas réplicas. Você pode usar este parâmetro para especificar um número personalizado de nós réplica. Valores válidos: 1 a 4. Nota Para instâncias multizona, você pode usar este parâmetro junto com o parâmetro SlaveReplicaCount para especificar o número de nós réplica nas zonas primária e secundária. A soma deste parâmetro com o parâmetro SlaveReplicaCount não pode exceder 4.	1
SlaveReplicaCount	integer	Não	O número de nós réplica na zona secundária.	1
ReadOnlyCount	integer	Não	O número de nós 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 instâncias de arquitetura padrão, os valores válidos são 0 a 9. Um valor de 0 indica que a divisão de leitura/gravação está desativada e a instância é alternada para a arquitetura padrão. Para instâncias de arquitetura cluster, os valores válidos são 1 a 4, o que especifica o número de nós somente leitura por shard de dados. Nota Para instâncias multizona, você pode usar este parâmetro junto com o parâmetro SlaveReadOnlyCount para especificar o número de nós somente leitura nas zonas primária e secundária. Para instâncias de arquitetura padrão, a soma deste parâmetro com SlaveReadOnlyCount não pode exceder 9. Para instâncias de arquitetura cluster, a soma deste parâmetro com SlaveReadOnlyCount não pode exceder 4.	5
SlaveReadOnlyCount	integer	Não	O número de nós somente leitura na zona secundária.	2
ForceTrans	boolean	Não	Especifica se a transmissão forçada deve ser ativada. Valores válidos: false (padrão): Antes da alteração de especificações, o sistema verifica a versão secundária atual do mecanismo da instância. Se a versão secundária do mecanismo for muito antiga, um erro será retornado. Você deve fazer upgrade da versão secundária do mecanismo e tentar novamente. true: Ignora a verificação e executa diretamente a operação de alteração de especificações.	false
NodeType	string	Não	O tipo de nó. Valores válidos: MASTER_SLAVE: alta disponibilidade (réplica dupla) STAND_ALONE: réplica única double: réplica dupla single: réplica única Nota Para instâncias nativas da nuvem, selecione MASTER_SLAVE ou STAND_ALONE. Para instâncias clássicas, selecione double ou single.	MASTER_SLAVE
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 está definido como tair_essd e a instância é uma instância de disco em nuvem baseada em Tair ESSD.	essd_pl1
Storage	integer	Não	A capacidade de armazenamento de uma instância de disco em nuvem. Os valores válidos variam de acordo com o tipo de instância. Para obter mais informações, consulte Tipos de instância baseados em disco em nuvem. Nota Este parâmetro é obrigatório apenas quando InstanceType está definido como tair_essd e você está criando uma instância de disco em nuvem baseada em Tair ESSD. Para instâncias de disco em nuvem baseadas em Tair SSD, a capacidade de armazenamento é um valor fixo baseado no tipo de instância, e você não precisa especificar este parâmetro.	60
SecondaryZoneId	string	Não	O ID da zona secundária. Este parâmetro é obrigatório quando você altera as especificações de uma instância de zona única e a migra para uma implantação multizona. Você pode chamar DescribeZones para consultar as zonas disponíveis. Nota O valor deste parâmetro deve ser diferente do valor do parâmetro ZoneId. Não defina este parâmetro como o ID de uma multizona.	cn-hangzhou-h

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
OrderId	string	O ID do pedido.	20722623431****
RequestId	string	O ID da solicitação.	0DA1D7EF-C80D-432C-8758-7D225182626B

Exemplos

Resposta de sucesso

JSON formato

{
  "OrderId": "20722623431****",
  "RequestId": "0DA1D7EF-C80D-432C-8758-7D225182626B"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	PaymentMethodNotFound	No payment method has been registered on the account.
400	HasRenewChangeOrder	This instance has a renewChange order.
400	%s	Warn: {%s} are not supported after upgraded. you can set forceUpgrade=true to force upgrade.
400	GdcInstanceNotSupport	The gdc custins trans not support.
400	AbnormalResourceStatusForRenew	Abnormal resource status for renew.
400	MissingRedisShardingUnsupportPerfItem	The metadb is missing redis sharding unsupoort command perf item.
400	IllegalParamError	Action or resource must not be null.
400	IncorrectTargetMajorVersion	Current target majorversion does not support this operation.
400	IncorrectMinorVersion	Current engine minor version does not support operations.
400	DirectTargetLevelNotSupport	The direct custins tranfer target instance level does not support.
400	DirectTransPreCheckError	The direct custins trans pre check IsAddReduceNodes error.
400	DtsOpendNotSupportTrans	The custins DtsSyncStatus opend does not support trans.
400	DirectTransNodeDoubleLevelError	The direct custins tranfer node double target level error.
400	DirectTransUpgradeMajorVersionNotSupport	The direct custins tranfer does not support upgrade major version.
403	TargetMemoryLessThanCurrentUsed	The target instance memory size below the current instance used memory.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.