DATASOURCE::DRDS::DrdsInstances is used to query instances.

Syntax

{
  "Type": "DATASOURCE::DRDS::DrdsInstances",
  "Properties": {
    "Type": String,
    "Description": String,
    "ResourceGroupId": String
  }
}

Properties

PropertyTypeRequiredEditableDescriptionConstraint
TypeStringNoYesThe type of the instance. Valid values:
  • 0: shared instance
  • 1: dedicated instance
DescriptionStringNoYesThe description of the instance. None.
ResourceGroupIdStringNoYesThe ID of the resource group. None.

Return values

Fn::GetAtt

  • Instances: details of the instances.
  • InstanceIds: the instance IDs.
PropertyTypeDescriptionConstraint
InstanceIdsListThe instance IDs. None.
InstancesListDetails of the instances. None.
ExpireDateStringThe timestamp that indicates when the instance expires. None.
InstanceSpecStringThe specifications of the instance. None.
MasterInstanceIdStringThe ID of the primary instance. None.
LabelStringThe label of the instance. Valid values:
  • NORMAL: The instance is a standard instance.
  • HA: The instance is a high-availability (HA) instance.
  • VPC: The instance is a VPC-connected instance.
VersionStringThe version of the instance. None.
ReadOnlyDBInstanceIdsListThe IDs of the read-only instances. Example:
[ "drdssen12****" ]
VersionActionStringIndicates whether the version of the instance can be upgraded. None.
TypeStringThe type of the instance. Valid values:
  • PUBLIC: shared instance
  • PRIVATE: dedicated instance
StatusStringThe state of the instance. None.
DescriptionStringThe description of the instance. None.
InstRoleStringThe role of the instance. Valid values:
  • MASTER: The instance is a primary instance.
  • SLAVE: The instance is a read-only instance that is used to analyze complex queries.
  • SLAVE_FLOW: The instance is a read-only instance that is suitable for high-concurrency scenarios.
RegionIdStringThe region ID. None.
ResourceGroupIdStringThe ID of the resource group. None.
OrderInstanceIdStringThe ID of the purchased instance. None.
DrdsInstanceIdStringThe instance ID. None.
CommodityCodeStringThe commodity code of the instance. None.
ZoneIdStringThe zone ID. None.
VipsListDetails of the virtual IP addresses (VIPs). Example:
 [ {
      "VpcId" : "vpc-bpxxxxxxxx****",
      "Type" : "intranet",
      "VswitchId" : "vsw-bpxxxxxxxxxxx****",
      "Port" : "3306",
      "IP" : "10.23.XX.XX",
      "dns" : "drdssen1243as.drds.aliyuncs.com"
    } ]
VpcCloudInstanceIdStringThe ID of the instance that is deployed in the VPC. None.
MachineTypeStringThe machine type of the instance.Only ecs may be returned.
InstanceSeriesStringThe instance type. None.
NetworkTypeStringThe network type of the instance. Valid values:
  • CLASSIC
  • VPC
CreateTimeStringThe timestamp that indicates when the instance was created. None.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters: {}
    Resources:
      ExtensionDataSource:
        Type: DATASOURCE::DRDS::DrdsInstances
        Properties:
          Type: '0'
    Outputs:
      Instances:
        Description: The list of drds instances.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Instances
      InstanceIds:
        Description: The list of drds instance IDs.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - InstanceIds
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::DRDS::DrdsInstances",
          "Properties": {
            "Type": "0"
          }
        }
      },
      "Outputs": {
        "Instances": {
          "Description": "The list of drds instances.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Instances"
            ]
          }
        },
        "InstanceIds": {
          "Description": "The list of drds instance IDs.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "InstanceIds"
            ]
          }
        }
      }
    }