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

ApsaraDB for Tair（Redis® OSS 互換）データベースインスタンスの論理トポロジー構造を照会します。

操作説明

この操作は、クラスターおよび読み取り/書き込み分離インスタンスでのみサポートされています。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。	r-bp1zxszhcgatnx****

レスポンスフィールド

フィールド	型	説明	例
	object
InstanceId	string	インスタンス ID。	r-bp1zxszhcgatnx****
RequestId	string	リクエスト ID。	794120D1-E0CF-4713-BAE4-EBAEA04506AF
RedisProxyList	object
NodeInfo	array<object>	プロキシノード情報を含むプロキシの詳細。
	object
Capacity	string	ノードの容量。単位: MB。	5120
Connection	string	接続数の最大値。	320000
NodeType	string	ノードタイプ。有効な値: db: データノード。 normal: 管理ノード。プロキシノードと CS（設定サーバー）ノードで構成されます。一部のインスタンスでは normal ではなく、proxy と cs が個別に返されます。	proxy
Bandwidth	string	ノードの帯域幅制限。単位: MB/s。	96
NodeId	string	ノード ID。	r-bp10noxlhcoim2**-proxy-3#542**
RedisShardList	object
NodeInfo	array<object>	NodeInfo などの子ノード情報を含むシャードの詳細。
	object
Capacity	string	ノードの容量。単位: MB。	2048
Connection	string	接続数の最大値。	10000
NodeType	string	ノードタイプ。有効な値: proxy: プロキシノード。 db: データノード。	db
Bandwidth	string	ノードの帯域幅制限。単位: MB/s。	96
NodeId	string	ノード ID。	r-bp10noxlhcoim2**-db-0#688**
SubInstanceType	string	サブインスタンスタイプ。有効な値: master: プライマリノード。 readonly: 読み取り専用インスタンス。	master

例

成功レスポンス

JSONJSON

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
  "RedisProxyList": {
    "NodeInfo": [
      {
        "Capacity": "5120",
        "Connection": "320000",
        "NodeType": "proxy",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-proxy-3#542****"
      }
    ]
  },
  "RedisShardList": {
    "NodeInfo": [
      {
        "Capacity": "2048",
        "Connection": "10000",
        "NodeType": "db",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-db-0#688****",
        "SubInstanceType": "master"
      }
    ]
  }
}

エラーコード

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

変更履歴

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