調用DATASOURCE::REDIS::Instances查詢多個Redis執行個體的資訊 -

DATASOURCE::REDIS::Instances類型用於查詢多個Redis執行個體的資訊。

文法

{
  "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	否	是	Redis執行個體的引擎版本。	取值： 2.8 4.0 5.0 6.0
EditionType	String	否	是	執行個體類型。	取值： Community：社區版。 Enterprise：企業版。
ZoneId	String	否	是	可用性區域ID。	無
ResourceGroupId	String	否	是	資源群組ID。	無
VSwitchId	String	否	是	虛擬交換器ID。	無
InstanceClass	String	否	是	執行個體規格。	無
Expired	String	否	是	執行個體的到期狀態。	取值： true：已到期。 false：未到期。
VpcId	String	否	是	專用網路ID。	無
PrivateIp	String	否	是	專用網路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：Redis執行個體ID列表。
Instances：Redis執行個體詳情列表。

屬性名稱	類型	描述	約束
InstanceIds	List	Redis執行個體ID列表。	無
Instances	List	Redis執行個體詳情列表。	無
VpcId	String	Virtual Private Cloud的ID。	無
PrivateIp	String	專用網路IP地址。	說明執行個體的網路類型為傳統網路時，不會返回本參數。
Capacity	Number	執行個體容量。	單位：MB。
ReplacateId	String	多活執行個體的邏輯ID。	無
CreateTime	String	執行個體的建立時間。	無
ConnectionDomain	String	執行個體的內網串連地址。	無
IsRds	Boolean	是否屬於RDS管控。	取值： true：屬於RDS管控。 false：不屬於RDS管控。
ChargeType	String	付費類型。	取值： PrePaid：預付費。 PostPaid：後付費。
ArchitectureType	String	架構類型。	取值： cluster：叢集版。 standard：標準版。 SplitRW：讀寫分離版。 NULL（預設值）：所有類型。
NetworkType	String	網路類型。	取值： CLASSIC：傳統網路。 VPC：專用網路。
ConnectionMode	String	執行個體的訪問模式。	取值： Standard：標準訪問模式。 Safe：資料庫代理模式。
Port	Number	Redis服務連接埠。	無
SecondaryZoneId	String	備可用性區域ID。	說明若ZoneId參數已返回多可用性區域，例如："cn-hangzhou-MAZ10(h,i)"，本參數將不返回備可用性區域ID。
EngineVersion	String	Redis執行個體的引擎版本。	取值： 2.8 4.0 5.0 6.0
PackageType	String	套餐類型。	取值： standard：標準套餐。 customized：定製套餐。
Config	String	執行個體的參數設定情況。	更多資訊，請參見設定執行個體參數。
Bandwidth	Number	執行個體頻寬。	單位：MB/s。
InstanceName	String	執行個體的名稱。	無
ShardCount	Number	叢集的資料節點數量。	說明當Redis執行個體為雲端硬碟版（叢集架構）時才會返回本參數。
UserName	String	串連使用的使用者名稱。	預設包含有一個以執行個體ID命名的使用者名稱。
GlobalInstanceId	String	分布式執行個體ID。	說明當執行個體為分布式執行個體中的子執行個體時，才會返回該參數。
QPS	Number	每秒請求數。	無
InstanceClass	String	執行個體的規格。	無
DestroyTime	String	銷毀執行個體的時間。	無
InstanceType	String	執行個體類型。	取值： Tair Redis Memcache
HasRenewChangeOrder	Boolean	是否有未生效的續約變更配置訂單。	取值： true：是。 false：否。
SearchKey	String	基於執行個體ID或者執行個體備忘模糊搜尋時使用的關鍵字。	無
EndTime	String	訂用帳戶執行個體到期時間。	無
VSwitchId	String	虛擬交換器的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：社區版。 Enterprise：企業版。
Tags	Map	標籤資訊。	例如： `{ "Value" : "社區版", "Key" : "類型" }`
InstanceId	String	執行個體的ID。	無

樣本

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceIds": {
      "Type": "String",
      "Description": "The IDs of instances.\nIf you specify multiple instance IDs, separate the instance IDs with commas (,)."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::REDIS::Instances",
      "Properties": {
        "InstanceIds": {
          "Ref": "InstanceIds"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The list of The Redis instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of The Redis instance Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceIds:
    Type: String
    Description: |-
      The IDs of instances.
      If you specify multiple instance IDs, separate the instance IDs with commas (,).
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::REDIS::Instances
    Properties:
      InstanceIds:
        Ref: InstanceIds
Outputs:
  Instances:
    Description: The list of The Redis instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Instances
  InstanceIds:
    Description: The list of The Redis instance Ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceIds