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

Obtém os parâmetros atuais e as informações de modelo de uma aplicação especificada e de seus componentes.

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

polardb:DescribeApplicationParameters

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ApplicationId	string	Sim	O ID da aplicação.	pa-**************
ComponentIdList	array	Não	Uma lista de IDs de subcomponentes. Se você especificar este parâmetro, a operação retornará os parâmetros e os modelos de parâmetros apenas para esses componentes.
	string	Não	O ID do subcomponente.	pac-**************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
RequestId	string	O ID da solicitação.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
Parameters	object	Os detalhes dos parâmetros.
ComponentParameters	array<object>	Uma lista de subcomponentes que contêm listas de detalhes de parâmetros.
	array<object>	Um subcomponente que contém uma lista de detalhes de parâmetros.
ComponentType	string	The type of the subcomponent.	supabase
Parameters	array<object>	A list of parameter details.
	object	The parameter details.
Status	string	The status.	Applied
ReadOnly	boolean	Indicates whether the parameter is read-only.	false
Pattern	string	The regular expression for the parameter.	^[a-zA-Z0-9]{1,20}$
Type	string	The parameter type.	string
Description	string	The parameter description.	The name of the parameter
Value	string	The current value of the parameter.	value
NeedRestart	boolean	Indicates whether the application needs to be restarted after you modify the parameter.	false
Default	string	The default value of the parameter.	default value
Name	string	The parameter name.	name
ComponentId	string	The subcomponent ID or application ID.	pac-**************
ParameterTemplates	object	Os detalhes do modelo de parâmetro.
ComponentParameterTemplates	array<object>	Uma lista de subcomponentes que contêm listas de detalhes de modelos de parâmetros.
	array<object>
ComponentType	string	The type of the subcomponent.	supabase
Parameters	array<object>	A list of parameter template details.
	object	The details of the parameter template.
Pattern	string	The regular expression for the parameter.	^[a-zA-Z0-9]{1,20}$
Type	string	The parameter type.	string
Description	string	The parameter description.	The name of the parameter
ReadOnly	boolean	Indicates whether the parameter is read-only.	false
Default	string	The default value of the parameter.	default
Name	string	The parameter name.	name
NeedRestart	boolean	Indicates whether the application needs to be restarted after you modify the parameter.	false
ComponentId	string	The subcomponent ID or application ID.	pac-**************

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "Parameters": {
    "ComponentParameters": [
      {
        "ComponentType": "supabase",
        "Parameters": [
          {
            "Status": "Applied",
            "ReadOnly": false,
            "Pattern": "^[a-zA-Z0-9]{1,20}$",
            "Type": "string",
            "Description": "The name of the parameter",
            "Value": "value",
            "NeedRestart": false,
            "Default": "default value",
            "Name": "name"
          }
        ],
        "ComponentId": "pac-**************"
      }
    ]
  },
  "ParameterTemplates": {
    "ComponentParameterTemplates": [
      {
        "ComponentType": "supabase",
        "Parameters": [
          {
            "Pattern": "^[a-zA-Z0-9]{1,20}$",
            "Type": "string",
            "Description": "The name of the parameter",
            "ReadOnly": false,
            "Default": "default",
            "Name": "name",
            "NeedRestart": false
          }
        ],
        "ComponentId": "pac-**************"
      }
    ]
  }
}

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.