Gunakan API DescribeParameterTemplates untuk Parameter Default Kluster PolarDB - PolarDB - Alibaba Cloud - PolarDB

Mengkueri parameter default dari Kluster database.

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:DescribeParameterTemplates

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBType	string	Yes	Tipe mesin database. Hanya MySQL yang didukung.	MySQL
DBVersion	string	Yes	Versi database. Nilai valid: 5.6 5.7 8.0.	5.7
RegionId	string	Yes	ID Wilayah. Catatan Panggil operasi DescribeRegions untuk mengkueri ID Wilayah yang tersedia.	cn-hangzhou
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-************

Elemen respons

Element	Type	Description	Example
	object
ParameterCount	string	The number of parameters.	183
DBVersion	string	The database engine version.	5.7
Parameters	object
TemplateRecord	array<object>	A list of parameters.
	object
CheckingCode	string	The valid values for the parameter.	[ROW\|STATEMENT\|MIXED]
ParameterName	string	The parameter name.	binlog_format
ParameterValue	string	The default value of the parameter.	ROW
ForceModify	string	Indicates whether the parameter can be modified. Valid values: true: The parameter can be modified. false: The parameter cannot be modified.	true
ForceRestart	string	Indicates whether a restart is required for a new parameter value to take effect. Valid values: true: A restart is required. false: A restart is not required.	false
ParameterDescription	string	The parameter description.	What form of binary logging the master will use.
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 by default. 1: The parameter is not a global parameter. You can specify the nodes to which the modified parameter value is synchronized.	1
ParamRelyRule	string	The parameter dependencies.	utf8
RequestId	string	The request ID.	D963934D-8605-4473-8EAC-54C719******
DBType	string	The database engine type.	MySQL
Engine	string	The database engine.	POLARDB

Contoh

Respons sukses

JSONformat

{
  "ParameterCount": "183",
  "DBVersion": "5.7",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[ROW|STATEMENT|MIXED]",
        "ParameterName": "binlog_format",
        "ParameterValue": "ROW",
        "ForceModify": "true",
        "ForceRestart": "false",
        "ParameterDescription": "What form of binary logging the master will use.",
        "IsNodeAvailable": "1",
        "ParamRelyRule": "utf8"
      }
    ]
  },
  "RequestId": "D963934D-8605-4473-8EAC-54C719******",
  "DBType": "MySQL",
  "Engine": "POLARDB"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidDBType.NotFound	The Specified DBType does not found.
400	InvalidDBVersion.Malformed	The Specified DBVersion is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.