すべてのプロダクト
Search

このプロダクト

    :DescribeParameterTemplates

    ドキュメントセンター

    :DescribeParameterTemplates

    最終更新日:Dec 11, 2025

    データベース クラスタのデフォルト パラメーターをクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeParameterTemplates

    get

    *DBCluster

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBType

    string

    必須

    データベース エンジン タイプ。 MySQL のみがサポートされています。

    MySQL
    DBVersion

    string

    必須

    データベースのバージョン。有効な値：

    • 5.6

    • 5.7

    • 8.0

    5.7
    RegionId

    string

    必須

    リージョン ID。

    説明

    使用可能なリージョンの ID をクエリするには、DescribeRegions 操作を呼び出します。

    cn-hangzhou
    ResourceGroupId

    string

    任意

    リソース グループ ID。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ParameterCount

    string

    パラメーターの数。

    183
    DBVersion

    string

    データベース エンジン バージョン。

    5.7
    Parameters

    object

    TemplateRecord

    array<object>

    パラメーターのリスト。

    object

    CheckingCode

    string

    パラメーターの有効な値。

    [ROW|STATEMENT|MIXED]
    ParameterName

    string

    パラメーター名。

    binlog_format
    ParameterValue

    string

    パラメーターのデフォルト値。

    ROW
    ForceModify

    string

    パラメーターを変更できるかどうかを示します。有効な値：

    • true: パラメーターは変更可能です。

    • false: パラメーターは変更できません。

    true
    ForceRestart

    string

    新しいパラメーター値を有効にするために再起動が必要かどうかを示します。有効な値：

    • true: 再起動が必要です。

    • false: 再起動は不要です。

    false
    ParameterDescription

    string

    パラメーターの説明。

    What form of binary logging the master will use.
    IsNodeAvailable

    string

    パラメーターがグローバル パラメーターかどうかを示します。有効な値：

    • 0: パラメーターはグローバル パラメーターです。変更されたパラメーター値は、デフォルトで他のノードに同期されます。

    • 1: パラメーターはグローバル パラメーターではありません。変更されたパラメーター値が同期されるノードを指定できます。

    1
    ParamRelyRule

    string

    パラメーターの依存関係。

    utf8
    RequestId

    string

    リクエスト ID。

    D963934D-8605-4473-8EAC-54C719******
    DBType

    string

    データベース エンジン タイプ。

    MySQL
    Engine

    string

    データベース エンジン。

    POLARDB

    例

    成功レスポンス

    JSONJSON

    {
  "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"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBType.NotFound The Specified DBType does not found.
    400 InvalidDBVersion.Malformed The Specified DBVersion is not valid.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。