DATASOURCE::REDIS::Instances - Resource Orchestration Service

DATASOURCE::REDIS::Instances is used to query the information about ApsaraDB for Redis instances.

Syntax

{
  "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
  }
}

Properties


Property	Type	Required	Editable	Description	Constraint
ArchitectureType	String	No	Yes	The type of the architecture.	Valid values: cluster: cluster architecture standard: standard architecture SplitRW: read/write splitting architecture
EngineVersion	String	No	Yes	The engine version of the instance.	Valid values: 2.8 4.0 5.0 6.0
EditionType	String	No	Yes	The edition of the instance.	Valid values: Community: Community Edition Enterprise: Enterprise Edition
ZoneId	String	No	Yes	The ID of the zone.	None
ResourceGroupId	String	No	Yes	The ID of the resource group to which the instance belongs.	None
VSwitchId	String	No	Yes	The ID of the vSwitch.	None
InstanceClass	String	No	Yes	The type of the instance.	None
Expired	String	No	Yes	Specifies whether the instance has expired.	Valid values: true: The instance has expired. false: The instance has not expired.
VpcId	String	No	Yes	The ID of the virtual private cloud (VPC).	None
PrivateIp	String	No	Yes	The private IP address.	None
InstanceStatus	String	No	Yes	The state of the instance.	Valid values: Normal: The instance works as expected. Creating: The instance is being created. Changing: The instance is being changed. Inactive: The instance is being disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The instance is being transformed. Unavailable: The instance is suspended. Error: The instance fails to be created. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: The minor version of the instance is being updated. NetworkModifying: The network configurations of the instance are being changed. SSLModifying: The SSL configurations of the instance are being changed. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance can be accessed during the upgrade.
ChargeType	String	No	Yes	The billing method of the instance.	Valid values: PrePaid: subscription PostPaid: pay-as-you-go
NetworkType	String	No	Yes	The network type.	Valid values: CLASSIC VPC
SearchKey	String	No	Yes	The keyword that you want to use for fuzzy match. The keyword can be based on an instance name or instance ID.	None
GlobalInstance	String	No	Yes	Specifies whether to return the child instance of a distributed instance.	Valid values: true false
InstanceType	String	No	Yes	The category of the instance.	Valid values: Tair Redis Memcache
InstanceIds	String	No	Yes	The IDs of the instances that you want to query.	Note If you specify multiple instance IDs, separate the instance IDs with commas (,).

Return values (Fn::GetAtt)

InstanceIds: the IDs of the instances.
Instances: details of the instances.


Property	Type	Description	Constraint
InstanceIds	List	The IDs of the instances.	None.
Instances	List	Details of the instances.	None.
VpcId	String	The ID of the VPC.	None.
PrivateIp	String	The private IP address.	Note This property is not returned if the instance is deployed in the classic network.
Capacity	Number	The capacity of the instance.	Unit: MB.
ReplacateId	String	The logical ID of the distributed instance.	None.
CreateTime	String	The time when the instance is created.	None.
ConnectionDomain	String	The private endpoint of the instance.	None.
IsRds	Boolean	Indicates whether the instance is managed by ApsaraDB RDS.	Valid values: true false
ChargeType	String	The billing method of the instance.	Valid values: PrePaid: subscription PostPaid: pay-as-you-go
ArchitectureType	String	The type of the architecture.	Default value: NULL. Valid values: cluster: cluster architecture standard: standard architecture SplitRW: read/write splitting architecture NULL: all types of architectures
NetworkType	String	The network type of the instance.	Valid values: CLASSIC: classic network VPC: VPC
ConnectionMode	String	The connection mode of the instance.	Valid values: Standard: standard mode Safe: proxy mode
Port	Number	The service port of the instance.	None.
SecondaryZoneId	String	The ID of the secondary zone.	Note If a value that indicates multiple zone IDs, such as cn-hangzhou-MAZ10(h,i), is returned for the ZoneId property, the SecondaryZoneId property is not returned.
EngineVersion	String	The engine version of the instance.	Valid values: 2.8 4.0 5.0 6.0
PackageType	String	The type of the plan.	Valid values: standard: standard plan customized: custom plan
Config	String	The parameter settings of the instance.	For more information, see Modify parameters of an instance.
Bandwidth	Number	The bandwidth of the instance.	Unit: MB/s.
InstanceName	String	The name of the instance.	None.
ShardCount	Number	The number of shards in the cluster.	Note This property is returned only if the instance is a cluster instance that supports cloud disks.
UserName	String	The username that is used to access the instance.	By default, the username that is named after the instance ID is returned.
GlobalInstanceId	String	The ID of the distributed instance.	Note This property is returned only if the instance is a child instance of a distributed instance.
QPS	Number	The queries per second (QPS).	None.
InstanceClass	String	The specifications of the instance.	None.
DestroyTime	String	The time when the instance was permanently deleted.	None.
InstanceType	String	The category of the instance.	Valid values: Tair Redis Memcache
HasRenewChangeOrder	Boolean	Indicates whether an order for renewal and configuration change that has not taken effect exists.	Valid values: true false
SearchKey	String	The keyword that is used for fuzzy match. The keyword can be based on an instance ID or instance description.	None.
EndTime	String	The time when the subscription instance expires.	None.
VSwitchId	String	The ID of the vSwitch.	None.
NodeType	String	The type of the node.	Valid values: double: master and replica nodes single: a master node
Connections	Number	The maximum number of connections supported by the instance.	None.
ResourceGroupId	String	The ID of the resource group to which the instance belongs.	None.
ZoneId	String	The ID of the zone.	None.
InstanceStatus	String	The state of the instance.	Valid values: Normal: The instance works as expected. Creating: The instance is being created. Changing: The instance is being changed. Inactive: The instance is being disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The instance is being transformed. Migrating: The instance is being migrated. Unavailable: The instance is suspended. Error: The instance fails to be created. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: A minor version of the instance is being updated. NetworkModifying: The network configurations of the instance are being modified. SSLModifying: The SSL configurations of the instance are being modified. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance can be accessed during the upgrade.
CloudType	String	This property is returned only if the instance uses a cloud box.	None.
EditionType	String	The edition of the instance.	Valid values: Community: Community Edition Enterprise: Enhanced Edition (Tair)
Tags	Map	The information about the tags.	Example: `{ "Value" : "Community Edition", "Key" : "Type" }`
InstanceId	String	The ID of the instance.	None.

Examples

JSON format

{
  "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 format

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