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

Consulta os parâmetros de nós especificados em um cluster.

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

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-****************
DBNodeIds	string	Sim	O ID do nó. Você pode especificar vários IDs de nós. Separe os IDs com uma vírgula (,).	pi-**************,pi-**************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DBVersion	string	A versão do banco de dados MySQL. Valores válidos: 5.6 5.7 8.0	5.6
RequestId	string	O ID da solicitação.	9B7BFB11-C077-4FE3-B051-F69CEB******
DBType	string	O tipo do banco de dados. O valor é fixo como MySQL.	MySQL
Engine	string	O mecanismo de banco de dados do cluster.	POLARDB
DBNodeIds	array<object>	A lista de IDs de nós.
	array<object>
DBNodeId	string	O ID do nó.	pi-bp1r4qe3s534*****
RunningParameters	array<object>	A lista de parâmetros que estão em execução no nó.
	object
CheckingCode	string	The valid values of the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter. Valid values: INT: Integer STRING: String B: Byte	INT
DefaultParameterValue	string	The default value of the parameter.	utf8
ForceRestart	boolean	Indicates whether a restart is required for the parameter modification to take effect. Valid values: false: No true: Yes	true
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false: No true: Yes	true
ParameterDescription	string	The description of the parameter.	The server's default character set.
ParameterName	string	The name of the parameter.	character_set_server
ParameterStatus	string	The status of the parameter. Valid values: normal: Normal modifying: Modifying	normal
ParameterValue	string	The value of the parameter.	utf8
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. Modifications to the parameter are applied to other nodes by default and cannot be canceled. 1: The parameter is not a global parameter. You can specify the nodes to which you want to apply the parameter modifications.	1
ParamRelyRule	string	The dependency of the parameter.	utf8
Factor	string	The divisor. For integer and byte type parameters, the parameter value must be a multiple of this factor. The factor cannot be 0.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "DBVersion": "5.6",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBNodeIds": [
    {
      "DBNodeId": "pi-bp1r4qe3s534*****",
      "RunningParameters": [
        {
          "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
          "DataType": "INT",
          "DefaultParameterValue": "utf8",
          "ForceRestart": true,
          "IsModifiable": true,
          "ParameterDescription": "The server's default character set.",
          "ParameterName": "character_set_server",
          "ParameterStatus": "normal",
          "ParameterValue": "utf8",
          "IsNodeAvailable": "1",
          "ParamRelyRule": "utf8",
          "Factor": "20"
        }
      ]
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.	The specified cluster ID does not exist.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.