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

Consulta a lista de parâmetros em execução de um cluster PolarDB.

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

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-**********
DescribeType	string	Não	Os parâmetros do kernel. Valores válidos: Normal: A lista de parâmetros do kernel. MigrationFromRDS: Compara os parâmetros com os de uma instância do ApsaraDB RDS.	Normal

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RunningParameters	object
Parameter	array<object>	A lista de parâmetros atualmente em execução no cluster PolarDB.
	object
CheckingCode	string	The valid range of values for the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter value. Valid values: INT: integer. STRING: string. B: byte.	INT
ParameterName	string	The parameter name.	character_set_server
ParameterValue	string	The parameter value.	utf8
ForceRestart	boolean	Indicates whether a restart is required for the parameter to take effect. Valid values: false: A restart is not required. true: A restart is required.	true
ParameterDescription	string	The parameter description.	The server's default character set.
ParameterStatus	string	The status of the parameter. Valid values: Normal: The parameter is in the normal state. Modifying: The parameter is being modified.	Normal
DefaultParameterValue	string	The default value of the parameter.	utf8
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false: The parameter cannot be modified. true: The parameter can be modified.	true
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. After the parameter is modified, its new value is synchronized to other nodes by default. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.	0
ParamRelyRule	string	The parameter dependencies.	utf8
Factor	string	The division factor. For integer and byte type parameters, the parameter value must be a multiple of Factor (which cannot be 0) and fall within the valid value range.	20
DBVersion	string	A versão do mecanismo de banco de dados. Valores válidos para MySQL: 5.6 5.7 8.0 Valores válidos para PostgreSQL: 11 14 Valores válidos para Oracle: 11 14	5.6
RequestId	string	O ID da solicitação.	EBEAA83D-1734-42E3-85E3-E25F6E******
DBType	string	O tipo de banco de dados. Valores válidos: MySQL PostgreSQL Oracle	MySQL
Engine	string	O mecanismo.	POLARDB
DBClusterId	string	O ID do cluster.	pc-bp1s826a1up******
ParameterNumbers	string	O número de parâmetros.	1
Parameters	object
Parameters	array<object>	A lista de resultados de comparação de parâmetros para a migração de uma instância do ApsaraDB RDS para o PolarDB.
	object
rdsParameterName	string	The name of the source instance parameter.	character_set_server
rdsParameterValue	string	The value of the source instance parameter.	utf8
rdsParameterOptional	string	The valid values of the source instance parameter.	- utf8 - gbk
distParameterName	string	The name of the cluster parameter.	character_set_server
distParameterValue	string	The value of the cluster parameter.	utf8
distParameterOptional	string	The valid values of the cluster parameter.	- utf8 - gbk
IsEqual	string	Indicates whether the parameter values are the same.	true
distParameterDescription	string	The description of the cluster parameter.	The server's default character set.
rdsParameterDescription	string	The description of the source instance parameter.	The server's default character set.
IsRdsKey	string	Indicates whether the parameter is a key parameter of the source instance. Valid values: 1: The parameter is a key parameter of the source instance. 0: The parameter is not a key parameter of the source instance.	1
IsPolarDBKey	string	Indicates whether the parameter is a key parameter of the destination instance. 1: The parameter is a key parameter of the destination instance. 0: The parameter is not a key parameter of the destination instance.	0
IsInstancePolarDBKey	string	Indicates whether the parameter is a key parameter of the destination instance. 1: The parameter is a key parameter of the destination instance. 0: The parameter is not a key parameter of the destination instance.	1
IsInstanceRdsKey	string	Indicates whether the parameter is a key parameter of the source instance. 1: The parameter is a key parameter of the source instance. 0: The parameter is not a key parameter of the source instance.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
        "DataType": "INT",
        "ParameterName": "character_set_server",
        "ParameterValue": "utf8",
        "ForceRestart": true,
        "ParameterDescription": "The server's default character set.",
        "ParameterStatus": "Normal",
        "DefaultParameterValue": "utf8",
        "IsModifiable": true,
        "IsNodeAvailable": "0",
        "ParamRelyRule": "utf8",
        "Factor": "20"
      }
    ]
  },
  "DBVersion": "5.6",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBClusterId": "pc-bp1s826a1up******\t\n",
  "ParameterNumbers": "1",
  "Parameters": {
    "Parameters": [
      {
        "rdsParameterName": "character_set_server",
        "rdsParameterValue": "utf8",
        "rdsParameterOptional": "- utf8\n- gbk",
        "distParameterName": "character_set_server",
        "distParameterValue": "utf8",
        "distParameterOptional": "- utf8\n- gbk",
        "IsEqual": "true",
        "distParameterDescription": "The server's default character set.",
        "rdsParameterDescription": "The server's default character set.",
        "IsRdsKey": "1",
        "IsPolarDBKey": "0",
        "IsInstancePolarDBKey": "1",
        "IsInstanceRdsKey": "0"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.