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

Consulta os parâmetros de configuração e os parâmetros de execução de uma instância Tair (compatível com Redis® OSS).

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

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

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.	cn-hangzhou
DBInstanceId	string	Sim	O ID da instância.	r-bp1zxszhcgatnx****
NodeId	string	Não	O ID do nó. Nota Especifique este parâmetro para consultar as configurações de parâmetros de um nó específico em uma instância de cluster.	r-bp1xxxxxxxxxxxxx-db-0

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
RequestId	string	O ID da solicitação.	9C1338BE-8DE8-4890-A900-E1BC06BF****
Engine	string	O tipo de banco de dados.	redis
EngineVersion	string	A versão do mecanismo de banco de dados.	4.0
ConfigParameters	object
Parameter	array<object>	A lista de parâmetros de configuração que ainda não entraram em vigor.
	object	O objeto.
CheckingCode	string	The check code that indicates the valid values of the parameter.	[0\|1]
ParameterName	string	The parameter name.	script_check_enable
ParameterValue	string	The parameter value.	1
ForceRestart	boolean	Indicates whether a restart is required for the parameter to take effect. Valid values: True: A restart is required. False: No restart is required. The parameter takes effect immediately after it is submitted.	true
ParameterDescription	string	The description of the parameter.	Check all keys passed in the KEYS array map to the same slot.
ModifiableStatus	boolean	Indicates whether the parameter can be modified. Valid values: False: The parameter cannot be modified. True: The parameter can be modified.	true
RunningParameters	object
Parameter	array<object>	A lista de parâmetros de execução.
	object	O objeto.
CheckingCode	string	The valid values of the parameter.	[0\|1]
ParameterName	string	The parameter name.	#no_loose_disabled-commands
ParameterValue	string	The parameter value.	keys,flushall,flushdb
ForceRestart	string	Indicates whether a restart is required for the parameter to take effect. Valid values: True: A restart is required. False: No restart is required. The parameter takes effect immediately after it is submitted.	true
ParameterDescription	string	The description of the parameter.	You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].
ModifiableStatus	string	Indicates whether the parameter can be modified. Valid values: False: The parameter cannot be modified. True: The parameter can be modified.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF****",
  "Engine": "redis",
  "EngineVersion": "4.0",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "script_check_enable",
        "ParameterValue": "1",
        "ForceRestart": true,
        "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
        "ModifiableStatus": true
      }
    ]
  },
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "#no_loose_disabled-commands",
        "ParameterValue": "keys,flushall,flushdb",
        "ForceRestart": "true",
        "ParameterDescription": "You can disable some dangerous commands, for example \\\"keys,flushdb,flushall\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
        "ModifiableStatus": "true"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.