Referensi API DescribeDBClusterParameters - PolarDB - Alibaba Cloud - PolarDB

Membuat kueri daftar parameter yang berjalan untuk cluster 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 cluster.	pc-**********
DescribeType	string	No	Parameter kernel. Nilai yang valid: Normal: Daftar parameter kernel. MigrationFromRDS: Membandingkan parameter dengan parameter instans ApsaraDB RDS.	Normal

Elemen respons

Element	Type	Description	Example
	object
RunningParameters	object
Parameter	array<object>	Daftar parameter yang sedang berjalan di cluster PolarDB.
	object
CheckingCode	string	The valid values of the parameter.	[utf8\|latin1\|gbk\|utf8mb4]
DataType	string	The data type of the parameter value. Valid values: INT STRING B	INT
ParameterName	string	The name of the parameter.	character_set_server
ParameterValue	string	The value of the parameter.	utf8
ForceRestart	boolean	Indicates whether a cluster restart is required for the parameter modification to take effect. Valid values: false true	true
ParameterDescription	string	The description of the parameter.	The server's default character set.
ParameterStatus	string	The status of the parameter. Valid values: Normal Modifying	Normal
DefaultParameterValue	string	The default value of the parameter.	utf8
IsModifiable	boolean	Indicates whether the parameter can be modified. Valid values: false true	true
IsNodeAvailable	string	Indicates whether the parameter is a global parameter. Valid values: 0: The parameter is a global parameter. The modified parameter value is synchronized to other nodes. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value can be synchronized.	0
ParamRelyRule	string	The dependencies of the parameter.	utf8
Factor	string	A divisor of the parameter. For a parameter of the integer or byte type, the valid values must be a multiple of Factor unless you set Factor to 0.	20
DBVersion	string	Versi engine 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	Tipe database. Nilai yang valid: MySQL PostgreSQL Oracle	MySQL
Engine	string	Engine.	POLARDB
DBClusterId	string	ID cluster.	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	The name of the parameter of the source instance.	character_set_server
rdsParameterValue	string	The value of the parameter of the source instance.	utf8
rdsParameterOptional	string	The valid values of the parameter of the source instance.	- utf8 - gbk
distParameterName	string	The name of the parameter of the destination cluster.	character_set_server
distParameterValue	string	The value of the parameter of the destination cluster.	utf8
distParameterOptional	string	The valid values of the parameter of the destination cluster.	- utf8 - gbk
IsEqual	string	Indicates whether the source and current parameters have the same value.	true
distParameterDescription	string	The description of the parameter of the destination cluster.	The server's default character set.
rdsParameterDescription	string	The description of the parameter of the source instance.	The server's default character set.
IsRdsKey	string	Indicate whether the parameter is a primary parameter of the source instance. Valid values: 1: The parameter is a primary parameter of the source instance. 0: The parameter is not a primary parameter of the source instance.	1
IsPolarDBKey	string	Indicate whether the parameter is a primary parameter of the destination cluster. Valid values: 1: The parameter is a primary parameter of the destination cluster. 0: The parameter is not a primary parameter of the destination cluster.	0
IsInstancePolarDBKey	string	Indicate whether the parameter is a primary parameter of the destination cluster. Valid values: 1: The parameter is a primary parameter of the destination cluster. 0: The parameter is not a primary parameter of the destination cluster.	1
IsInstanceRdsKey	string	Indicate whether the parameter is a primary parameter of the source instance. Valid values: 1: The parameter is a primary parameter of the source instance. 0: The parameter is not a primary parameter of the source instance.	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.