DescribeDBClusterParameters - PolarDB

Mengambil daftar parameter yang sedang berjalan untuk kluster PolarDB.

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

polardb:DescribeDBClusterParameters

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster.	pc-**********
DescribeType	string	No	Parameter kernel. Nilai yang valid: Normal: Daftar parameter kernel. MigrationFromRDS: Membandingkan parameter dengan instans ApsaraDB RDS.	Normal

Elemen respons

Element	Type	Description	Example
	object
RunningParameters	object
Parameter	array<object>	Daftar parameter yang sedang berjalan saat ini di kluster PolarDB.
	object
CheckingCode	string	Rentang nilai yang valid untuk parameter tersebut.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	Tipe data dari nilai parameter. Nilai yang valid: INT: integer. STRING: string. B: byte.	INT
ParameterName	string	Nama parameter.	character_set_server
ParameterValue	string	Nilai parameter.	utf8
ForceRestart	boolean	Menunjukkan apakah restart diperlukan agar parameter berlaku. Nilai yang valid: false: Restart tidak diperlukan. true: Restart diperlukan.	true
ParameterDescription	string	Deskripsi parameter.	The server's default character set.
ParameterStatus	string	Status parameter. Nilai yang valid: Normal: Parameter dalam keadaan normal. Modifying: Parameter sedang dimodifikasi.	Normal
DefaultParameterValue	string	Nilai default parameter.	utf8
IsModifiable	boolean	Menunjukkan apakah parameter dapat dimodifikasi. Nilai yang valid: false: Parameter tidak dapat dimodifikasi. true: Parameter dapat dimodifikasi.	true
IsNodeAvailable	string	Menunjukkan apakah parameter merupakan parameter global. Nilai yang valid: 0: Parameter adalah parameter global. Setelah dimodifikasi, nilainya secara otomatis disinkronkan ke node lain. 1: Parameter bukan parameter global. Anda dapat menentukan node mana yang akan menerima nilai parameter yang telah dimodifikasi.	0
ParamRelyRule	string	Ketergantungan parameter.	utf8
Factor	string	Faktor pembagi. Untuk parameter bertipe integer dan byte, nilai parameter harus merupakan kelipatan dari Factor (yang tidak boleh 0) dan berada dalam rentang nilai yang valid.	20
DBVersion	string	Versi mesin database. Nilai yang valid untuk MySQL: 5.6 5.7 8.0 Nilai yang valid untuk PostgreSQL: 11 14 Nilai yang valid untuk Oracle: 11 14	5.6
RequestId	string	ID permintaan.	EBEAA83D-1734-42E3-85E3-E25F6E******
DBType	string	Jenis database. Nilai yang valid: MySQL PostgreSQL Oracle	MySQL
Engine	string	Mesin.	POLARDB
DBClusterId	string	ID kluster.	pc-bp1s826a1up******
ParameterNumbers	string	Jumlah parameter.	1
Parameters	object
Parameters	array<object>	Daftar hasil perbandingan parameter untuk migrasi instans dari ApsaraDB RDS ke PolarDB.
	object
rdsParameterName	string	Nama parameter instans sumber.	character_set_server
rdsParameterValue	string	Nilai parameter instans sumber.	utf8
rdsParameterOptional	string	Nilai yang valid untuk parameter instans sumber.	- utf8 - gbk
distParameterName	string	Nama parameter kluster.	character_set_server
distParameterValue	string	Nilai parameter kluster.	utf8
distParameterOptional	string	Nilai yang valid untuk parameter kluster.	- utf8 - gbk
IsEqual	string	Menunjukkan apakah nilai parameter sama.	true
distParameterDescription	string	Deskripsi parameter kluster.	The server's default character set.
rdsParameterDescription	string	Deskripsi parameter instans sumber.	The server's default character set.
IsRdsKey	string	Menunjukkan apakah parameter merupakan parameter kunci pada instans sumber. Nilai yang valid: 1: Parameter adalah parameter kunci pada instans sumber. 0: Parameter bukan parameter kunci pada instans sumber.	1
IsPolarDBKey	string	Menunjukkan apakah parameter merupakan parameter kunci pada instans tujuan. Nilai yang valid: 1: Parameter adalah parameter kunci pada instans tujuan. 0: Parameter bukan parameter kunci pada instans tujuan.	0
IsInstancePolarDBKey	string	Menunjukkan apakah parameter merupakan parameter kunci pada instans tujuan. Nilai yang valid: 1: Parameter adalah parameter kunci pada instans tujuan. 0: Parameter bukan parameter kunci pada instans tujuan.	1
IsInstanceRdsKey	string	Menunjukkan apakah parameter merupakan parameter kunci pada instans sumber. Nilai yang valid: 1: Parameter adalah parameter kunci pada instans sumber. 0: Parameter bukan parameter kunci pada instans sumber.	0

Contoh

Respons sukses

JSONformat

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
        "DataType": "INT",
        "ParameterName": "character_set_server",
        "ParameterValue": "utf8",
        "ForceRestart": true,
        "ParameterDescription": "The server's default character set.",
        "ParameterStatus": "Normal",
        "DefaultParameterValue": "utf8",
        "IsModifiable": true,
        "IsNodeAvailable": "0",
        "ParamRelyRule": "utf8",
        "Factor": "20"
      }
    ]
  },
  "DBVersion": "5.6",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBClusterId": "pc-bp1s826a1up******\t\n",
  "ParameterNumbers": "1",
  "Parameters": {
    "Parameters": [
      {
        "rdsParameterName": "character_set_server",
        "rdsParameterValue": "utf8",
        "rdsParameterOptional": "- utf8\n- gbk",
        "distParameterName": "character_set_server",
        "distParameterValue": "utf8",
        "distParameterOptional": "- utf8\n- gbk",
        "IsEqual": "true",
        "distParameterDescription": "The server's default character set.",
        "rdsParameterDescription": "The server's default character set.",
        "IsRdsKey": "1",
        "IsPolarDBKey": "0",
        "IsInstancePolarDBKey": "1",
        "IsInstanceRdsKey": "0"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.