All Products
Search

This Product

    PolarDB:DescribeParameterGroup

    Document Center

    PolarDB:DescribeParameterGroup

    Last Updated:Jun 10, 2026

    Mengambil detail templat parameter yang ditentukan.

    Deskripsi operasi

    Templat parameter memungkinkan Anda mengelola parameter untuk beberapa cluster secara terpusat. Anda dapat dengan cepat menerapkan templat parameter ke cluster PolarDB. Untuk informasi lebih lanjut, lihat Menggunakan templat parameter.

    Catatan

    Saat ini fitur ini hanya mendukung cluster PolarDB for MySQL.

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

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID region.

    Catatan

    Anda dapat memanggil operasi DescribeRegions untuk menanyakan semua region yang tersedia beserta ID-nya di akun Anda.

    cn-hangzhou
    DBType

    string

    No

    Jenis mesin basis data. Nilai yang valid:

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    ParameterGroupId

    string

    Yes

    ID grup parameter.

    Catatan

    Anda dapat memanggil operasi DescribeParameterGroups untuk menanyakan detail semua grup parameter di region yang ditentukan.

    pcpg-**************
    ResourceGroupId

    string

    No

    ID grup sumber daya.

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

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Body respons.

    RequestId

    string

    ID permintaan.

    F1F16757-D31B-49CA-9BF4-305BAF******
    ParameterGroup

    array<object>

    Daftar templat parameter.

    array<object>

    ParameterDetail

    array<object>

    Daftar parameter.

    object

    ParamValue

    string

    The value of the parameter.

    3000
    ParamName

    string

    The name of the parameter.

    back_log
    DBVersion

    string

    Versi mesin basis data.

    8.0
    ParameterGroupId

    string

    ID templat parameter.

    pcpg-**************
    ParameterGroupName

    string

    Nama templat parameter.

    test
    ForceRestart

    string

    Menentukan apakah cluster perlu di-restart agar templat parameter berlaku. Nilai yang valid:

    • 0: Tidak perlu restart.

    • 1: Perlu restart.

    1
    ParameterGroupType

    string

    Jenis templat parameter. Nilai yang valid:

    • 0: templat default

    • 1: templat kustom

    • 2: templat cadangan otomatis. Jenis templat ini merupakan cadangan otomatis dari pengaturan sebelumnya, dibuat ketika Anda menerapkan templat baru.

    1
    ParameterGroupDesc

    string

    Deskripsi templat parameter.

    testgroup
    CreateTime

    string

    Waktu pembuatan templat parameter, dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).

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

    integer

    Jumlah parameter dalam templat parameter.

    2
    DBType

    string

    Jenis mesin basis data.

    MySQL

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "F1F16757-D31B-49CA-9BF4-305BAF******",
  "ParameterGroup": [
    {
      "ParameterDetail": [
        {
          "ParamValue": "3000",
          "ParamName": "back_log"
        }
      ],
      "DBVersion": "8.0",
      "ParameterGroupId": "pcpg-**************",
      "ParameterGroupName": "test",
      "ForceRestart": "1",
      "ParameterGroupType": "1",
      "ParameterGroupDesc": "testgroup",
      "CreateTime": "2023-03-10T08:40:39Z",
      "ParameterCounts": 2,
      "DBType": "MySQL"
    }
  ]
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidRegionId.Malformed The specified parameter RegionId is not valid.
    400 InvalidParameterGroupId.Malformed The Specified parameter ParameterGroupId is not valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.