DescribeParameterTemplates - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta os modelos de parâmetros padrão para instâncias do MongoDB.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

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 a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
Engine	string	Sim	O mecanismo de banco de dados. Defina o valor como mongodb.	mongodb
EngineVersion	string	Sim	O número da versão do banco de dados. Valores válidos: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	5.0
Role	string	Não	A função da instância. Valores válidos: db: a função de shard de uma instância de cluster sharded. cs: a função de config server de uma instância de cluster sharded. mongos: a função de mongos de uma instância de cluster sharded. normal: a função de uma instância de conjunto de réplicas. physical: a função de uma instância de nó único. O valor padrão é normal.	normal

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ParameterCount	string	O número de parâmetros.	10
EngineVersion	string	O número da versão do banco de dados.	5.0
Parameters	object
TemplateRecord	array<object>	Uma lista de modelos de parâmetros.
	object
CheckingCode	string	The valid values of the parameter.	[0-65536]
ParameterName	string	The name of the parameter. For more information, see the official MongoDB documentation.	net.compression.compressors
ParameterValue	string	The default value of the parameter.	100
ForceModify	boolean	Indicates whether the parameter can be modified. false: The parameter cannot be modified. true: The parameter can be modified.	true
ForceRestart	boolean	Indicates whether a restart is required for the parameter modification to take effect. false: A restart is not required. The modification takes effect after you submit the modification. true: A restart is required for the modification to take effect.	false
ParameterDescription	string	The description of the parameter.	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
RequestId	string	O ID da solicitação.	BDA54203-9D61-54A3-A568-D281F785****
Engine	string	O mecanismo de banco de dados.	mongodb

Exemplos

Resposta de sucesso

JSON formato

{
  "ParameterCount": "10",
  "EngineVersion": "5.0",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "net.compression.compressors",
        "ParameterValue": "100",
        "ForceModify": true,
        "ForceRestart": false,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100."
      }
    ]
  },
  "RequestId": "BDA54203-9D61-54A3-A568-D281F785****",
  "Engine": "mongodb"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.