AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 资源编排 开发参考 资源类型 Redis DATASOURCE::REDIS::Instances

DATASOURCE::REDIS::Instances

更新时间：
产品详情
我的收藏

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

专有网络（VPC）的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。

无

示例

{
  "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"
        ]
      }
    }
  }
}
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
上一篇：DATASOURCE::REDIS::Account下一篇：DATASOURCE::REDIS::Accounts