ApsaraDB untuk MongoDB:DescribeParameters-ApsaraDB untuk MongoDB-Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri pengaturan parameter instans Database Apsara untuk 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

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeParameters

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Catatan Jika Anda menetapkan parameter ini ke ID instans kluster sharded, Anda juga harus menentukan parameter NodeId.	dds-bpxxxxxxxx
NodeId	string	No	ID node Mongos (Proxy Layanan) atau shard di instans kluster sharded yang ditentukan. Catatan Parameter ini valid ketika parameter DBInstanceId ditetapkan ke ID instans kluster sharded.	d-bpxxxxxxxx
CharacterType	string	No	Peran instans. Nilai valid: db: node shard. cs: node Configserver. mongos: node Mongos (Proxy Layanan).	mongos
ExtraParam	string	No	Parameter yang akan tersedia di masa mendatang.	terrform

Elemen respons

Element	Type	Description	Example
	object
RunningParameters	object
Parameter	array<object>	The settings of the parameters that have taken effect.
	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	实例的角色类型，取值说明： db：shard 角色。 cs：config server 角色。 mongos：mongos 角色。	db
EngineVersion	string	The database engine version of the instance.	4.0
RequestId	string	The request ID.	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	The parameter settings in the configuration template.
	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	The database engine of the instance. Default value: mongodb.	mongodb

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	The specified DB instance type is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.