使用DescribeParameterTemplates查詢預設參數模板列表-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢MongoDB執行個體預設的參數模板列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID，您可以調用 DescribeRegions 查詢。	cn-hangzhou
Engine	string	是	資料庫引擎，取值：mongodb。	mongodb
EngineVersion	string	是	資料庫版本號碼。取值如下： 7.0 6.0 5.0 4.4 4.2 4.0 3.4	5.0
Role	string	否	執行個體的角色類型，取值說明： db：分區叢集 shard 角色。 cs：分區叢集 config server 角色。 mongos：分區叢集 mongos 角色。 normal: 複本集角色。 physical：單節點角色。預設值為 normal。	normal

返回參數

名稱	類型	描述	樣本值
	object
ParameterCount	string	參數個數。	10
EngineVersion	string	資料庫版本號碼。	5.0
Parameters	object
TemplateRecord	array<object>	參數模板列表。
	object
CheckingCode	string	可修改參數的值。	[0-65536]
ParameterName	string	參數名稱。詳情請參見 MongoDB 官方文檔	net.compression.compressors
ParameterValue	string	參數預設值。	100
ForceModify	boolean	參數是否處於可修改的狀態。 false：不可修改。 true：可修改。	true
ForceRestart	boolean	修改參數後是否需要重啟生效。 false：無需重啟，提交後即生效。 true：需要重啟生效。	false
ParameterDescription	string	參數描述。	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
RequestId	string	請求 ID。	BDA54203-9D61-54A3-A568-D281F785****
Engine	string	資料庫引擎。	mongodb

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。