Kueri nilai valid dan nilai default parameter - - Alibaba Cloud Documentation Center

Anda dapat memanggil operasi DescribeParameterTemplates untuk mengkueri nilai valid dan nilai default parameter suatu instans.

Sebelum memanggil operasi ini, pastikan instans menggunakan salah satu engine database berikut:

MySQL 5.5, MySQL 5.6, MySQL 5.7, atau MySQL 8.0
SQL Server 2008 R2
PostgreSQL 10, PostgreSQL 11, PostgreSQL 12, PostgreSQL 13, PostgreSQL 14, atau PostgreSQL 15
MariaDB 10.3

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan memanggil operasi ini di OpenAPI Explorer, yang secara dinamis menghasilkan contoh kode untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeParameterTemplates	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeParameterTemplates.
ClientToken	String	No	ETnLKlblzczshOTUbOCz****	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan nilai tersebut, tetapi Anda harus memastikan bahwa token yang dihasilkan unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII dan tidak boleh melebihi panjang 64 karakter.
Engine	String	Yes	mysql	Engine database instans. Nilai valid: mysql: MySQL mssql: SQL Server PostgreSQL: PostgreSQL MariaDB: MariaDB
EngineVersion	String	Yes	8.0	Versi engine database instans. Nilai valid saat Anda menetapkan parameter Engine ke mysql: 5.5, 5.6, 5.7, dan 8.0. Nilai valid saat Anda menetapkan parameter Engine ke mssql: 2008r2. Nilai valid saat Anda menetapkan parameter Engine ke PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, dan 15.0. Nilai valid saat Anda menetapkan parameter Engine ke MariaDB: 10.3.
Category	String	No	Basic	Edisi RDS instans. Nilai valid: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition Finance: RDS Enterprise Edition
RegionId	String	No	cn-hangzhou	ID wilayah instans. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.
DBInstanceId	String	Yes	rm-bp1imnm****	ID instans.

Parameter respons

Parameter	Type	Example	Description
RequestId	String	0F9B7410-EC73-510C-B385-8339455C12C6	ID permintaan.
Engine	String	mysql	Engine database instans.
ParameterCount	String	2	Jumlah parameter.
EngineVersion	String	8.0	Versi engine database instans.
Parameters	Array of TemplateRecord		Array yang berisi detail parameter.
TemplateRecord
CheckingCode	String	[0-1024]	Nilai valid parameter.
ParameterName	String	loose_multi_blocks_ddl_count	Nama parameter.
ParameterValue	String	0	Nilai default parameter.
ForceModify	String	true	Menunjukkan apakah parameter dapat dikonfigurasi ulang. Nilai valid: true: Parameter dapat dikonfigurasi ulang. false: Parameter tidak dapat dikonfigurasi ulang.
ForceRestart	String	false	Menunjukkan apakah Anda harus melakukan restart instans agar modifikasi berlaku. Nilai valid: true: Anda harus melakukan restart instans agar modifikasi berlaku. false: Anda tidak perlu melakukan restart instans agar modifikasi berlaku.
ParameterDescription	String	Page numbers of multi blocks reading once in some ddl query.	Deskripsi parameter.

Contoh

Contoh permintaan

http(s)://rds.aliyuncs.com/?Action=DescribeParameterTemplates
&ClientToken=ETnLKlblzczshOTUbOCz****
&Engine=mysql
&EngineVersion=8.0
&Category=Basic
&RegionId=cn-hangzhou
&DBInstanceId=rm-bp1imnm****
&Common request parameters

Contoh respons sukses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterTemplatesResponse>
    <ParameterCount>2</ParameterCount>
    <EngineVersion>8.0</EngineVersion>
    <Parameters>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[OFF|ON]</CheckingCode>
            <ParameterValue>OFF</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_recycle_scheduler</ParameterName>
            <ParameterDescription>Switch of purge thread.</ParameterDescription>
        </TemplateRecord>
        <TemplateRecord>
            <ForceModify>true</ForceModify>
            <CheckingCode>[0-1024]</CheckingCode>
            <ParameterValue>0</ParameterValue>
            <ForceRestart>false</ForceRestart>
            <ParameterName>loose_multi_blocks_ddl_count</ParameterName>
            <ParameterDescription>Page numbers of multi blocks reading once in some ddl query.</ParameterDescription>
        </TemplateRecord>
    </Parameters>
    <RequestId>0F9B7410-EC73-510C-B385-8339455C12C6</RequestId>
    <Engine>mysql</Engine>
</DescribeParameterTemplatesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ParameterCount" : 2,
  "EngineVersion" : "8.0",
  "Parameters" : {
    "TemplateRecord" : [ {
      "ForceModify" : "true",
      "CheckingCode" : "[OFF|ON]",
      "ParameterValue" : "OFF",
      "ForceRestart" : "false",
      "ParameterName" : "loose_recycle_scheduler",
      "ParameterDescription" : "Switch of purge thread."
    }, {
      "ForceModify" : "true",
      "CheckingCode" : "[0-1024]",
      "ParameterValue" : "0",
      "ForceRestart" : "false",
      "ParameterName" : "loose_multi_blocks_ddl_count",
      "ParameterDescription" : "Page numbers of multi blocks reading once in some ddl query."
    } ]
  },
  "RequestId" : "0F9B7410-EC73-510C-B385-8339455C12C6",
  "Engine" : "mysql"
}

Kode kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
400	Invalid.ParamGroupDBCategory	Invalid parameter group category	Pesan kesalahan yang dikembalikan karena kategori grup parameter tidak valid.

Untuk daftar kode kesalahan, lihat Service error codes.