すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeGlobalDistributeCache

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeGlobalDistributeCache

    最終更新日:Mar 30, 2026

    分散型 Tair（Redis OSS 互換）インスタンスの詳細を照会します。

    操作説明

    デバッグ

    OpenAPI Explorer では署名値が自動計算されます。ご利便性を考慮し、本操作は OpenAPI Explorer を使用して実行することを推奨します。OpenAPI Explorer では、各種 SDK 向けに動的にサンプルコードを生成します。

    今すぐお試しください

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

    get

    *DBInstance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GlobalInstanceId

    string

    任意

    分散型インスタンスの ID です。

    gr-bp14rkqrhac****
    PageNumber

    string

    任意

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

    1
    PageSize

    string

    任意

    1 ページあたりに返すエントリ数です。

    20
    SubInstanceId

    string

    任意

    分散型インスタンスにアタッチされたサブインスタンスの ID です。

    gr-bp1zcjlobkyrq****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageSize

    integer

    1 ページあたりに返されるエントリ数です。

    20
    RequestId

    string

    リクエストの ID です。

    F3F44BE3-5419-4B61-9BAC-E66E295A****
    PageNumber

    integer

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

    1
    TotalRecordCount

    integer

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

    1
    GlobalDistributeCaches

    array<object>

    分散型インスタンスの詳細です。

    array<object>

    Status

    string

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

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

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

    • Creating：インスタンスが作成中です。

    Normal
    GlobalInstanceId

    string

    分散型インスタンスの ID です。

    gr-bp14rkqrhac****
    SubInstances

    array<object>

    サブインスタンスの詳細です。

    object

    InstanceStatus

    string

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

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

    • Creating：インスタンスが作成中です。

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

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

    • Flushing：インスタンスが解放中です。

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

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

    • Unavailable：インスタンスは一時停止されています。

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

    • Migrating：インスタンスが移行中です。

    • BackupRecovering：インスタンスがバックアップから復元中です。

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

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

    • SSLModifying：インスタンスの SSL 証明書が変更中です。

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

    説明

    インスタンスの状態について詳しくは、「インスタンスの状態と影響」をご参照ください。

    Normal
    InstanceID

    string

    サブインスタンスの ID です。

    r-bp1zxszhcgatnx****
    InstanceClass

    string

    サブインスタンスのインスタンスタイプです。詳細については、以下のトピックをご参照ください。

    redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread
    GlobalInstanceId

    string

    分散型インスタンスの ID です。

    gr-bp14rkqrhac****
    RegionId

    string

    リージョンの ID です。

    cn-hangzhou

    例

    成功レスポンス

    JSONJSON

    {
  "PageSize": 20,
  "RequestId": "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "PageNumber": 1,
  "TotalRecordCount": 1,
  "GlobalDistributeCaches": [
    {
      "Status": "Normal",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "SubInstances": [
        {
          "InstanceStatus": "Normal",
          "InstanceID": "r-bp1zxszhcgatnx****",
          "InstanceClass": "redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread",
          "GlobalInstanceId": "gr-bp14rkqrhac****",
          "RegionId": "cn-hangzhou"
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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