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

Tair (Redis OSS-compatible) インスタンスがサポートする、異なるアーキテクチャとメジャーバージョンのパラメーターおよびそのデフォルト値をクエリします。

操作説明

この操作を呼び出してインスタンスのパラメーターとデフォルト値をクエリした後、ModifyInstanceConfig 操作を呼び出してインスタンスのパラメーターを再設定できます。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CharacterType	string	必須	インスタンスのアーキテクチャ。詳細については、「概要」をご参照ください。有効な値： logic：インスタンスはクラスターマスターレプリカインスタンスまたは読み書き分離インスタンスです。 normal：インスタンスは標準マスターレプリカインスタンスです。	logic
Engine	string	必須	インスタンスで実行されるデータベースエンジン。値を Redis に設定します。	Redis
EngineVersion	string	必須	インスタンスのメジャーバージョン。有効な値：4.0、5.0、6.0、および 7.0。	5.0
ResourceGroupId	string	任意	インスタンスが属するリソースグループの ID。ListResourceGroups 操作を呼び出して、リソースグループの ID をクエリできます。説明 Resource Management コンソールでリソースグループの ID をクエリすることもできます。詳細については、「リソースグループの基本情報の表示」をご参照ください。	rg-acfmyiu4ekp****
InstanceId	string	任意	インスタンスの ID。DescribeInstances 操作を呼び出して、インスタンスの ID をクエリできます。	r-bp1zxszhcgatnx****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	9DA28D8E-514D-4F12-ADED-70A9C818****
Engine	string	インスタンスで実行されるデータベースエンジン。このパラメーターには Redis の値が返されます。	redis
EngineVersion	string	インスタンスのメジャーバージョン。	5.0
ParameterCount	string	インスタンスがサポートするパラメーターの数。	24
Parameters	object
TemplateRecord	array<object>	返されたパラメーターの詳細で構成される配列。
	object
CheckingCode	string	パラメーターの有効な値。	[yes\|no]
ParameterName	string	パラメーターの名前。パラメーターとパラメーター設定の詳細については、「パラメーター」をご参照ください。	appendonly
ParameterValue	string	パラメーターのデフォルト値。	yes
ForceModify	boolean	パラメーターを再設定できるかどうかを示します。有効な値： true：パラメーターを再設定できます。 false：パラメーターを再設定できません。	true
ForceRestart	boolean	パラメーターの再設定後にインスタンスの再起動が必要かどうかを示します。有効な値： true：パラメーターの再設定後、新しいパラメーター値を有効にするにはインスタンスを再起動する必要があります。 false：パラメーターの再設定後、新しいパラメーター値はすぐに有効になります。インスタンスを再起動する必要はありません。	true
ParameterDescription	string	パラメーターの説明。	开启aof持久化模式

例

成功レスポンス

JSONJSON

{
  "RequestId": "9DA28D8E-514D-4F12-ADED-70A9C818****",
  "Engine": "redis",
  "EngineVersion": "5.0",
  "ParameterCount": "24",
  "Parameters": {
    "TemplateRecord": [
      {
        "CheckingCode": "[yes|no]",
        "ParameterName": "appendonly",
        "ParameterValue": "yes",
        "ForceModify": true,
        "ForceRestart": true,
        "ParameterDescription": "开启aof持久化模式"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameters.Format	Specified parameters is not valid.
403	ParamNotSupportedForCurrentVersion	Parameter is not supported for current version.

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

変更履歴

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