すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:DATASOURCE::REDIS::Instances

最終更新日:Jan 16, 2025

DATASOURCE::REDIS::Instances は、Tair(Redis OSS 互換)インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::REDIS::Instances",
  "Properties": {
    "ArchitectureType": String,
    "EngineVersion": String,
    "EditionType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "InstanceClass": String,
    "Expired": String,
    "VpcId": String,
    "PrivateIp": String,
    "InstanceStatus": String,
    "ChargeType": String,
    "NetworkType": String,
    "SearchKey": String,
    "GlobalInstance": String,
    "InstanceType": String,
    "InstanceIds": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ArchitectureType

String

いいえ

はい

アーキテクチャタイプ。

有効な値:

  • cluster: クラスタアーキテクチャ

  • standard: 標準アーキテクチャ

  • rwsplit: リード/ライト分離アーキテクチャ

EngineVersion

String

いいえ

はい

インスタンスのデータベースエンジンバージョン。

有効な値:

  • 2.8

  • 4.0

  • 5.0

  • 6.0

EditionType

String

いいえ

はい

インスタンスのエディション。

有効な値:

  • Community: Community Edition

  • Enterprise: Tair(Enterprise Edition)

ZoneId

String

いいえ

はい

ゾーン ID。

なし。

ResourceGroupId

String

いいえ

はい

リソースグループの ID。

なし。

VSwitchId

String

いいえ

はい

vSwitch ID。

なし。

InstanceClass

String

いいえ

はい

インスタンスタイプ。

なし。

Expired

String

いいえ

はい

インスタンスが期限切れかどうかを指定します。

有効な値:

  • true

  • false

VpcId

String

いいえ

はい

仮想プライベートクラウド(VPC)の ID。

なし。

PrivateIp

String

いいえ

はい

VPC の IP アドレス。

なし。

InstanceStatus

String

いいえ

はい

インスタンスのステータス。

有効な値:

  • Normal: インスタンスは正常に実行されています。

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

  • Changing: インスタンスは変更中です。

  • Inactive: インスタンスは無効になっています。

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

  • Released: インスタンスは解放されました。

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

  • Unavailable: インスタンスは停止しています。

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

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

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

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

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

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

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

ChargeType

String

いいえ

はい

課金方法。

有効な値:

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

  • PostPaid: 従量課金制

NetworkType

String

いいえ

はい

ネットワークタイプ。

有効な値:

  • CLASSIC

  • VPC

SearchKey

String

いいえ

はい

あいまい検索に使用するキーワード。キーワードは、インスタンス名またはインスタンス ID の一部にすることができます。

なし。

GlobalInstance

String

いいえ

はい

分散インスタンスの子インスタンスを返すかどうかを指定します。

有効な値:

  • true

  • false

InstanceType

String

いいえ

はい

インスタンスのカテゴリ。

有効な値:

  • Tair

  • Redis

  • Memcache

InstanceIds

String

いいえ

はい

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

説明

複数のインスタンス ID を指定する場合は、インスタンス ID をカンマ(,)で区切ります。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースの更新ポリシー。

有効な値:

  • Never(デフォルト): スタックの更新時にデータソースリソースを更新しません。

  • Always: スタックの更新時にデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

  • InstanceIds: インスタンスの ID。

  • Instances: インスタンスの詳細。

プロパティ

タイプ

説明

制約

InstanceIds

List

インスタンスの ID。

なし。

Instances

List

インスタンスの詳細。

なし。

VpcId

String

VPC ID。

なし。

PrivateIp

String

VPC の IP アドレス。

説明

インスタンスがクラシックネットワークにデプロイされている場合、このプロパティは返されません。

Capacity

Number

インスタンスの容量。

単位:MB。

ReplacateId

String

分散インスタンスの論理 ID。

なし。

CreateTime

String

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

なし。

ConnectionDomain

String

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

なし。

IsRds

Boolean

インスタンスが ApsaraDB RDS によって管理されているかどうかを示します。

有効な値:

  • true

  • false

ChargeType

String

課金方法。

有効な値:

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

  • PostPaid: 従量課金制

ArchitectureType

String

アーキテクチャタイプ。

有効な値:

  • cluster: クラスタアーキテクチャ

  • standard: 標準アーキテクチャ

  • SplitRW: リード/ライト分離アーキテクチャ

  • NULL(デフォルト): すべてのアーキテクチャタイプ

NetworkType

String

ネットワークタイプ。

有効な値:

  • CLASSIC

  • VPC

ConnectionMode

String

インスタンスの接続モード。

有効な値:

  • Standard: 標準モード

  • Safe: プロキシモード

Port

Number

インスタンスのサービスポート。

なし。

SecondaryZoneId

String

セカンダリゾーンの ID。

説明

ZoneId に「 cn-hangzhou-MAZ10(h,i) 」などの複数のゾーン ID を示す値が返される場合、SecondaryZoneId は返されません。

EngineVersion

String

インスタンスのデータベースエンジンバージョン。

有効な値:

  • 2.8

  • 4.0

  • 5.0

  • 6.0

PackageType

String

プランタイプ。

有効な値:

  • standard

  • customized

Config

String

インスタンスのパラメータ設定。

詳細については、「インスタンスパラメータの設定」をご参照ください。

Bandwidth

Number

インスタンスの帯域幅。

単位:MB/s。

InstanceName

String

インスタンス名。

なし。

ShardCount

Number

クラスタインスタンス内のデータノードの数。

説明

このプロパティは、インスタンスがクラウドディスクを使用するクラスタインスタンスの場合にのみ返されます。

UserName

String

インスタンスへの接続に使用するユーザー名。

デフォルトでは、インスタンス ID を基にしたユーザー名が返されます。

GlobalInstanceId

String

分散インスタンスの ID。

説明

このプロパティは、インスタンスが分散インスタンスの子インスタンスの場合にのみ返されます。

QPS

Number

1 秒あたりのクエリ数(QPS)。

なし。

InstanceClass

String

インスタンスタイプ。

なし。

DestroyTime

String

インスタンスが完全に削除された時刻。

なし。

InstanceType

String

インスタンスのカテゴリ。

有効な値:

  • Tair

  • Redis

  • Memcache

HasRenewChangeOrder

Boolean

更新と設定変更の保留中の注文があるかどうかを示します。

有効な値:

  • true

  • false

SearchKey

String

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

なし。

EndTime

String

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

なし。

VSwitchId

String

vSwitch ID。

なし。

NodeType

String

ノードタイプ。

有効な値:

  • double: マスターレプリカ

  • single: スタンドアロン

Connections

Number

インスタンスでサポートされる最大接続数。

なし。

ResourceGroupId

String

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

なし。

ZoneId

String

ゾーン ID。

なし。

InstanceStatus

String

インスタンスのステータス。

有効な値:

  • Normal: インスタンスは正常に動作しています。

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

  • Changing: インスタンスは変更中です。

  • Inactive: インスタンスは無効になっています。

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

  • Released: インスタンスは解放されました。

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

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

  • Unavailable: インスタンスは停止しています。

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

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

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

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

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

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

CloudType

String

このプロパティは、インスタンスがクラウドボックスにある場合にのみ返されます。

なし。

EditionType

String

インスタンスのエディション。

有効な値:

  • Community: Community Edition

  • Enterprise: Tair (Enterprise Edition)

Tags

Map

タグに関する情報。

例:

{
     "Value" : "Community Edition",
      "Key" : "Type"
 } 

InstanceId

String

インスタンス ID。

なし。

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceIds": {
      "Type": "String",
      "Description": "インスタンスの ID。\n複数のインスタンス ID を指定する場合は、インスタンス ID をカンマ(,)で区切ります。" // 翻訳済み
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::REDIS::Instances",
      "Properties": {
        "InstanceIds": {
          "Ref": "InstanceIds"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "Redis インスタンスのリスト。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "Redis インスタンス ID のリスト。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceIds:
    Type: String
    Description: |-
      インスタンスの ID。
      複数のインスタンス ID を指定する場合は、インスタンス ID をカンマ(,)で区切ります。 # 翻訳済み
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::REDIS::Instances
    Properties:
      InstanceIds:
        Ref: InstanceIds
Outputs:
  Instances:
    Description: Redis インスタンスのリスト。 # 翻訳済み
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Instances
  InstanceIds:
    Description: Redis インスタンス ID のリスト。 # 翻訳済み
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceIds