All Products
Search

This Product

    PolarDB:DescribeParameterGroups

    Document Center

    PolarDB:DescribeParameterGroups

    Last Updated:Jun 10, 2026

    Operasi ini mengkueri template parameter di Wilayah tertentu.

    Deskripsi operasi

    Parameter templates allow you to manage cluster parameters in batches and quickly apply them to PolarDB clusters. For more information, see Use parameter templates.

    Catatan

    This feature is available only for PolarDB for MySQL clusters.

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

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID Wilayah.

    Catatan

    Panggil operasi DescribeRegions untuk mengkueri informasi tentang semua Wilayah yang tersedia di akun Anda, termasuk format ID Wilayah.

    cn-hangzhou
    DBType

    string

    No

    Tipe mesin database. Hanya MySQL yang didukung.

    MySQL
    DBVersion

    string

    No

    Versi mesin database. Nilai valid:

    • 5.6

    • 5.7

    • 8.0.

    8.0
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-************

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    944CED46-A6F7-40C6-B6DC-C6E5CC******
    ParameterGroups

    array<object>

    The list of parameter templates.

    object

    DBType

    string

    The type of the database engine.

    MySQL
    DBVersion

    string

    The version of the database engine.

    8.0
    ParameterGroupName

    string

    The name of the parameter template.

    test
    ForceRestart

    string

    Indicates whether a cluster restart is required for the parameter template to take effect. Valid values:

    • 0: A restart is not required.

    • 1: A restart is required.

    1
    ParameterGroupType

    string

    The type of the parameter template. Valid values:

    • 0: system default template

    • 1: user-defined template

    • 2: automatic backup template (The system automatically backs up the previous parameter settings as a template after you apply a new template.)

    1
    ParameterCounts

    integer

    The number of parameters in the parameter template.

    2
    ParameterGroupDesc

    string

    The description of the parameter template.

    testgroup
    CreateTime

    string

    The time when the parameter template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2023-03-10T08:40:39Z
    ParameterGroupId

    string

    The ID of the parameter template.

    pcpg-**************

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "944CED46-A6F7-40C6-B6DC-C6E5CC******",
  "ParameterGroups": [
    {
      "DBType": "MySQL",
      "DBVersion": "8.0",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterCounts": 2,
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterGroupId": "pcpg-**************"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidRegionId.Malformed The specified parameter RegionId is not valid.
    400 InvalidEngine.Unsupported The specified Engine does not support this feature.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.