すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeInstancesOverview

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeInstancesOverview

    最終更新日:Jul 10, 2026

    1 つ以上の ApsaraDB for 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:DescribeInstancesOverview

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    インスタンスのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。

    cn-hangzhou
    InstanceIds

    string

    任意

    クエリするインスタンスの ID。

    説明

    デフォルトでは、現在のアカウント配下のすべてのインスタンスがクエリされます。複数のインスタンス ID を指定する場合は、カンマ (,) で区切ります。

    r-bp1zxszhcgatnx****
    InstanceStatus

    string

    任意

    インスタンスステータス。有効な値:

    • Normal: インスタンスは法線状態です。

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

    • Changing: インスタンスを変更済みです。

    • Inactive: インスタンスは無効です。

    • Flushing: インスタンスをパージ中です。

    • Released: インスタンスはリリース済みです。

    • Transforming: インスタンスを変換中です。

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

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

    • MinorVersionUpgrading: マイナーバージョンのスペックアップを実行中です。

    • NetworkModifying: ネットワーク構成を変更中です。

    • SSLModifying: SSL 構成を変更中です。

    • MajorVersionUpgrading: メジャーエンジンバージョンのスペックアップを実行中です。インスタンスには通常通りアクセスできます。

    説明

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

    Normal
    ChargeType

    string

    任意

    課金方法。有効な値:

    • PrePaid: サブスクリプション。

    • PostPaid: 従量課金。

    PostPaid
    NetworkType

    string

    任意

    ネットワークタイプ。有効な値:

    • CLASSIC: クラシックネットワーク。

    • VPC: 仮想非公開クラウド (VPC)。

    CLASSIC
    EngineVersion

    string

    任意

    インスタンスの Redis 互換エンジンバージョン。有効な値: 2.8、4.0、5.0、6.0、7.0。

    列挙値:

    • 4.0 :

      4.0

    • 5.0 :

      5.0

    • 6.0 :

      6.0

    • 7.0 :

      7.0

    • 2.8 :

      2.8

    6.0
    InstanceClass

    string

    任意

    インスタンスタイプ。詳細については、「インスタンスタイプ」を参照してください。

    redis.master.small.default
    VpcId

    string

    任意

    VPC の ID。

    vpc-bp1nme44gek34slfc****
    VSwitchId

    string

    任意

    vSwitch の ID。

    vsw-bp1e7clcw529l773d****
    InstanceType

    string

    任意

    インスタンスタイプ。有効な値:

    • Tair

    • Redis

    • Memcache

    Redis
    SearchKey

    string

    任意

    インスタンス ID またはインスタンスの説明によるあいまい検索に使用されるキーワード。

    apitest
    ArchitectureType

    string

    任意

    アーキテクチャタイプ。有効な値:

    • cluster: Cluster Edition。

    • standard: Standard Edition。

    • rwsplit: 読み取り/書き込み分離エディション。

    standard
    ZoneId

    string

    任意

    ゾーンの ID。

    cn-hangzhou-b
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    説明

    ListResourceGroups 操作を呼び出すか、コンソールを使用してリソースグループ ID を取得できます。関連する操作については、「リソースグループの基本情報の表示」を参照してください。

    rg-acfmyiu4ekp****
    EditionType

    string

    任意

    エディションタイプ。有効な値:

    • Community: Community Edition。

    • Enterprise: Enterprise Edition。

    Enterprise
    PrivateIp

    string

    任意

    非公開 IP アドレス。

    172.16.49.***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    RequestId

    string

    リクエスト ID。

    1E83311F-0EE4-4922-A3BF-730B312B****
    TotalCount

    integer

    インスタンスの総数。

    1
    Instances

    array<object>

    インスタンスのリスト。

    object

    インスタンスオブジェクト。

    VpcId

    string

    VPC の ID。

    vpc-bp1nme44gek34slfc****
    PrivateIp

    string

    VPC 内のインスタンスの非公開 IP アドレス。IP アドレスは変更される可能性があります。インスタンスへの接続には ConnectionDomain (内部エンドポイント) を使用してください。

    説明

    • インスタンスのネットワークタイプがクラシックネットワークの場合、このパラメーターは返されません。

    • クラウドネイティブインスタンスの場合、このパラメーターは返されません。

    172.16.49.***
    Capacity

    integer

    インスタンスのストレージ容量。単位: MB。

    4096
    CreateTime

    string

    インスタンスが作成された時間。

    2018-11-07T08:49:00Z
    ConnectionDomain

    string

    インスタンスの内部エンドポイント。

    r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
    ChargeType

    string

    課金方法。有効な値:

    • PrePaid: サブスクリプション。

    • PostPaid: 従量課金。

    PrePaid
    ArchitectureType

    string

    アーキテクチャタイプ。有効な値:

    • cluster: Cluster Edition。

    • standard: Standard Edition。

    • rwsplit: 読み取り/書き込み分離エディション。

    cluster
    NetworkType

    string

    ネットワークタイプ。有効な値:

    • CLASSIC: クラシックネットワーク。

    • VPC: 仮想非公開クラウド (VPC)。

    CLASSIC
    EngineVersion

    string

    インスタンスの Redis 互換エンジンバージョン。有効な値: 2.8、4.0、5.0、6.0、7.0。

    6.0
    InstanceName

    string

    インスタンスの名前。

    apitest
    GlobalInstanceId

    string

    分散インスタンスの ID。

    説明

    このパラメーターは、インスタンスが分散インスタンスのサブインスタンスである場合にのみ返されます。

    gr-bp14rkqrhac****
    InstanceClass

    string

    インスタンスタイプ。

    redis.logic.sharding.2g.2db.0rodb.4proxy.default
    InstanceId

    string

    インスタンスの ID。

    r-bp1zxszhcgatnx****
    InstanceType

    string

    インスタンスタイプ。有効な値:

    • Tair: Tair (Enterprise Edition)。

    • Redis: Redis Community エディション。

    • Memcache

    Redis
    NodeType

    string

    RegionId

    string

    リージョン ID。

    cn-hangzhou
    EndTime

    string

    サブスクリプションインスタンスの有効期限切れの時間。

    2022-06-13T16:00:00Z
    VSwitchId

    string

    vSwitch の ID。

    vsw-bp1e7clcw529l773d****
    ResourceGroupId

    string

    インスタンスが属するリソースグループの ID。

    rg-acfmyiu4ekp****
    ZoneId

    string

    ゾーンの ID。

    cn-hangzhou-b
    InstanceStatus

    string

    インスタンスステータス。有効な値:

    • Normal: インスタンスは法線状態です。

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

    • Changing: インスタンスを変更済みです。

    • Inactive: インスタンスは無効です。

    • Flushing: インスタンスをパージ中です。

    • Released: インスタンスはリリース済みです。

    • Transforming: インスタンスを変換中です。

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

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

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

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

    • MinorVersionUpgrading: マイナーバージョンのスペックアップを実行中です。

    • NetworkModifying: ネットワーク構成を変更中です。

    • SSLModifying: SSL 構成を変更中です。

    • MajorVersionUpgrading: メジャーエンジンバージョンのスペックアップを実行中です。インスタンスには通常通りアクセスできます。

    Normal
    SecondaryZoneId

    string

    セカンダリゾーンの ID。

    説明

    このパラメーターは、インスタンスにセカンダリゾーンがある場合にのみ返されます。

    cn-hangzhou-g

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "PrivateIp": "172.16.49.***",
      "Capacity": 4096,
      "CreateTime": "2018-11-07T08:49:00Z",
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PrePaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "6.0",
      "InstanceName": "apitest",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceType": "Redis",
      "NodeType": "",
      "RegionId": "cn-hangzhou",
      "EndTime": "2022-06-13T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "ResourceGroupId": "rg-acfmyiu4ekp****",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Normal",
      "SecondaryZoneId": "cn-hangzhou-g"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidInstanceIds.Malformed The Specified parameter InstanceIds is not valid.

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

    変更履歴

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