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

Consulta as configurações de parâmetros de uma instância do ApsaraDB for 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ê definir este parâmetro como o ID de uma instância de cluster fragmentado, também deverá especificar o parâmetro NodeId.	dds-bpxxxxxxxx
NodeId	string	Não	O ID do nó mongos ou shard na instância de cluster fragmentado especificada. Nota Este parâmetro é válido quando o parâmetro DBInstanceId é definido como o ID de uma instância de cluster fragmentado.	d-bpxxxxxxxx
CharacterType	string	Não	A função da instância. Valores válidos: db: um nó shard. cs: um nó Configserver. mongos: um nó mongos.	mongos
ExtraParam	string	Não	O parâmetro que estará disponível no futuro.	terrform

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RunningParameters	object
Parameter	array<object>	As configurações dos parâmetros que entraram em vigor.
	object
CheckingCode	string	The valid values of the parameter.	[33554432-268435456]
ParameterName	string	The name of the parameter.	setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValue	string	The value of the parameter.	33554432
ForceRestart	string	Indicates whether a restart is required for parameter modifications to take effect. Valid values: false: A restart is not required. Modifications take effect immediately. true: A restart is required for parameter modifications to take effect.	false
ParameterDescription	string	The description of the parameter.	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatus	string	Indicates whether the parameter value can be modified. Valid values: false: The parameter value cannot be modified. true: The parameter value can be modified.	true
CharacterType	string	The role type of the instance. Valid values: db: shard role. cs: config server role. mongos: mongos role.	db
EngineVersion	string	A versão do mecanismo de banco de dados da instância.	4.0
RequestId	string	O ID da solicitação.	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	As configurações de parâmetros no modelo de configuração.
	object
CheckingCode	string	The valid values of the parameter.	[0-65536]
ParameterName	string	The name of the parameter.	operationProfiling.slowOpThresholdMs
ParameterValue	string	The value of the parameter.	200
ForceRestart	boolean	Indicates whether a restart is required for parameter modifications to take effect. Valid values: false: A restart is not required. Modifications take effect immediately. true: A restart is required for parameter modifications to take effect.	true
ParameterDescription	string	The description of the parameter.	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatus	boolean	Indicates whether the parameter value can be modified. Valid values: false: The parameter value cannot be modified. true: The parameter value can be modified.	true
Engine	string	O mecanismo de banco de dados da instância. 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.	Invalid instance type. Specify another instance type.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.