すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeDedicatedClusterInstanceList

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeDedicatedClusterInstanceList

    最終更新日:Mar 30, 2026

    専用クラスターにデプロイされた Tair (Redis OSS-compatible) インスタンスの情報を照会します。

    操作説明

    説明

    専用クラスターにデプロイされていない Tair (Redis OSS-compatible) インスタンスの情報を照会する場合は、DescribeInstanceAttribute 操作を呼び出してください。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    インスタンスのリージョン ID。最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出してください。

    cn-hangzhou
    ZoneId

    string

    任意

    インスタンスのゾーン ID。最新のゾーン一覧を照会するには、DescribeZones 操作を呼び出してください。

    cn-hangzhou-e
    InstanceId

    string

    任意

    インスタンス ID。

    説明

    このインスタンスは専用クラスターを使用して作成されている必要があります。詳細については、「ApsaraDB for MyBase とは」をご参照ください。

    r-bp1zxszhcgatnx****
    InstanceStatus

    integer

    任意

    インスタンスの状態。有効な値は以下のとおりです。

    • 0: インスタンスは作成中です。

    • 1: インスタンスは実行中です。

    • 3: インスタンスは削除中です。

    • 5: インスタンスの構成が変更中です。

    • 6: インスタンスは移行中です。

    • 7: インスタンスはバックアップからの復元中です。

    • 8: マスターレプリカ間のスイッチオーバーが進行中です。

    • 9: インスタンスの期限切れデータが削除中です。

    1
    InstanceNetType

    string

    任意

    インスタンスのネットワークタイプ。有効な値は以下のとおりです。

    • 0: インターネット

    • 1: クラシックネットワーク

    • 2: Virtual Private Cloud (VPC)

    2
    Engine

    string

    任意

    インスタンスのデータベースエンジン。値は Redis を指定します。

    Redis
    EngineVersion

    string

    任意

    インスタンスのデータベースエンジンバージョン。値は 5.0 を指定します。

    5.0
    ClusterId

    string

    任意

    専用クラスター ID。専用クラスター ID は、ApsaraDB for MyBase コンソールの「専用クラスター」ページで確認できます。

    説明

    複数の ID をカンマ (,) で区切ります。

    dhg-5f2v98840ioq****
    DedicatedHostName

    string

    任意

    専用クラスター内のホスト ID。ホスト ID を照会するには、DescribeDedicatedHosts 操作を呼び出してください。

    説明

    複数の ID をカンマ (,) で区切ります。

    ch-t4n664a9mal4c****
    PageNumber

    integer

    任意

    返されるページ番号。値は 0 より大きい整数である必要があります。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    1 ページあたりに返されるエントリ数。有効な値は 30、50、100 です。デフォルト値は 30 です。

    30

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageNumber

    integer

    返されたページのページ番号。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    25
    RequestId

    string

    リクエスト ID。

    712CCF2A-16BD-411B-93F7-E978BEF2****
    TotalCount

    integer

    返されたエントリの合計数。

    0
    Instances

    array<object>

    インスタンスの詳細情報。

    array<object>

    インスタンスの詳細情報。

    VpcId

    string

    VPC ID。

    vpc-t4n2clc70t3hqwsrr****
    CharacterType

    string

    インスタンスのアーキテクチャ。有効な値は以下のとおりです。

    • logic: クラスター

    • normal: 標準

    logic
    VswitchId

    string

    vSwitch ID。

    vsw-t4nvrca24dczppq44****
    InstanceClass

    string

    インスタンスタイプ。

    redis.cluster.sharding.common.ce
    MaintainStartTime

    string

    メンテナンスウィンドウの開始時刻。形式は HH:mmZ です。表示は協定世界時 (UTC) で行われます。

    16:00Z
    CreateTime

    string

    インスタンスの作成時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。表示は協定世界時 (UTC) で行われます。

    2021-05-06T07:09:40Z
    ConnectionDomain

    string

    インスタンスのプライベートエンドポイント。

    r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com
    MaintainEndTime

    string

    メンテナンスウィンドウの終了時刻。形式は HH:mmZ です。表示は協定世界時 (UTC) で行われます。

    17:00Z
    StorageType

    string

    インスタンスのストレージタイプ。戻り値は enhanced SSDs (ESSDs) を示す LOCAL_SSD です。

    LOCAL_SSD
    InstanceId

    string

    インスタンス ID。

    r-bp1e7vl6ygf1yq****
    BandWidth

    integer

    インスタンスのデフォルト帯域幅。単位：Mbit/s。

    24
    CurrentBandWidth

    integer

    インスタンスの現在の帯域幅（デフォルト帯域幅と追加購入した帯域幅の合計）。単位：Mbit/s。

    50
    EngineVersion

    string

    インスタンスのデータベースエンジンバージョン。戻り値は 5.0 です。

    5.0
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    InstanceName

    string

    インスタンス名。

    testdb
    ZoneId

    string

    ゾーン ID。

    cn-hangzhou-e
    ClusterName

    string

    インスタンスが属する専用クラスターの名前。

    testname
    InstanceStatus

    string

    インスタンスの状態。有効な値は以下のとおりです。

    • Normal: インスタンスは正常です。

    • Creating: インスタンスは作成中です。

    • Changing: インスタンスの構成が変更中です。

    • Inactive: インスタンスは無効化されています。

    • Flushing: インスタンスは解放中です。

    • Released: インスタンスは解放済みです。

    • Transforming: インスタンスの課金方法が変更中です。

    • Unavailable: インスタンスは利用できません。

    • Error: インスタンスの作成に失敗しました。

    • Migrating: インスタンスは移行中です。

    • BackupRecovering: インスタンスはバックアップからの復元中です。

    • MinorVersionUpgrading: インスタンスのマイナーバージョンが更新中です。

    • NetworkModifying: インスタンスのネットワークタイプが変更中です。

    • SSLModifying: インスタンスの SSL 構成が変更中です。

    • MajorVersionUpgrading: インスタンスのメジャーバージョンがアップグレード中です。アップグレード中もインスタンスへのアクセスは可能です。

    Normal
    Engine

    string

    データベースエンジン。戻り値は redis です。

    redis
    ShardCount

    integer

    シャード数。

    説明

    このパラメーターは、インスタンスがクラスターインスタンスの場合のみ返されます。

    3
    CustomId

    string

    インスタンスの保守および管理に使用される内部パラメーター。

    4652****
    ProxyCount

    integer

    プロキシノード数。

    説明

    • 戻り値が 0 の場合、インスタンスのプロキシモードは無効です。戻り値が 0 より大きい整数（例：1）の場合、インスタンスのプロキシモードは有効です。

    • このパラメーターは、インスタンスがクラスターインスタンスの場合のみ返されます。

    1
    ClusterId

    string

    インスタンスが属する専用クラスター ID。

    dhg-rx71fc5ndh9o****
    InstanceNodeList

    array<object>

    ノードの詳細情報。

    object

    ノードの詳細情報。

    NodeIp

    string

    ノードの IP アドレス。

    10.0.33.***
    DedicatedHostName

    string

    専用クラスター内のホスト ID。

    ch-bp13vf0y9gx3c****
    NodeType

    string

    ノードタイプ。有効な値は以下のとおりです。

    • db: データノード

    • proxy: プロキシノード

    • normal: 通常ノード。この値は、インスタンスが標準アーキテクチャで実行されている場合に返されます。

    normal
    ZoneId

    string

    ノードのゾーン ID。

    cn-hangzhou-h
    InstanceId

    string

    インスタンス ID。

    r-bp1e7vl6ygf1yq****
    Port

    integer

    ノードへの接続に使用されるポート番号。

    3001
    Role

    string

    ノードのロール。有効な値は以下のとおりです。

    • master: マスターノード

    • slave: レプリカノード

    master
    NodeId

    integer

    ノード ID。

    17921111

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "PageSize": 25,
  "RequestId": "712CCF2A-16BD-411B-93F7-E978BEF2****",
  "TotalCount": 0,
  "Instances": [
    {
      "VpcId": "vpc-t4n2clc70t3hqwsrr****",
      "CharacterType": "logic",
      "VswitchId": "vsw-t4nvrca24dczppq44****",
      "InstanceClass": "redis.cluster.sharding.common.ce",
      "MaintainStartTime": "16:00Z",
      "CreateTime": "2021-05-06T07:09:40Z",
      "ConnectionDomain": "r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com",
      "MaintainEndTime": "17:00Z",
      "StorageType": "LOCAL_SSD",
      "InstanceId": "r-bp1e7vl6ygf1yq****",
      "BandWidth": 24,
      "CurrentBandWidth": 50,
      "EngineVersion": "5.0",
      "RegionId": "cn-hangzhou",
      "InstanceName": "testdb",
      "ZoneId": "cn-hangzhou-e",
      "ClusterName": "testname",
      "InstanceStatus": "Normal",
      "Engine": "redis",
      "ShardCount": 3,
      "CustomId": "4652****",
      "ProxyCount": 1,
      "ClusterId": "dhg-rx71fc5ndh9o****",
      "InstanceNodeList": [
        {
          "NodeIp": "10.0.33.***",
          "DedicatedHostName": "ch-bp13vf0y9gx3c****",
          "NodeType": "normal",
          "ZoneId": "cn-hangzhou-h",
          "InstanceId": "r-bp1e7vl6ygf1yq****",
          "Port": 3001,
          "Role": "master",
          "NodeId": 17921111
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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