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

Ajusta a largura de banda de uma instância do ApsaraDB Tair (compatível com Redis® OSS). Atualmente, apenas o método de faturamento pay-as-you-go é suportado. Você precisa especificar apenas os parâmetros InstanceId, NodeId (opcional), Bandwidth e ChargeType.

Descrição da operação

Se você ativar o recurso de dimensionamento elástico para a instância ao chamar esta operação, a instância usará preferencialmente o recurso de dimensionamento elástico. Quando a largura de banda é reduzida elasticamente, ela é reduzida para a largura de banda padrão das especificações da instância. Para obter mais informações sobre os limites, faturamento e perguntas frequentes deste recurso, consulte Ajustar a largura de banda de uma instância.

Nota

Antes de chamar esta operação, você pode chamar DescribeRoleZoneInfo para consultar a largura de banda atual de cada nó de dados na 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:EnableAdditionalBandwidth

update

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância. Você pode chamar DescribeInstances para obter o ID da instância.	r-bp1zxszhcgatnx****
CouponNo	string	Não	O ID do cupom.	youhuiquan_promotion_option_id_for_blank
AutoPay	boolean	Não	Especifica se o pagamento automático deve ser ativado. Valores válidos: true: ativa o pagamento automático. Este é o valor padrão. Certifique-se de que sua conta tenha saldo suficiente. false: desativa o pagamento automático. Você deve concluir o pagamento manualmente.	true
NodeId	string	Não	O ID do fragmento de dados. Você pode chamar DescribeLogicInstanceTopology para obter o ID do fragmento. Separe vários IDs de fragmentos com vírgulas (,). Você também pode definir este parâmetro como All para especificar todos os fragmentos de dados. Nota Este parâmetro está disponível e é obrigatório apenas quando a instância usa a arquitetura de cluster ou a arquitetura de divisão de leitura/gravação.	r-bp1zxszhcgatnx****-db-0
Bandwidth	string	Não	A largura de banda a ser aumentada, em MB/s. O valor deve ser um número inteiro maior ou igual a 0. O valor máximo é seis vezes a largura de banda padrão das especificações da instância (ou de um único fragmento), mas o limite superior do aumento é de 192 MB/s. Por exemplo, se a largura de banda padrão da instância for 10 MB/s, o intervalo de valores será de 0 a 60. Nota Você pode chamar a operação DescribeRoleZoneInfo e usar o parâmetro de resposta DefaultBandWidth para obter a largura de banda máxima padrão. Para obter mais informações sobre as especificações da instância, consulte Visão geral das especificações da instância. Se vários IDs de fragmentos de dados forem especificados no parâmetro de solicitação NodeId, os valores de largura de banda especificados neste parâmetro devem corresponder à ordem dos IDs dos fragmentos. Separe vários valores de largura de banda com vírgulas (,).	20
OrderTimeLength	string	Não	A duração da assinatura, em dias. Valores válidos: 1, 2, 3, 7, 14, 30, 60, 90, 180, 365, 730, 1095 e 1825. Nota Para continuar usando a largura de banda adquirida, você deve chamar a operação RenewAdditionalBandwidth para renovar a largura de banda antes que ela expire.	30
SourceBiz	string	Não	A origem da chamada. Este parâmetro é usado apenas para manutenção interna e não precisa ser especificado.	SDK
AutoRenew	boolean	Não	Especifica se a renovação automática deve ser ativada. Valores válidos: true: ativa a renovação automática. false: desativa a renovação automática. Este é o valor padrão.	false
AutoRenewPeriod	integer	Não	O período de renovação automática, em meses. Valores válidos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36 e 60. Nota Este parâmetro está disponível e é obrigatório apenas quando o parâmetro AutoRenew é definido como true. Depois que este parâmetro é configurado, ele não pode ser consultado chamando operações de API. Para consultar o período de renovação automática, escolha Faturamento > Gerenciamento de renovação na barra de navegação superior do console e, em seguida, insira o ID da instância com o sufixo `-bw` (por exemplo, r-bp1zxszhcgatnx**-bw) na caixa de texto ID da instância**.	1
ChargeType	string	Não	O método de faturamento para a largura de banda adicional. Valores válidos: PrePaid: assinatura. PostPaid: pay-as-you-go. Atualmente, apenas este método de faturamento é suportado. Valores válidos: PostPaid : Pay-as-you-go. PrePaid : Assinatura.	PrePaid
BandWidthBurst	boolean	Não	Especifica se a largura de banda elástica com capacidade de burst (nível de segundo) deve ser ativada. Depois que o dimensionamento elástico para largura de banda é ativado, a largura de banda elástica com capacidade de burst (nível de segundo) não pode ser ativada, e vice-versa.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
OrderId	string	O ID do pedido.	2084452111111
RequestId	string	O ID da solicitação.	D622714-AEDD-4609-9167-F5DDD3D1****

Exemplos

Resposta de sucesso

JSON formato

{
  "OrderId": "2084452111111",
  "RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.