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

Consulta os parâmetros e valores padrão de instâncias de banco de dados ApsaraDB Tair (Redis® OSS-Compatible) em diferentes arquiteturas e versões principais do mecanismo.

Descrição da operação

Após chamar esta operação para obter a lista de parâmetros e valores padrão, você pode chamar a operação ModifyInstanceConfig para modificar os parâmetros de uma instância Redis conforme necessário.

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

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CharacterType	string	Sim	A arquitetura da instância. Para mais informações, consulte Visão geral da arquitetura. Valores válidos:\n* logic: arquitetura de cluster ou de divisão de leitura/gravação\n* normal: arquitetura padrão (primária/secundária)\n\n Valores válidos: normal : Arquitetura padrão primária/secundária. logic : Arquitetura de cluster ou de divisão de leitura/gravação.	logic
Engine	string	Sim	O mecanismo de banco de dados. Defina o valor como Redis.	Redis
EngineVersion	string	Sim	A versão principal do mecanismo da instância. Valores válidos: 4.0, 5.0, 6.0 e 7.0.	5.0
ResourceGroupId	string	Não	O ID do grupo de recursos. Você pode invocar a operação ListResourceGroups para consultar o ID do grupo de recursos.\n> Você também pode obter o ID do grupo de recursos no console. Para operações relacionadas, consulte Visualizar as informações básicas de um grupo de recursos.	rg-acfmyiu4ekp****
InstanceId	string	Não	O ID da instância. Você pode chamar a operação DescribeInstances para consultar o ID da instância.	r-bp1zxszhcgatnx****
ParameterCategory	string	Não	Especifica se o modelo de parâmetro da conta deve ser consultado. Defina o valor como account. Valores válidos: account : Modelo de parâmetro da conta.	account

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	9DA28D8E-514D-4F12-ADED-70A9C818****
Engine	string	O mecanismo de banco de dados. O valor é sempre Redis.	redis
EngineVersion	string	A versão principal do mecanismo da instância.	5.0
ParameterCount	string	O número de parâmetros.	24
Parameters	object
TemplateRecord	array<object>	A lista de informações detalhadas dos parâmetros.
	object
CheckingCode	string	Os valores válidos do parâmetro.	[yes\|no]
ParameterName	string	O nome do parâmetro. Para mais informações sobre a finalidade e as configurações do parâmetro, consulte descrição da métrica.	appendonly
ParameterValue	string	O valor padrão do parâmetro.	yes
ForceModify	boolean	Indica se o parâmetro pode ser modificado. Valores válidos:\n* true: O parâmetro pode ser modificado.\n* false: O parâmetro não pode ser modificado.	true
ForceRestart	boolean	Indica se uma reinicialização é necessária para que a modificação do parâmetro entre em vigor. Valores válidos:\n* true: Uma reinicialização é necessária para que a modificação entre em vigor.\n* false: A modificação entra em vigor imediatamente sem reinicialização.	true
ParameterDescription	string	A descrição do parâmetro.	Enable AOF persistence mode

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
  "Engine": "redis",
  "EngineVersion": "5.0",
  "ParameterCount": "24",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[yes|no]",
        "ParameterName": "appendonly",
        "ParameterValue": "yes",
        "ForceModify": true,
        "ForceRestart": true,
        "ParameterDescription": "Enables the AOF persistence mode"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameters.Format	Specified parameters is not valid.	O parâmetro é inválido.
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.