DATASOURCE::REDIS::Instance_资源编排(ROS)-阿里云帮助中心

DATASOURCE::REDIS::Instance类型用于查询Redis实例的信息。

语法

{
  "Type": "DATASOURCE::REDIS::Instance",
  "Properties": {
    "DBInstanceId": String,
    "RefreshOptions": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束

属性名称

类型

必须

允许更新

描述

约束

DBInstanceId

String

是

实例ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

SecurityIpGroupAttribute：安全IP组属性。
EndTime：实例到期时间。
ResourceGroupId：实例所属的资源组ID。
Config：实例的参数设置情况。
Port：Redis服务端口。
HasRenewChangeOrder：是否有未生效的续费变配订单。
SecurityIpGroupName：安全IP组名称。
ShardCount：集群的数据节点数量。
ConnectionDomain：实例的内网连接地址。
MaintainEndTime：维护结束时间。
Capacity：实例容量。
DBInstanceId：数据库实例ID。
PrivateIp：专有网络IP地址。
Qps：每秒请求数。
NetworkType：网络类型。
PackageType：套餐类型。
InstanceReleaseProtection：实例释放保护。
Bandwidth：实例带宽。
PaymentType：付费类型。
InstanceType：实例类型。
Tags：标签信息。
MaintainStartTime：维护起始时间。
DBInstanceName：实例名称。
ReplacateId：多活实例的逻辑ID。
ArchitectureType：架构类型。
SecurityIps：IP白名单分组下的IP列表。
EngineVersion：Redis实例的引擎版本。
ZoneId：可用区ID。
CloudType：仅云盒实例显示该参数。
VSwitchId：虚拟交换机ID。
SecurityGroupId：安全组ID。
CreateTime：实例的创建时间。
ReadOnlyCount：只读节点数，本参数仅适用于云盘版读写分离架构实例。
InstanceClass：实例规格。
IsRds：是否属于RDS管控。
SecondaryZoneId：备可用区ID。
VpcId：专有网络ID。
VpcAuthMode：VPC认证模式。
VpcCloudInstanceId：VPC实例ID。

示例

YAML

JSON

YAML

        

          
      
        
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Description:
      en: Database instance id.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
    Type: DATASOURCE::REDIS::Instance
Outputs:
  ArchitectureType:
    Description: Architecture type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ArchitectureType
  Bandwidth:
    Description: Bandwidth.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Bandwidth
  Capacity:
    Description: Capacity.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Capacity
  CloudType:
    Description: Cloud category.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CloudType
  Config:
    Description: Config.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Config
  ConnectionDomain:
    Description: Connection domain.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConnectionDomain
  CreateTime:
    Description: Create time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  DBInstanceId:
    Description: Database instance id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceId
  DBInstanceName:
    Description: Instance name.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceName
  EndTime:
    Description: End time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EndTime
  EngineVersion:
    Description: Engine version.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EngineVersion
  HasRenewChangeOrder:
    Description: Has renew change order.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - HasRenewChangeOrder
  InstanceClass:
    Description: Instance class.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceClass
  InstanceReleaseProtection:
    Description: Instance release protection.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceReleaseProtection
  InstanceType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceType
  IsRds:
    Description: is RDS.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IsRds
  MaintainEndTime:
    Description: Maintain end time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaintainEndTime
  MaintainStartTime:
    Description: Maintain start time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaintainStartTime
  NetworkType:
    Description: Network type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - NetworkType
  PackageType:
    Description: Package type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PackageType
  PaymentType:
    Description: Payment type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PaymentType
  Port:
    Description: Port.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Port
  PrivateIp:
    Description: Private IP.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PrivateIp
  Qps:
    Description: QPS.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Qps
  ReadOnlyCount:
    Description: 'The number of read-only nodes. This parameter is only applicable
      to the creation of read-write splitting instances in the cloud disk version.
      You can use this parameter to customize the number of read-only nodes. Valid
      values: 1 to 5.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReadOnlyCount
  ReplacateId:
    Description: Replacate id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ReplacateId
  ResourceGroupId:
    Description: Resource group id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  SecondaryZoneId:
    Description: The ID of the standby zone. You can call the [DescribeZones](~~ 94527
      ~~) operation.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecondaryZoneId
  SecurityGroupId:
    Description: Security group id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityGroupId
  SecurityIpGroupAttribute:
    Description: Security IP group attribute.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityIpGroupAttribute
  SecurityIpGroupName:
    Description: Security IP group name.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityIpGroupName
  SecurityIps:
    Description: Security IPs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityIps
  ShardCount:
    Description: The number of slices. This parameter is only applicable to creating
      a cloud disk cluster architecture instance. You can use this parameter to customize
      the number of slices.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ShardCount
  Tags:
    Description: Tags.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Tags
  VSwitchId:
    Description: Vswitch id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VSwitchId
  VpcAuthMode:
    Description: Vpc auth mode.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcAuthMode
  VpcCloudInstanceId:
    Description: Vpc cloud instance id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcCloudInstanceId
  VpcId:
    Description: Vpc id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcId
  ZoneId:
    Description: Zone id.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneId
                        

JSON

        

          
      
        
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "Database instance id."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::REDIS::Instance",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "SecurityIpGroupAttribute": {
      "Description": "Security IP group attribute.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIpGroupAttribute"
        ]
      }
    },
    "EndTime": {
      "Description": "End time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EndTime"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "Resource group id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "Config": {
      "Description": "Config.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Config"
        ]
      }
    },
    "Port": {
      "Description": "Port.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Port"
        ]
      }
    },
    "HasRenewChangeOrder": {
      "Description": "Has renew change order.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasRenewChangeOrder"
        ]
      }
    },
    "SecurityIpGroupName": {
      "Description": "Security IP group name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIpGroupName"
        ]
      }
    },
    "ShardCount": {
      "Description": "The number of slices. This parameter is only applicable to creating a cloud disk cluster architecture instance. You can use this parameter to customize the number of slices.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ShardCount"
        ]
      }
    },
    "ConnectionDomain": {
      "Description": "Connection domain.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionDomain"
        ]
      }
    },
    "MaintainEndTime": {
      "Description": "Maintain end time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainEndTime"
        ]
      }
    },
    "Capacity": {
      "Description": "Capacity.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Capacity"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "Database instance id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceId"
        ]
      }
    },
    "PrivateIp": {
      "Description": "Private IP.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrivateIp"
        ]
      }
    },
    "Qps": {
      "Description": "QPS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Qps"
        ]
      }
    },
    "NetworkType": {
      "Description": "Network type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NetworkType"
        ]
      }
    },
    "PackageType": {
      "Description": "Package type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PackageType"
        ]
      }
    },
    "InstanceReleaseProtection": {
      "Description": "Instance release protection.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceReleaseProtection"
        ]
      }
    },
    "Bandwidth": {
      "Description": "Bandwidth.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "PaymentType": {
      "Description": "Payment type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "InstanceType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceType"
        ]
      }
    },
    "Tags": {
      "Description": "Tags.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "MaintainStartTime": {
      "Description": "Maintain start time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainStartTime"
        ]
      }
    },
    "DBInstanceName": {
      "Description": "Instance name.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceName"
        ]
      }
    },
    "ReplacateId": {
      "Description": "Replacate id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplacateId"
        ]
      }
    },
    "ArchitectureType": {
      "Description": "Architecture type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ArchitectureType"
        ]
      }
    },
    "SecurityIps": {
      "Description": "Security IPs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIps"
        ]
      }
    },
    "EngineVersion": {
      "Description": "Engine version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EngineVersion"
        ]
      }
    },
    "ZoneId": {
      "Description": "Zone id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "CloudType": {
      "Description": "Cloud category.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CloudType"
        ]
      }
    },
    "VSwitchId": {
      "Description": "Vswitch id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "Security group id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "Create time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "ReadOnlyCount": {
      "Description": "The number of read-only nodes. This parameter is only applicable to the creation of read-write splitting instances in the cloud disk version. You can use this parameter to customize the number of read-only nodes. Valid values: 1 to 5.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReadOnlyCount"
        ]
      }
    },
    "InstanceClass": {
      "Description": "Instance class.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClass"
        ]
      }
    },
    "IsRds": {
      "Description": "is RDS.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsRds"
        ]
      }
    },
    "SecondaryZoneId": {
      "Description": "The ID of the standby zone. You can call the [DescribeZones](~~ 94527 ~~) operation.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecondaryZoneId"
        ]
      }
    },
    "VpcId": {
      "Description": "Vpc id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "VpcAuthMode": {
      "Description": "Vpc auth mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcAuthMode"
        ]
      }
    },
    "VpcCloudInstanceId": {
      "Description": "Vpc cloud instance id.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcCloudInstanceId"
        ]
      }
    }
  }
}
                        