すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeParameterGroup

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeParameterGroup

    最終更新日:Mar 30, 2026

    パラメータテンプレートの基本情報を照会します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョンの ID です。

    cn-beijing
    ParameterGroupId

    string

    必須

    パラメータテンプレートの ID です。

    rpg-sys-00*****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ

    RequestId

    string

    リクエスト ID です。

    A501A191-BD70-5E50-98A9-C2A486A82****
    ParameterGroup

    object

    パラメータテンプレートの情報です。

    EngineVersion

    string

    互換エンジンバージョンです。

    5.0
    Modified

    string

    パラメータテンプレートが最後に更新された時刻です。

    2023-04-18 16:32:45
    ParameterGroupName

    string

    パラメータテンプレートの名前です。

    testGroupName
    ParameterGroupDesc

    string

    パラメータテンプレートの説明です。

    test
    Engine

    string

    エンジンタイプです。有効な値は以下のとおりです。

    • redis: Redis または Tair DRAM ベースのインスタンス

    • tair_pena: Tair 永続メモリ最適化インスタンス

    • tair_pdb: Tair ESSD ベースのインスタンス

    redis
    ParamGroupId

    string

    パラメータテンプレートの ID で、グローバルに一意です。

    sys-001*****
    Created

    string

    パラメータテンプレートが作成された時刻です。

    2023-04-18 16:32:45
    Category

    integer

    サービスのカテゴリ。有効な値は以下のとおりです。

    • 0: Redis Open-Source Edition

    • 1: Tair (Enterprise Edition)

    1
    ParamGroupsDetails

    array<object>

    パラメータテンプレートのパラメーター詳細です。

    object

    ParamName

    string

    パラメーターの名前です。

    timeout
    ParamValue

    string

    パラメーターの値です。

    1000

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "ParameterGroup": {
    "EngineVersion": "5.0",
    "Modified": "2023-04-18 16:32:45",
    "ParameterGroupName": "testGroupName",
    "ParameterGroupDesc": "test",
    "Engine": "redis",
    "ParamGroupId": "sys-001*****",
    "Created": "2023-04-18 16:32:45",
    "Category": 1,
    "ParamGroupsDetails": [
      {
        "ParamName": "timeout",
        "ParamValue": "1000"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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