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

Tair (Redis OSS-compatible) クラスターインスタンスのノードの構成情報 (仕様や最大接続数など) を照会します。

操作説明

説明

この API オペレーションは、クラウドディスクとクラスタアーキテクチャを使用する Tair (Redis OSS-compatible) インスタンスにのみ適用されます。

今すぐお試しください

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

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	Tair (Redis OSS-compatible) インスタンスの ID。インスタンス ID を照会するには、DescribeInstances オペレーションを呼び出します。	r-bp1zxszhcgatnx****
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	各ページで返されるエントリの数。有効な値: 30、50、100。デフォルト値: 30。	30

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	2D9F3768-EDA9-4811-943E-42C8006E****
ClusterChildren	array<object>	クラスターインスタンス内のデータノードに関する詳細。
	object
Capacity	integer	データノードあたりの最大メモリ容量。単位: MB。説明このパラメーターは、Service の戻り値が redis (データノードを示す) の場合にのみ返されます。	1024
UserId	string	ユーザーの ID。	2**_176498472570**
DiskSizeMB	integer	データノードが使用するenhanced SSD (ESSD) のストレージ容量。単位: MB。説明 ESSD は、Persistent Memory (PMEM) などのシステム運用データを保存するためにのみ使用されます。データ書き込みおよび読み取りの媒体としては使用されません。	4096
BandWidth	integer	ノードの最大帯域幅。単位: MB/秒。説明このパラメーターは、Service の戻り値が redis (データノードを示す) の場合にのみ返されます。	96
CurrentBandWidth	integer	データノードの現在の帯域幅。デフォルト帯域幅と購入された追加帯域幅の合計です。単位: Mbit/秒。	100
ClassCode	string	データノードの仕様。詳細については、「クラウドディスクを使用する Community Edition インスタンス」をご参照ください。	redis.shard.small.ce
BizType	string	ワークロードのタイプ。戻り値は ALIYUN です。	ALIYUN
Service	string	ノードタイプ。有効な値: redis: データノード redis_cs: config server	redis
BinlogRetentionDays	integer	binlog の保持期間。	7
Connections	integer	データノードがサポートする最大接続数。	20000
ResourceGroupName	string	ノードが属するリソースグループの名前。	GLOBAL_ZHANGJIAKOU_A
ServiceVersion	string	ノードのメジャーバージョン。	5.0
ReplicaSize	integer	レプリカノードの数。	0
Name	string	データノードの名前。	r-bp1zxszhcgatnx****-db-0
Id	integer	ノード内のレプリカセットの ID。	501791111

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D9F3768-EDA9-4811-943E-42C8006E****",
  "ClusterChildren": [
    {
      "Capacity": 1024,
      "UserId": "2****_176498472570****",
      "DiskSizeMB": 4096,
      "BandWidth": 96,
      "CurrentBandWidth": 100,
      "ClassCode": "redis.shard.small.ce",
      "BizType": "ALIYUN",
      "Service": "redis",
      "BinlogRetentionDays": 7,
      "Connections": 20000,
      "ResourceGroupName": "GLOBAL_ZHANGJIAKOU_A",
      "ServiceVersion": "5.0",
      "ReplicaSize": 0,
      "Name": "r-bp1zxszhcgatnx****-db-0",
      "Id": 501791111
    }
  ]
}

エラーコード

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

変更履歴

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