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

Consulta as configurações de parâmetros de uma instância 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

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

dds:DescribeParameters

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Nota Se você especificar o ID de uma instância de cluster fragmentado para este parâmetro, também deverá especificar o parâmetro NodeId.	dds-bpxxxxxxxx
NodeId	string	Não	O ID da instância do mongos ou do nó de shard na instância de cluster fragmentado. Nota Este parâmetro está disponível somente quando o parâmetro DBInstanceId é definido como o ID de uma instância de cluster fragmentado.	d-bpxxxxxxxx
CharacterType	string	Não	O tipo de função da instância. Valores válidos: db: função de shard cs: função de servidor de configuração mongos: função de mongos	mongos
ExtraParam	string	Não	O parâmetro estendido.	terrform

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RunningParameters	object
Parameter	array<object>	A lista de configurações de parâmetros que estão em vigor no momento.
	object
CheckingCode	string	O intervalo de valores do parâmetro.	[33554432-268435456]
ParameterName	string	O nome do parâmetro.	setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValue	string	O valor do parâmetro.	33554432
ForceRestart	string	Especifica se uma reinicialização é necessária para que a modificação do parâmetro entre em vigor. Valores válidos: false: Uma reinicialização não é necessária. A modificação entra em vigor imediatamente após o envio. true: Uma reinicialização é necessária.	false
ParameterDescription	string	A descrição do parâmetro.	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatus	string	Especifica se o parâmetro pode ser modificado. Valores válidos: false: O parâmetro não pode ser modificado. true: O parâmetro pode ser modificado.	true
CharacterType	string	O tipo de função da instância. Valores válidos: db: função de shard cs: função de servidor de configuração mongos: função de mongos	db
EngineVersion	string	A versão do mecanismo do banco de dados.	4.0
RequestId	string	O ID da solicitação.	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	A lista de configurações de parâmetros na configuração.
	object
CheckingCode	string	O intervalo de valores do parâmetro.	[0-65536]
ParameterName	string	O nome do parâmetro.	operationProfiling.slowOpThresholdMs
ParameterValue	string	O valor do parâmetro.	200
ForceRestart	boolean	Especifica se uma reinicialização é necessária para que a modificação do parâmetro entre em vigor. Valores válidos: false: Uma reinicialização não é necessária. A modificação entra em vigor imediatamente após o envio. true: Uma reinicialização é necessária.	true
ParameterDescription	string	A descrição do parâmetro.	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatus	boolean	Especifica se o parâmetro pode ser modificado. Valores válidos: false: O parâmetro não pode ser modificado. true: O parâmetro pode ser modificado.	true
Engine	string	O mecanismo do banco de dados. Valor padrão: mongodb.	mongodb

Exemplos

Resposta de sucesso

JSON formato

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[33554432-268435456]",
        "ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes",
        "ParameterValue": "33554432",
        "ForceRestart": "false",
        "ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
        "ModifiableStatus": "true",
        "CharacterType": "db"
      }
    ]
  },
  "EngineVersion": "4.0",
  "RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "operationProfiling.slowOpThresholdMs",
        "ParameterValue": "200",
        "ForceRestart": true,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
        "ModifiableStatus": true
      }
    ]
  },
  "Engine": "mongodb"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	The specified DB instance type is not found.	A especificação da instância selecionada não existe. Selecione outra.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.