Ringkasan template parameter MongoDB default - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri template parameter default untuk instans MongoDB.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID region. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar region terbaru.	cn-hangzhou
Engine	string	Yes	Mesin database. Tetapkan nilai ke mongodb.	mongodb
EngineVersion	string	Yes	Nomor versi database. Nilai yang valid: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	5.0
Role	string	No	Peran instans. Nilai yang valid: db: peran shard dari instans sharded cluster. cs: peran config server dari instans sharded cluster. mongos: peran mongos dari instans sharded cluster. normal: peran instans replica set. physical: peran instans single node. Nilai default-nya adalah normal.	normal

Elemen respons

Element	Type	Description	Example
	object
ParameterCount	string	Jumlah parameter.	10
EngineVersion	string	Nomor versi database.	5.0
Parameters	object
TemplateRecord	array<object>	Daftar template parameter.
	object
CheckingCode	string	The valid values of the parameter.	[0-65536]
ParameterName	string	The name of the parameter. For more information, see the official MongoDB documentation.	net.compression.compressors
ParameterValue	string	The default value of the parameter.	100
ForceModify	boolean	Indicates whether the parameter can be modified. false: The parameter cannot be modified. true: The parameter can be modified.	true
ForceRestart	boolean	Indicates whether a restart is required for the parameter modification to take effect. false: A restart is not required. The modification takes effect after you submit the modification. true: A restart is required for the modification to take effect.	false
ParameterDescription	string	The description of the parameter.	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
RequestId	string	ID permintaan.	BDA54203-9D61-54A3-A568-D281F785****
Engine	string	Mesin database.	mongodb

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.