DescribeParameterGroupTemplateList - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

パラメータテンプレートで設定可能なパラメーターの情報 (デフォルト値、有効値の範囲、説明など) を照会します。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Category	string	必須	サービスカテゴリ。有効な値: standard: Community Edition enterprise: Tair (Enterprise Edition)	standard
EngineVersion	string	必須	互換性のあるエンジンバージョン。有効な値: Community Edition インスタンスの場合、パラメーターを 5.0、6.0、または 7.0 に設定します。 Redis 5.0、6.0、または 7.0 と互換性のある Tair DRAMベースのインスタンスの場合、パラメーターを 5.0、6.0、または 7.0 に設定します。 Redis 6.0 と互換性のある Tair 永続メモリインスタンスの場合、パラメーターを 1.0 に設定します。 Redis 6.0 と互換性のある Tair ESSDベースのインスタンスの場合、パラメーターを 1.0 に設定します。Redis 6.0 と互換性のある Tair SSDベースのインスタンスの場合、パラメーターを 2.0 に設定します。	5.0
EngineType	string	必須	エンジンタイプ。有効な値: redis: Community Edition または Tair (インメモリ) tair_pena: Tair (NVM上) tair_pdb: Tair (ディスク上)	redis
CharacterType	string	任意	インスタンスのロール。有効な値: logic: 論理インスタンス。db: データベースインスタンス。proxy: プロキシノード。cs: ConfigServer ノード。normal: マスターレプリカデータベースインスタンス。	db

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID	5D622714-AEDD-4609-9167-F5DDD3D1****
EngineVersion	string	互換性のあるエンジンバージョン。有効な値: Community Edition: 5.0、6.0、および 7.0。Tair DRAMベースのインスタンス: 5.0 および 6.0。Tair 永続メモリインスタンス: 6.0。Tair ESSDベースのインスタンス: 4.0。	5
Parameters	array<object>	パラメーターに関する情報。
	object
SupportModifyForMinorVersion	boolean	マイナーバージョンが変更可能かどうかを示します。有効な値: true および false。	true
CheckingCode	string	入力の検証に使用される正規表現。	[0\|1]
ParameterValue	string	パラメーターのデフォルト値。	10
Revisable	integer	パラメーターが変更可能かどうかを示します。有効な値: 0: パラメーターは変更できません。 1: パラメーターは変更できます。	0
Factor	integer	パラメーターの除数。整数型またはバイト型のパラメーターの場合、Factor を 0 に設定しない限り、有効な値は Factor の倍数である必要があります。	1
ParameterName	string	パラメーター名。	appendonly
Unit	string	パラメーター値の単位。有効な値: INT (通常の整数)、STRING (固定文字列)、B (バイト)。	STRING
ParameterDescription	string	パラメーターの説明。	开启Aof持久化模式。
Effective	integer	変更が有効になるかどうかを示します。有効な値: 0 および 1。値が 0 の場合、変更は有効になりません。値が 1 の場合、変更は有効になります。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "EngineVersion": "5",
  "Parameters": [
    {
      "SupportModifyForMinorVersion": true,
      "CheckingCode": "[0|1]",
      "ParameterValue": "10",
      "Revisable": 0,
      "Factor": 1,
      "ParameterName": "appendonly",
      "Unit": "STRING",
      "ParameterDescription": "开启Aof持久化模式。",
      "Effective": 1
    }
  ]
}

エラーコード

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

変更履歴

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