すべてのプロダクト
Search

このプロダクト

    :DescribeDBClusterParameters

    ドキュメントセンター

    :DescribeDBClusterParameters

    最終更新日:Dec 11, 2025

    PolarDB クラスターで実行中のパラメーターのリストを照会します。

    今すぐお試しください

    この 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:DescribeDBClusterParameters

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    pc-**********
    DescribeType

    string

    任意

    カーネルパラメーター。有効値：

    • Normal：カーネルパラメーターのリスト。

    • MigrationFromRDS：ApsaraDB RDS インスタンスのパラメーターと比較します。

    Normal

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RunningParameters

    object

    Parameter

    array<object>

    PolarDB クラスターで現在実行中のパラメーターのリスト。

    object

    CheckingCode

    string

    パラメーターの有効値の範囲。

    [utf8|latin1|gbk|utf8mb4]
    DataType

    string

    パラメーター値のデータの型。有効値：

    • INT：整数。

    • STRING：文字列。

    • B：バイト。

    INT
    ParameterName

    string

    パラメーター名。

    character_set_server
    ParameterValue

    string

    パラメーター値。

    utf8
    ForceRestart

    boolean

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

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

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

    true
    ParameterDescription

    string

    パラメーターの説明。

    The server's default character set.
    ParameterStatus

    string

    パラメーターのステータス。有効値：

    • Normal：パラメーターは正常な状態です。

    • Modifying：パラメーターは変更中です。

    Normal
    DefaultParameterValue

    string

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

    utf8
    IsModifiable

    boolean

    パラメーターが変更可能かどうかを示します。有効値：

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

    • true：パラメーターは変更できます。

    true
    IsNodeAvailable

    string

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

    • 0：パラメーターはグローバルパラメーターです。パラメーターを変更すると、その新しい値はデフォルトで他のノードに同期されます。

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

    0
    ParamRelyRule

    string

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

    utf8
    Factor

    string

    除数。整数およびバイト型のパラメーターの場合、パラメーター値は Factor (0 以外) の倍数であり、かつ有効値の範囲内である必要があります。

    20
    DBVersion

    string

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

    • 5.6

    • 5.7

    • 8.0

    PostgreSQL の有効値：

    • 11

    • 14

    Oracle の有効値：

    • 11

    • 14

    5.6
    RequestId

    string

    リクエスト ID。

    EBEAA83D-1734-42E3-85E3-E25F6E******
    DBType

    string

    データベースタイプ。有効値：

    • MySQL

    • PostgreSQL

    • Oracle

    MySQL
    Engine

    string

    エンジン。

    POLARDB
    DBClusterId

    string

    クラスター ID。

    pc-bp1s826a1up******

    ParameterNumbers

    string

    パラメーターの数。

    1
    Parameters

    object

    Parameters

    array<object>

    ApsaraDB RDS から PolarDB へのインスタンス移行におけるパラメーター比較結果のリスト。

    object

    rdsParameterName

    string

    ソースインスタンスのパラメーター名。

    character_set_server
    rdsParameterValue

    string

    ソースインスタンスのパラメーター値。

    utf8
    rdsParameterOptional

    string

    ソースインスタンスのパラメーターの有効値。

    - utf8 - gbk
    distParameterName

    string

    クラスターパラメーターの名前。

    character_set_server
    distParameterValue

    string

    クラスターパラメーターの値。

    utf8
    distParameterOptional

    string

    クラスターパラメーターの有効値。

    - utf8 - gbk
    IsEqual

    string

    パラメーター値が同じかどうかを示します。

    true
    distParameterDescription

    string

    クラスターパラメーターの説明。

    The server's default character set.
    rdsParameterDescription

    string

    ソースインスタンスのパラメーターの説明。

    The server's default character set.
    IsRdsKey

    string

    パラメーターがソースインスタンスのキーパラメーターであるかどうかを示します。有効値：

    • 1：パラメーターはソースインスタンスのキーパラメーターです。

    • 0：パラメーターはソースインスタンスのキーパラメーターではありません。

    1
    IsPolarDBKey

    string

    パラメーターが宛先インスタンスのキーパラメーターであるかどうかを示します。

    • 1：パラメーターは宛先インスタンスのキーパラメーターです。

    • 0：パラメーターは宛先インスタンスのキーパラメーターではありません。

    0
    IsInstancePolarDBKey

    string

    パラメーターが宛先インスタンスのキーパラメーターであるかどうかを示します。

    • 1：パラメーターは宛先インスタンスのキーパラメーターです。

    • 0：パラメーターは宛先インスタンスのキーパラメーターではありません。

    1
    IsInstanceRdsKey

    string

    パラメーターがソースインスタンスのキーパラメーターであるかどうかを示します。

    • 1：パラメーターはソースインスタンスのキーパラメーターです。

    • 0：パラメーターはソースインスタンスのキーパラメーターではありません。

    0

    例

    成功レスポンス

    JSONJSON

    {
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[utf8|latin1|gbk|utf8mb4]",
        "DataType": "INT",
        "ParameterName": "character_set_server",
        "ParameterValue": "utf8",
        "ForceRestart": true,
        "ParameterDescription": "The server's default character set.",
        "ParameterStatus": "Normal",
        "DefaultParameterValue": "utf8",
        "IsModifiable": true,
        "IsNodeAvailable": "0",
        "ParamRelyRule": "utf8",
        "Factor": "20"
      }
    ]
  },
  "DBVersion": "5.6",
  "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******",
  "DBType": "MySQL",
  "Engine": "POLARDB",
  "DBClusterId": "pc-bp1s826a1up******\t\n",
  "ParameterNumbers": "1",
  "Parameters": {
    "Parameters": [
      {
        "rdsParameterName": "character_set_server",
        "rdsParameterValue": "utf8",
        "rdsParameterOptional": "- utf8\n- gbk",
        "distParameterName": "character_set_server",
        "distParameterValue": "utf8",
        "distParameterOptional": "- utf8\n- gbk",
        "IsEqual": "true",
        "distParameterDescription": "The server's default character set.",
        "rdsParameterDescription": "The server's default character set.",
        "IsRdsKey": "1",
        "IsPolarDBKey": "0",
        "IsInstancePolarDBKey": "1",
        "IsInstanceRdsKey": "0"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    403 Forbidden.RAM User not authorized to operate on the specified resource, or this API does not support RAM.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records.

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

    変更履歴

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