DescribeParameters操作を呼び出して、インスタンスのパラメーター設定を照会できます。

この操作を呼び出す前に、インスタンスが次のデータベースエンジンのいずれかを実行していることを確認してください。

  • MySQL 5.5、MySQL 5.6、MySQL 5.7、またはMySQL 8.0
  • SQL Server 2008 R2
  • PostgreSQL 10、PostgreSQL 11、PostgreSQL 12、PostgreSQL 13、PostgreSQL 14、またはPostgreSQL 15
  • MariaDB 10.3

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 DescribeParameters

実行する操作です。 値をDescribeParametersに設定します。

ClientToken String 任意 ETnLKlblzczshOTUbOCzxxxxx

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、生成されたトークンが異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

リクエストの ID です。

Engine String MySQL

インスタンスが実行されるデータベースエンジン。

EngineVersion String 5.5

インスタンスのデータベースエンジンバージョンです。

ConfigParameters DBInstanceParameterの配列

同期されているパラメーターのリスト。 パラメーター設定を変更して送信した後、パラメーターの変更がインスタンスに同期されるのを待つ必要があります。 同期後、リストからパラメータを削除できます。

DBInstanceParameter
ParameterDescription String このパラメーターは、サーバースコープでの既定のfill factor値を設定します。 フィルファクタは、インデックスデータ記憶および性能を最適化するために提供される。

パラメーターの説明。

ParameterName String fillファクター

パラメータの名前。

ParameterValue String 50

パラメータの値。

RunningParameters DBInstanceParameterの配列

使用中のパラメータのリスト。

DBInstanceParameter
ParameterDescription String このパラメーターは、サーバースコープでの既定のfill factor値を設定します。 フィルファクタは、インデックスデータ記憶および性能を最適化するために提供される。

パラメーターの説明。

ParameterName String fillファクター

パラメータの名前。

ParameterValue String 0

パラメータの値。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeParametersResponse>
<ConfigParameters>
<DBInstanceParameter>
<ParameterDescription> このパラメーターは、サーバースコープでのデフォルトのfill factor値を設定します。 フィルファクタは、インデックスデータ記憶および性能を最適化するために提供される。 </ParameterDescription>
<ParameterName>fill factor</ParameterName>
<ParameterValue>50</ParameterValue>
</DBInstanceParameter>
</ConfigParameters>
<エンジン> mssql</エンジン>
<EngineVersion>2008r2</EngineVersion>
<RunningParameters>
<DBInstanceParameter>
<ParameterDescription> このパラメーターは、サーバースコープでのデフォルトのfill factor値を設定します。 フィルファクタは、インデックスデータ記憶および性能を最適化するために提供される。 </ParameterDescription>
<ParameterName>fill factor</ParameterName>
<ParameterValue>0</ParameterValue>
</DBInstanceParameter>
</RunningParameters>
<RequestId>2A748162-8040-4D6B-813E-6910C8C033F1</RequestId>
</DescribeParametersResponse>

JSON 形式

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

{
  "ConfigParameters" : {
    "DBInstanceParameter" : [ {
      "ParameterDescription": "このパラメータは、サーバースコープでのデフォルトのフィルファクタ値を設定します。 フィルファクタは、インデックスデータ記憶および性能を最適化するために提供される。
      "ParameterName" : "fill factor" 、
      "ParameterValue" : "50"
    } ]
  },
  "エンジン" : "mssql" 、
  "EngineVersion" : "2008r2" 、
  "RunningParameters" : {
    "DBInstanceParameter" : [ {
      "ParameterDescription": "このパラメータは、サーバースコープでのデフォルトのフィルファクタ値を設定します。 フィルファクタは、インデックスデータ記憶および性能を最適化するために提供される。
      "ParameterName" : "fill factor" 、
      "ParameterValue" : "0"
    } ]
  },
  "RequestId" : "2A748162-8040-4D6B-813E-6910C8C033F1"
}

エラーコード

エラーコードの一覧については、「サービスエラーコード」をご参照ください。