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

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:DescribeRoleZoneInfo

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。インスタンス ID を照会するには、DescribeInstances 操作を呼び出します。	r-t4nlenc2p04uvb****
QueryType	integer	任意	照会するノードのタイプ。デフォルト値: 1。有効な値: 0: プロキシノード ** 注このパラメーターは、クラスターインスタンスおよび読み書き分離インスタンスでのみサポートされています。 1: データノード	0
PageNumber	integer	任意	ページ番号。値は 0 より大きく、整数データ型でサポートされる最大値以下の整数である必要があります。デフォルト値: 1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 10、20、50。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	224B97FB-A275-4EAC-86E9-8922FEA2****
PageNumber	integer	返されたページ番号。	1
PageSize	integer	1 ページあたりに返されるエントリ数。	10
TotalCount	integer	返されたエントリの合計数。	2
Node	object
NodeInfo	array<object>	インスタンス内の各ノードに関する詳細。
	object
DefaultBandWidth	integer	ノードのデフォルト帯域幅。単位: MB/秒。	96
CurrentMinorVersion	string	ノードのマイナーバージョン。	redis-5.0_0.3.10
CurrentBandWidth	integer	ノードの現在の帯域幅。デフォルト帯域幅と増加帯域幅で構成されます。単位: MB/秒。説明増加帯域幅を指定するには、EnableAdditionalBandwidth 操作を呼び出します。このパラメーターを使用して、増加帯域幅を計算することもできます。たとえば、ノードのデフォルト帯域幅が 96 MB/秒で、このパラメーターの戻り値が 100 の場合、増加帯域幅は 4 MB/秒です。	100
InsType	integer	ノードが読み取り専用レプリカであるかどうかを示します。ノードが読み取り専用レプリカの場合、3 が返されます。説明ノードが読み取り専用レプリカでない場合、値は返されません。	3
IsLatestVersion	integer	マイナーバージョンが最新バージョンであるかどうかを示します。有効な値: 0: マイナーバージョンは最新バージョンではありません。 1: マイナーバージョンは最新バージョンです。説明マイナーバージョンを更新するには、ModifyInstanceMinorVersion 操作を呼び出します。	1
InsName	string	ノードの ID。	r-t4nlenc2p04uvb****
NodeType	string	ノードタイプ。有効な値: db: データノード。 proxy: プロキシノード。 normal: 通常ノード。インスタンスが標準アーキテクチャで実行されている場合に、この値が返されます。	normal
ZoneId	string	ゾーンの ID。	cn-hangzhou-b
IsOpenBandWidthService	boolean	ノードの帯域幅が増加しているかどうかを示します。有効な値: true: ノードの帯域幅は増加していません。 false: ノードの帯域幅は増加しています。	true
CustinsId	string	データシャードの ID。	30381****
Role	string	ノードのロール。有効な値: master: マスターノード slave: レプリカノード	master
NodeId	string	このパラメーターは、インスタンスの内部メンテナンスにのみ使用されます。	10065****

例

成功レスポンス

JSONJSON

{
  "RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Node": {
    "NodeInfo": [
      {
        "DefaultBandWidth": 96,
        "CurrentMinorVersion": "redis-5.0_0.3.10",
        "CurrentBandWidth": 100,
        "InsType": 3,
        "IsLatestVersion": 1,
        "InsName": "r-t4nlenc2p04uvb****",
        "NodeType": "normal",
        "ZoneId": "cn-hangzhou-b",
        "IsOpenBandWidthService": true,
        "CustinsId": "30381****",
        "Role": "master",
        "NodeId": "10065****"
      }
    ]
  }
}

エラーコード

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

変更履歴

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