Kueri konfigurasi dan parameter berjalan dengan DescribeParameters - Tair (Redis® OSS-Compatible)

Mengkueri parameter konfigurasi dan waktu proses instans Tair (ApsaraDB for Redis).

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

kvstore:DescribeParameters

get

*DBInstance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah tempat instans dibuat. Panggil operasi DescribeRegions untuk mengkueri wilayah yang tersedia.	cn-hangzhou
DBInstanceId	string	Yes	ID instans.	r-bp1zxszhcgatnx****
NodeId	string	No	ID node. Catatan Gunakan parameter ini untuk mengkueri konfigurasi node tertentu dalam instans kluster.	r-bp1xxxxxxxxxxxxx-db-0

Elemen respons

Element	Type	Description	Example
	object	Objek respons.
RequestId	string	ID permintaan.	9C1338BE-8DE8-4890-A900-E1BC06BF****
Engine	string	Engine database.	redis
EngineVersion	string	Versi engine.	4.0
ConfigParameters	object
Parameter	array<object>	Daftar parameter konfigurasi yang belum diterapkan.
	object	Objek parameter konfigurasi.
CheckingCode	string	Aturan validasi yang menentukan nilai yang diizinkan untuk parameter tersebut.	[0\|1]
ParameterName	string	Nama parameter.	script_check_enable
ParameterValue	string	Nilai parameter.	1
ForceRestart	boolean	Menunjukkan apakah restart diperlukan agar perubahan diterapkan. Nilai yang valid: true: Restart diperlukan. false: Restart tidak diperlukan. Perubahan langsung berlaku.	true
ParameterDescription	string	Deskripsi parameter.	Check all keys passed in the KEYS array map to the same slot.
ModifiableStatus	boolean	Menunjukkan apakah parameter dapat dimodifikasi. Nilai yang valid: false: Parameter tidak dapat dimodifikasi. true: Parameter dapat dimodifikasi.	true
RunningParameters	object
Parameter	array<object>	Daftar parameter waktu proses saat ini.
	object	Objek parameter waktu proses.
CheckingCode	string	Aturan validasi yang menentukan nilai yang diizinkan untuk parameter tersebut.	[0\|1]
ParameterName	string	Nama parameter.	#no_loose_disabled-commands
ParameterValue	string	Nilai parameter.	keys,flushall,flushdb
ForceRestart	string	Apakah perlu restart agar berlaku, nilai yang dikembalikan: True: Berlaku setelah restart. False: Tidak perlu restart, langsung berlaku setelah disimpan.	true
ParameterDescription	string	Deskripsi parameter.	You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].
ModifiableStatus	string	Apakah parameter dapat dimodifikasi, nilai yang dikembalikan: False: Tidak dapat dimodifikasi. True: Dapat dimodifikasi.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF****",
  "Engine": "redis",
  "EngineVersion": "4.0",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "script_check_enable",
        "ParameterValue": "1",
        "ForceRestart": true,
        "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
        "ModifiableStatus": true
      }
    ]
  },
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "#no_loose_disabled-commands",
        "ParameterValue": "keys,flushall,flushdb",
        "ForceRestart": "true",
        "ParameterDescription": "You can disable some dangerous commands, for example \\\"keys,flushdb,flushall\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
        "ModifiableStatus": "true"
      }
    ]
  }
}

Kode kesalahan

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

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.