DescribeParameterTemplates - - Centre de documentation Alibaba Cloud

Répertorie les modèles de paramètres par défaut des instances ApsaraDB for MongoDB.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeParameterTemplates	Opération à effectuer. Définissez la valeur sur DescribeParameterTemplates.
RegionId	String	No	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste des régions disponibles.
Engine	String	Yes	mongodb	Moteur de base de données de l'instance. Définissez la valeur sur MongoDB.
EngineVersion	String	Yes	5.0	Version du moteur de base de données de l'instance. Valeurs possibles : 5.0 4.4 4.2 4.0 3.4

Paramètres de réponse

Parameter	Type	Example	Description
ParameterCount	String	10	Nombre de paramètres pris en charge par l'instance.
EngineVersion	String	5.0	Version du moteur de base de données de l'instance.
Parameters	Array of TemplateRecord		Détails des modèles de paramètres.
TemplateRecord
CheckingCode	String	[0-65536]	Plage de valeurs des paramètres modifiables.
ParameterName	String	net.compression.compressors	Nom du paramètre.
ParameterValue	String	100	Valeur par défaut du paramètre.
ForceModify	Boolean	true	Indique si le paramètre est modifiable. false : Le paramètre n'est pas modifiable. true : Le paramètre est modifiable.
ForceRestart	Boolean	false	Indique si un redémarrage est nécessaire pour appliquer les modifications de paramètres. false : Aucun redémarrage n'est nécessaire. Les modifications sont appliquées immédiatement. true : Un redémarrage est nécessaire pour appliquer les modifications.
ParameterDescription	String	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.	Description du paramètre.
RequestId	String	BDA54203-9D61-54A3-A568-D281F785****	ID de la requête.
Engine	String	mongodb	Moteur de base de données de l'instance.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format 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>

Format 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"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.