All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::DRDS::DrdsInstances

    Document Center

    Resource Orchestration Service:DATASOURCE::DRDS::DrdsInstances

    Last Updated:Jun 18, 2026

    Queries the list of Distributed Relational Database Service (DRDS) instances.

    Syntax

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

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    Type

    String

    No

    Yes

    The type of the instance.

    Valid values:

    • 0: shared instance

    • 1: dedicated instance

    Description

    String

    No

    Yes

    The description of the instance.

    None.

    ResourceGroupId

    String

    No

    Yes

    The ID of the resource group.

    None.

    RefreshOptions

    String

    No

    Yes

    The refresh policy for data source resources when the stack is updated.

    Valid values:

    • Never (default): Does not refresh data source resources on stack updates.

    • Always: Refreshes data source resources on stack updates.

    Return values

    Fn::GetAtt

    • Instances: details of the instances.

    • InstanceIds: the IDs of the instances.

    Property

    Type

    Description

    Constraint

    InstanceIds

    List

    The IDs of the instances.

    None.

    Instances

    List

    Details of the instances.

    None.

    ExpireDate

    String

    The expiration time of the instance.

    None.

    InstanceSpec

    String

    The instance specifications.

    None.

    MasterInstanceId

    String

    The ID of the primary instance.

    None.

    Label

    String

    The label of the instance.

    Valid values:

    • NORMAL: standard instance

    • HA: high-availability (HA) instance

    • VPC: virtual private cloud (VPC)-connected instance

    Version

    String

    The version of the instance.

    None.

    ReadOnlyDBInstanceIds

    List

    The IDs of the read-only instances.

    Example:

    [ "drdssen12****" ]

    VersionAction

    String

    Whether the instance version can be upgraded.

    None.

    Type

    String

    The type of the instance.

    Valid values:

    • PUBLIC: shared instance

    • PRIVATE: dedicated instance

    Status

    String

    The status of the instance.

    None.

    Description

    String

    The description of the instance.

    None.

    InstRole

    String

    The 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.

    RegionId

    String

    The region ID.

    None.

    ResourceGroupId

    String

    The ID of the resource group.

    None.

    OrderInstanceId

    String

    The ID of the purchased instance.

    None.

    DrdsInstanceId

    String

    The instance ID.

    None.

    CommodityCode

    String

    The commodity code of the instance.

    None.

    ZoneId

    String

    The zone.

    None.

    Vips

    List

    The virtual IP addresses (VIPs) of the instance.

    Example:

     [ {
      "VpcId" : "vpc-bpxxxxxxxx****",
      "Type" : "intranet",
      "VswitchId" : "vsw-bpxxxxxxxxxxx****",
      "Port" : "3306",
      "IP" : "10.23.XX.XX",
      "dns" : "drdssen1243as.drds.aliyuncs.com"
    } ]

    VpcCloudInstanceId

    String

    The ID of the instance in the VPC.

    None.

    MachineType

    String

    The machine type of the instance.

    Only ecs may be returned.

    InstanceSeries

    String

    The instance type.

    None.

    NetworkType

    String

    The network type.

    Valid values:

    • CLASSIC

    • VPC

    CreateTime

    String

    The creation time of the instance.

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