DescribeParameters - PolarDB: Central de Documentação do Alibaba Cloud

Consulta os parâmetros de uma 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

polardbx:DescribeParameters

none

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância.	cn-hangzhou
DBInstanceId	string	Sim	O ID da instância.	pxc-********
ParamLevel	string	Não	O nível do parâmetro. Valores válidos:\n\n- compute: camada de computação\n- storage: camada de armazenamento.	compute

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	6BA32080EEA
Data	object	Os detalhes do parâmetro.
EngineVersion	string	A versão do mecanismo DPI. Valor padrão: 2.0.	2.0
Engine	string	O mecanismo. Valor padrão: polarx.	polarx
ConfigParameters	array<object>	A lista de parâmetros originais.
	object
ParameterDescription	string	A descrição do parâmetro.	Storage node private protocol switch (-1: disabled, 0: enabled)
ParameterName	string	O nome do parâmetro.	CONN_POOL_XPROTO_STORAGE_DB_PORT
ParameterValue	string	O valor do parâmetro.	-1
RunningParameters	array<object>	A lista de detalhes dos parâmetros em execução.
	object
ParameterDescription	string	A descrição do parâmetro.	Storage node private protocol switch (-1: disabled, 0: enabled)
ParameterName	string	O nome do parâmetro.	CONN_POOL_XPROTO_STORAGE_DB_PORT
ParameterValue	string	O valor do parâmetro.	-1
DBInstanceId	string	O ID da instância.	pxc-********

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6BA32080EEA",
  "Data": {
    "EngineVersion": "2.0",
    "Engine": "polarx",
    "ConfigParameters": [
      {
        "ParameterDescription": "Storage node private protocol switch (-1: disabled, 0: enabled)",
        "ParameterName": "CONN_POOL_XPROTO_STORAGE_DB_PORT",
        "ParameterValue": "-1"
      }
    ],
    "RunningParameters": [
      {
        "ParameterDescription": "Storage node private protocol switch (-1: disabled, 0: enabled)",
        "ParameterName": "CONN_POOL_XPROTO_STORAGE_DB_PORT",
        "ParameterValue": "-1"
      }
    ],
    "DBInstanceId": "pxc-********"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.	A instância especificada não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.