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

Consulta a lista de modelos de parâmetros padrão para instâncias do ApsaraDB for MongoDB.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeParameterTemplates	Operação a ser executada. Defina o valor como DescribeParameterTemplates.
RegionId	String	Não	cn-hangzhou	ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
Engine	String	Sim	mongodb	Mecanismo de banco de dados da instância. Defina o valor como MongoDB.
EngineVersion	String	Sim	5.0	Versão do mecanismo de banco de dados da instância. Valores válidos: 5.0 4.4 4.2 4.0 3.4

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
ParameterCount	String	10	Número de parâmetros compatíveis com a instância.
EngineVersion	String	5.0	Versão do mecanismo de banco de dados da instância.
Parameters	Array of TemplateRecord		Detalhes dos modelos de parâmetros.
TemplateRecord
CheckingCode	String	[0-65536]	Intervalo de valores dos parâmetros modificáveis.
ParameterName	String	net.compression.compressors	Nome do parâmetro.
ParameterValue	String	100	Valor padrão do parâmetro.
ForceModify	Boolean	true	Indica se o parâmetro é modificável. false: O parâmetro não pode ser modificado. true: O parâmetro pode ser modificado.
ForceRestart	Boolean	false	Indica se é necessário reiniciar a instância para aplicar as modificações do parâmetro. false: Reinicialização desnecessária. As alterações entram em vigor imediatamente. true: Reinicialização necessária para aplicar as alterações.
ParameterDescription	String	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.	Descrição do parâmetro.
RequestId	String	BDA54203-9D61-54A3-A568-D281F785****	ID da solicitação.
Engine	String	mongodb	Mecanismo de banco de dados da instância.

Exemplos

Exemplos de solicitações

http(s)://mongodb.aliyuncs.com/?Action=DescribeParameterTemplates
&Engine=mongodb
&EngineVersion=5.0
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterTemplatesResponse>
    <ParameterCount>10</ParameterCount>
    <EngineVersion>5.0</EngineVersion>
    <Parameters>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>snappy|zlib|disabled</CheckingCode>
            <ParameterValue>snappy</ParameterValue>
            <ForceRestart>true</ForceRestart>
            <ParameterName>net.compression.compressors</ParameterName>
            <ParameterDescription/>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>synchronous|adaptive</CheckingCode>
            <ParameterValue>synchronous</ParameterValue>
            <ForceRestart>true</ForceRestart>
            <ParameterName>net.serviceExecutor</ParameterName>
            <ParameterDescription>Specifies the thread and execution model used by mongod or mongos.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>off|slowOp|all</CheckingCode>
            <ParameterValue>off</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>operationProfiling.mode</ParameterName>
            <ParameterDescription>The level of database profiling, which inserts information about operation performance into the system.profile collection. 'off' for no profiling, 'slowOp' for only includes slow operations, 'all' for includes all operations, default is 'slowOp'.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[0-65536]</CheckingCode>
            <ParameterValue>100</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>operationProfiling.slowOpThresholdMs</ParameterName>
            <ParameterDescription>The threshold in milliseconds at which the database profiler considers a query slow, default is 100.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>true|false</CheckingCode>
            <ParameterValue>false</ParameterValue>
            <ForceRestart>true</ForceRestart>
            <ParameterName>replication.oplogGlobalIdEnabled</ParameterName>
            <ParameterDescription>Specifies whether to enable GID for two-way synchronization.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[1-2147483647]</CheckingCode>
            <ParameterValue>600000</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>setParameter.cursorTimeoutMillis</ParameterName>
            <ParameterDescription>The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>true|false</CheckingCode>
            <ParameterValue>false</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>setParameter.failIndexKeyTooLong</ParameterName>
            <ParameterDescription>Specifies whether to return an error during indexing when the index is longer than required.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[33554432-268435456]</CheckingCode>
            <ParameterValue>33554432</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>setParameter.internalQueryExecMaxBlockingSortBytes</ParameterName>
            <ParameterDescription>The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[0-60]</CheckingCode>
            <ParameterValue>5</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>setParameter.maxTransactionLockRequestTimeoutMillis</ParameterName>
            <ParameterDescription>The timeout period for transaction locking.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[5-300]</CheckingCode>
            <ParameterValue>60</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>setParameter.transactionLifetimeLimitSeconds</ParameterName>
            <ParameterDescription>The total timeout period for transactions.</ParameterDescription>
        </TemplateRecord>
    </Parameters>
    <RequestId>BDA54203-9D61-54A3-A568-D281F785****</RequestId>
    <Engine>mongodb</Engine>
</DescribeParameterTemplatesResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ParameterCount" : "10",
  "EngineVersion" : "5.0",
  "Parameters" : {
    "TemplateRecord" : [ {
      "ForceModify" : true,
      "CheckingCode" : "snappy|zlib|disabled",
      "ParameterValue" : "snappy",
      "ForceRestart" : true,
      "ParameterName" : "net.compression.compressors",
      "ParameterDescription" : ""
    }, {
      "ForceModify" : true,
      "CheckingCode" : "synchronous|adaptive",
      "ParameterValue" : "synchronous",
      "ForceRestart" : true,
      "ParameterName" : "net.serviceExecutor",
      "ParameterDescription" : "Specifies the thread and execution model used by mongod or mongos."
    }, {
      "ForceModify" : true,
      "CheckingCode" : "off|slowOp|all",
      "ParameterValue" : "off",
      "ForceRestart" : false,
      "ParameterName" : "operationProfiling.mode",
      "ParameterDescription" : "The level of database profiling, which inserts information about operation performance into the system.profile collection. 'off' for no profiling, 'slowOp' for only includes slow operations, 'all' for includes all operations, default is 'slowOp'."
    }, {
      "ForceModify" : true,
      "CheckingCode" : "[0-65536]",
      "ParameterValue" : "100",
      "ForceRestart" : false,
      "ParameterName" : "operationProfiling.slowOpThresholdMs",
      "ParameterDescription" : "The threshold in milliseconds at which the database profiler considers a query slow, default is 100."
    }, {
      "ForceModify" : true,
      "CheckingCode" : "true|false",
      "ParameterValue" : "false",
      "ForceRestart" : true,
      "ParameterName" : "replication.oplogGlobalIdEnabled",
      "ParameterDescription" : "Specifies whether to enable GID for two-way synchronization."
    }, {
      "ForceModify" : true,
      "CheckingCode" : "[1-2147483647]",
      "ParameterValue" : "600000",
      "ForceRestart" : false,
      "ParameterName" : "setParameter.cursorTimeoutMillis",
      "ParameterDescription" : "The expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specified cursorTimeoutMillis. default is 600000(i.e. 10 minutes)"
    }, {
      "ForceModify" : true,
      "CheckingCode" : "true|false",
      "ParameterValue" : "false",
      "ForceRestart" : false,
      "ParameterName" : "setParameter.failIndexKeyTooLong",
      "ParameterDescription" : "Specifies whether to return an error during indexing when the index is longer than required."
    }, {
      "ForceModify" : true,
      "CheckingCode" : "[33554432-268435456]",
      "ParameterValue" : "33554432",
      "ForceRestart" : false,
      "ParameterName" : "setParameter.internalQueryExecMaxBlockingSortBytes",
      "ParameterDescription" : "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)"
    }, {
      "ForceModify" : true,
      "CheckingCode" : "[0-60]",
      "ParameterValue" : "5",
      "ForceRestart" : false,
      "ParameterName" : "setParameter.maxTransactionLockRequestTimeoutMillis",
      "ParameterDescription" : "The timeout period for transaction locking."
    }, {
      "ForceModify" : true,
      "CheckingCode" : "[5-300]",
      "ParameterValue" : "60",
      "ForceRestart" : false,
      "ParameterName" : "setParameter.transactionLifetimeLimitSeconds",
      "ParameterDescription" : "The total timeout period for transactions."
    } ]
  },
  "RequestId" : "BDA54203-9D61-54A3-A568-D281F785****",
  "Engine" : "mongodb"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.