すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeParameters

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeParameters

    最終更新日:Mar 27, 2026

    Tair（ApsaraDB for Redis）インスタンスの構成および実行時パラメーターを照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:DescribeParameters

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    インスタンスを作成するリージョンの ID です。利用可能なリージョンを照会するには、DescribeRegions 操作を呼び出します。

    cn-hangzhou
    DBInstanceId

    string

    必須

    インスタンス ID です。

    r-bp1zxszhcgatnx****
    NodeId

    string

    任意

    ノード ID です。

    説明

    このパラメーターを使用して、クラスターインスタンス内の特定のノードの構成を照会します。

    r-bp1xxxxxxxxxxxxx-db-0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクトです。

    RequestId

    string

    リクエスト ID です。

    9C1338BE-8DE8-4890-A900-E1BC06BF****
    Engine

    string

    データベースエンジンです。

    redis
    EngineVersion

    string

    エンジンのバージョンです。

    4.0
    ConfigParameters

    object

    Parameter

    array<object>

    まだ有効になっていない構成パラメーターの一覧です。

    object

    構成パラメーターのオブジェクトです。

    CheckingCode

    string

    パラメーターに許容される値を定義する入力規則です。

    [0|1]
    ParameterName

    string

    パラメーター名です。

    script_check_enable
    ParameterValue

    string

    パラメーター値です。

    1
    ForceRestart

    boolean

    変更を有効にするために再起動が必要かどうかを示します。有効な値は以下のとおりです。

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

    • false：再起動は不要です。変更は即時に有効になります。

    true
    ParameterDescription

    string

    パラメーターの説明です。

    Check all keys passed in the KEYS array map to the same slot.
    ModifiableStatus

    boolean

    パラメーターが変更可能かどうかを示します。有効な値は以下のとおりです。

    • false：変更できません。

    • true：変更できます。

    true
    RunningParameters

    object

    Parameter

    array<object>

    現在の実行時パラメーターの一覧です。

    object

    実行時パラメーターのオブジェクトです。

    CheckingCode

    string

    パラメーターに許容される値を定義する入力規則です。

    [0|1]
    ParameterName

    string

    パラメーター名です。

    #no_loose_disabled-commands
    ParameterValue

    string

    パラメーター値です。

    keys,flushall,flushdb
    ForceRestart

    string

    変更を有効にするために再起動が必要かどうかを示します。戻り値は以下のとおりです。

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

    • False：再起動は不要です。送信後に即時に有効になります。

    true
    ParameterDescription

    string

    パラメーターの説明です。

    You can disable some dangerous commands, for example \"keys,flushdb,flushall\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].
    ModifiableStatus

    string

    パラメーターが変更可能かどうかを示します。戻り値は以下のとおりです。

    • False：変更できません。

    • True：変更できます。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "9C1338BE-8DE8-4890-A900-E1BC06BF****",
  "Engine": "redis",
  "EngineVersion": "4.0",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "script_check_enable",
        "ParameterValue": "1",
        "ForceRestart": true,
        "ParameterDescription": "Check all keys passed in the KEYS array map to the same slot.",
        "ModifiableStatus": true
      }
    ]
  },
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0|1]",
        "ParameterName": "#no_loose_disabled-commands",
        "ParameterValue": "keys,flushall,flushdb",
        "ForceRestart": "true",
        "ParameterDescription": "You can disable some dangerous commands, for example \\\"keys,flushdb,flushall\\\", the commands must be in [flushall,flushdb,keys,hgetall,eval,evalsha,script].",
        "ModifiableStatus": "true"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 IncorrectDBInstanceType Current DB instance type does not support this operation.
    404 InvalidDBInstanceClass.NotFound Specified DB instance class is not found.

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

    変更履歴

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