文档

资源编排ROS集成示例

更新时间:

通过阿里云资源编排服务ROS(Resource Orchestration Service)的模板,您可以定义云产品资源及其依赖关系。ROS的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。本文为您演示如何通过ROS查询RDS实例信息。

支持资源列表

资源编排服务ROS是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS 实例、RDS 数据库实例)、资源间的依赖关系等。ROS的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情请参见什么是资源编排服务

支持使用资源编排服务ROS调用RDS。编排的资源包括普通资源和数据资源。

配置权限

使用资源编排,您需要一个阿里云账号和账号的访问密钥(AccessKey)。为确保您的阿里云账号及云资源使用安全,如非必要应避免直接使用阿里云主账号来访问云数据库RDS。建议您创建一个RAM用户,获取该用户的AccessKey,并向其授予RDS权限。

  1. 创建RAM用户:

    1. 访问RAM用户列表,单击创建用户

    2. 设置登录名称rds-test-operator,选择访问方式OpenAPI 调用访问

    3. 单击确定,创建RAM用户。

  2. 完成授权:

    1. 访问RAM用户列表,单击目标RAM用户操作列的添加权限

    2. 为RAM用户添加如下权限策略。

      • AliyunRDSFullAccess:具备查询、修改RDS实例的完全控制权限。

        说明

        您也可以按需选择AliyunRDSReadOnlyAccess(拥有查询RDS实例的操作权限),或进行自定义策略,更多信息请参见创建自定义权限策略

      • AliyunROSFullAccess:具备管理资源编排服务所有操作(ROS)的权限。

    3. 单击确认新增授权,完成授权操作。

操作步骤

  1. 登录资源编排ROS控制台

  2. 在顶部菜单栏左上角处,选择地域。

  3. 单击左侧菜单栏中的资源栈,选择创建资源栈 > 使用ROS

  4. 选择模板,并单击下一步

    本文以输入自定义模板为例查询RDS实例信息。更多的模板使用方式详情请参见创建资源栈

    1. 指定模板区域,选择选择已有模板

    2. 模板录入方式选择输入模板

    3. 模板内容中,选择ROS,并输入模板代码。

      以下是用于查询RDS实例信息的ROS资源的模板代码,选择一种格式即可。更多详情,请参见DATASOURCE::RDS::DBInstance

      JSON格式

      {
        "ROSTemplateFormatVersion": "2015-09-01",
        "Parameters": {
          "DBInstanceId": {
            "Type": "String",
            "Description": {
              "en": "The ID of the instance."
            },
            "Required": false
          }
        },
        "Resources": {
          "ExtensionDataSource": {
            "Type": "DATASOURCE::RDS::DBInstance",
            "Properties": {
              "DBInstanceId": {
                "Ref": "DBInstanceId"
              }
            }
          }
        },
        "Outputs": {
          "DBInstanceMemory": {
            "Description": "The memory capacity of the instance. Unit: MB.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceMemory"
              ]
            }
          },
          "ResourceGroupId": {
            "Description": "The resource group ID.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ResourceGroupId"
              ]
            }
          },
          "IncrementSourceDBInstanceId": {
            "Description": "The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "IncrementSourceDBInstanceId"
              ]
            }
          },
          "MasterZone": {
            "Description": "The zone ID of the primary instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "MasterZone"
              ]
            }
          },
          "Port": {
            "Description": "The port that is used to connect to the instance over an internal network.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "Port"
              ]
            }
          },
          "LatestKernelVersion": {
            "Description": "The latest minor engine version that is supported by the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "LatestKernelVersion"
              ]
            }
          },
          "ConsoleVersion": {
            "Description": "The type of the proxy that is used by the instance. Valid values:\n1: shared proxy\n2: dedicated proxy",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ConsoleVersion"
              ]
            }
          },
          "DBInstanceType": {
            "Description": "The type of the instance. Valid values:\nPrimary: primary instance\nReadonly: read-only instance\nGuard: disaster recovery instance\nTemp: temporary instance",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceType"
              ]
            }
          },
          "GeneralGroupName": {
            "Description": "The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "GeneralGroupName"
              ]
            }
          },
          "InstanceNetworkType": {
            "Description": "The network type of the instance. Valid values:\nClassic\nVPC",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "InstanceNetworkType"
              ]
            }
          },
          "DBInstanceClassType": {
            "Description": "The instance family to which the instance belongs. Valid values:\ns: shared instance family\nx: general-purpose instance family\nd: dedicated instance family\nh: dedicated host instance family",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceClassType"
              ]
            }
          },
          "AutoUpgradeMinorVersion": {
            "Description": "The method that is used to update the minor engine version of the instance. Valid values:\nAuto: automatic update.\nManual: manual update. The minor engine version of the instance is forcefully updated only when the in-use minor engine version is phased out.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "AutoUpgradeMinorVersion"
              ]
            }
          },
          "DBInstanceId": {
            "Description": "The instance ID.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceId"
              ]
            }
          },
          "DBInstanceStorage": {
            "Description": "The storage capacity of the instance. Unit: GB.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceStorage"
              ]
            }
          },
          "PGBouncerEnabled": {
            "Description": "Indicates whether PgBouncer is enabled.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "PGBouncerEnabled"
              ]
            }
          },
          "InstructionSetArch": {
            "Description": "The architecture type of the instance. Valid values:\nx86\narm",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "InstructionSetArch"
              ]
            }
          },
          "LockReason": {
            "Description": "The reason why the instance was locked.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "LockReason"
              ]
            }
          },
          "AvailabilityValue": {
            "Description": "The availability status of the instance in percentage.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "AvailabilityValue"
              ]
            }
          },
          "Engine": {
            "Description": "The database engine of the instance. Valid values:\nMySQL\nPostgreSQL\nSQLServer\nMariaDB",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "Engine"
              ]
            }
          },
          "DBInstanceDescription": {
            "Description": "The description of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceDescription"
              ]
            }
          },
          "IPType": {
            "Description": "The type of the IP address. Only IPv4 addresses are supported.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "IPType"
              ]
            }
          },
          "MaxIOMBPS": {
            "Description": "The maximum I/O throughput. Unit: MB/s.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "MaxIOMBPS"
              ]
            }
          },
          "DBInstanceDiskUsed": {
            "Description": "The disk usage of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceDiskUsed"
              ]
            }
          },
          "EngineVersion": {
            "Description": "The database engine version.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "EngineVersion"
              ]
            }
          },
          "MaxConnections": {
            "Description": "The maximum number of concurrent connections.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "MaxConnections"
              ]
            }
          },
          "DBInstanceStatus": {
            "Description": "The status of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceStatus"
              ]
            }
          },
          "DBInstanceClass": {
            "Description": "The instance type of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceClass"
              ]
            }
          },
          "AccountMaxQuantity": {
            "Description": "The maximum number of accounts that can be created on the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "AccountMaxQuantity"
              ]
            }
          },
          "VSwitchId": {
            "Description": "The vSwitch ID.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "VSwitchId"
              ]
            }
          },
          "TipsLevel": {
            "Description": "The severity level of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values:\n1: The instance is normal.\n2: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "TipsLevel"
              ]
            }
          },
          "LockMode": {
            "Description": "The lock mode of the instance. Valid values:\nUnlock: The instance is not locked.\nManualLock: The instance is manually locked.\nLockByExpiration: The instance is automatically locked due to instance expiration.\nLockByRestoration: The instance is automatically locked due to instance restoration.\nLockByDiskQuota: The instance is automatically locked due to exhausted storage space.\nLockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked due to exhausted storage.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "LockMode"
              ]
            }
          },
          "DeletionProtection": {
            "Description": "Indicates whether the release protection feature is enabled. Valid values:\ntrue\nfalse",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DeletionProtection"
              ]
            }
          },
          "PayType": {
            "Description": "The billing method of the instance. Valid values:\nPostpaid: pay-as-you-go\nPrepaid: subscription",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "PayType"
              ]
            }
          },
          "GuardDBInstanceId": {
            "Description": "The ID of the disaster recovery instance that is attached to the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "GuardDBInstanceId"
              ]
            }
          },
          "DBClusterNodes": {
            "Description": "The information about the node in the cluster.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBClusterNodes"
              ]
            }
          },
          "TimeZone": {
            "Description": "The time zone of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "TimeZone"
              ]
            }
          },
          "VpcId": {
            "Description": "The virtual private cloud (VPC) ID of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "VpcId"
              ]
            }
          },
          "MasterInstanceId": {
            "Description": "The ID of the primary instance.\nNote: If this parameter is not returned, the instance is the primary instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "MasterInstanceId"
              ]
            }
          },
          "CurrentKernelVersion": {
            "Description": "The minor engine version of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "CurrentKernelVersion"
              ]
            }
          },
          "CreationTime": {
            "Description": "The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "CreationTime"
              ]
            }
          },
          "ConnectionMode": {
            "Description": "The connection mode of the instance. Valid values:\nStandard: standard mode\nSafe: database proxy mode",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ConnectionMode"
              ]
            }
          },
          "VpcCloudInstanceId": {
            "Description": "The VPC ID.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "VpcCloudInstanceId"
              ]
            }
          },
          "ReadonlyInstanceSQLDelayedTime": {
            "Description": "The latency at which the system replicates data to read-only instances. The system replicates data from the primary instance to the read-only instances at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter. Unit: seconds.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ReadonlyInstanceSQLDelayedTime"
              ]
            }
          },
          "ProxyType": {
            "Description": "The type of the proxy that is supported by the instance. Valid values:\n0: The instance does not support database proxies.\n1: The instance supports shared proxies, with which the instance runs in multi-tenant mode.\n2: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ProxyType"
              ]
            }
          },
          "ConnectionString": {
            "Description": "The internal endpoint of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ConnectionString"
              ]
            }
          },
          "ExpireTime": {
            "Description": "The expiration time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.\nNote: Pay-as-you-go instances never expire.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ExpireTime"
              ]
            }
          },
          "AdvancedFeatures": {
            "Description": "The advanced features that are enabled for the instance. If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run SQL Server. Valid values:\nLinkedServer\nDistributeTransaction",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "AdvancedFeatures"
              ]
            }
          },
          "DBMaxQuantity": {
            "Description": "The maximum number of databases that can be created on the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBMaxQuantity"
              ]
            }
          },
          "Category": {
            "Description": "The RDS edition of the instance. Valid values:\nBasic: RDS Basic Edition\nHighAvailability: RDS High-availability Edition\ncluster: RDS Cluster Edition for ApsaraDB RDS for MySQL\nAlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server\nFinance: RDS Enterprise Edition\nServerless_basic: RDS Basic Edition for serverless instances",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "Category"
              ]
            }
          },
          "SuperPermissionMode": {
            "Description": "Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account.\nEnable\nDisabled",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "SuperPermissionMode"
              ]
            }
          },
          "DBInstanceNetType": {
            "Description": "The type of the network over which the instance is connected. Valid values:\nInternet: Internet\nIntranet: internal network",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceNetType"
              ]
            }
          },
          "DedicatedHostGroupId": {
            "Description": "The ID of the dedicated cluster.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DedicatedHostGroupId"
              ]
            }
          },
          "TempDBInstanceId": {
            "Description": "The ID of the temporary instance that is attached to the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "TempDBInstanceId"
              ]
            }
          },
          "DBInstanceCPU": {
            "Description": "The number of CPU cores.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceCPU"
              ]
            }
          },
          "SecurityIPList": {
            "Description": "The IP addresses in the IP address whitelist.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "SecurityIPList"
              ]
            }
          },
          "ReadOnlyDBInstanceIds": {
            "Description": "The IDs of the read-only instances that are attached to the primary instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ReadOnlyDBInstanceIds"
              ]
            }
          },
          "SecurityIPMode": {
            "Description": "The whitelist mode of the instance. Valid values:\nnormal: standard whitelist mode\nsafety: enhanced whitelist mode",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "SecurityIPMode"
              ]
            }
          },
          "MaintainTime": {
            "Description": "The maintenance window of the instance. The time is displayed in UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "MaintainTime"
              ]
            }
          },
          "ZoneId": {
            "Description": "The zone ID.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ZoneId"
              ]
            }
          },
          "Collation": {
            "Description": "The character set collation of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "Collation"
              ]
            }
          },
          "DBInstanceStorageType": {
            "Description": "The storage type of the instance. Valid values:\nlocal_ssd and ephemeral_ssd: local SSD\ncloud_ssd: standard SSD\ncloud_essd: enhanced SSD (ESSD)",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "DBInstanceStorageType"
              ]
            }
          },
          "MaxIOPS": {
            "Description": "The maximum number of I/O requests per second.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "MaxIOPS"
              ]
            }
          },
          "SlaveZones": {
            "Description": "The information about the zone of the secondary instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "SlaveZones"
              ]
            }
          },
          "Extra": {
            "Description": "The extended information of the instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "Extra"
              ]
            }
          },
          "ServerlessConfig": {
            "Description": "The settings of the serverless instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "ServerlessConfig"
              ]
            }
          },
          "BabelfishConfig": {
            "Description": "The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "BabelfishConfig"
              ]
            }
          },
          "Tips": {
            "Description": "The information about the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.",
            "Value": {
              "Fn::GetAtt": [
                "ExtensionDataSource",
                "Tips"
              ]
            }
          }
        }
      }
                              

      YAML格式

      ROSTemplateFormatVersion: '2015-09-01'
      Parameters:
        DBInstanceId:
          Description:
            en: The ID of the instance.
          Required: false
          Type: String
      Resources:
        ExtensionDataSource:
          Properties:
            DBInstanceId:
              Ref: DBInstanceId
          Type: DATASOURCE::RDS::DBInstance
      Outputs:
        AccountMaxQuantity:
          Description: The maximum number of accounts that can be created on the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - AccountMaxQuantity
        AdvancedFeatures:
          Description: 'The advanced features that are enabled for the instance. If multiple
            advanced features are enabled, the advanced features are separated by commas
            (,). This parameter is available only to instances that run SQL Server. Valid
            values:
      
            LinkedServer
      
            DistributeTransaction'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - AdvancedFeatures
        AutoUpgradeMinorVersion:
          Description: 'The method that is used to update the minor engine version of the
            instance. Valid values:
      
            Auto: automatic update.
      
            Manual: manual update. The minor engine version of the instance is forcefully
            updated only when the in-use minor engine version is phased out.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - AutoUpgradeMinorVersion
        AvailabilityValue:
          Description: The availability status of the instance in percentage.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - AvailabilityValue
        BabelfishConfig:
          Description: The configuration of the Babelfish feature for the ApsaraDB RDS for
            PostgreSQL instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - BabelfishConfig
        Category:
          Description: 'The RDS edition of the instance. Valid values:
      
            Basic: RDS Basic Edition
      
            HighAvailability: RDS High-availability Edition
      
            cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL
      
            AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server
      
            Finance: RDS Enterprise Edition
      
            Serverless_basic: RDS Basic Edition for serverless instances'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - Category
        Collation:
          Description: The character set collation of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - Collation
        ConnectionMode:
          Description: 'The connection mode of the instance. Valid values:
      
            Standard: standard mode
      
            Safe: database proxy mode'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ConnectionMode
        ConnectionString:
          Description: The internal endpoint of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ConnectionString
        ConsoleVersion:
          Description: 'The type of the proxy that is used by the instance. Valid values:
      
            1: shared proxy
      
            2: dedicated proxy'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ConsoleVersion
        CreationTime:
          Description: The creation time. The time follows the ISO 8601 standard in the
            yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - CreationTime
        CurrentKernelVersion:
          Description: The minor engine version of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - CurrentKernelVersion
        DBClusterNodes:
          Description: The information about the node in the cluster.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBClusterNodes
        DBInstanceCPU:
          Description: The number of CPU cores.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceCPU
        DBInstanceClass:
          Description: The instance type of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceClass
        DBInstanceClassType:
          Description: 'The instance family to which the instance belongs. Valid values:
      
            s: shared instance family
      
            x: general-purpose instance family
      
            d: dedicated instance family
      
            h: dedicated host instance family'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceClassType
        DBInstanceDescription:
          Description: The description of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceDescription
        DBInstanceDiskUsed:
          Description: The disk usage of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceDiskUsed
        DBInstanceId:
          Description: The instance ID.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceId
        DBInstanceMemory:
          Description: 'The memory capacity of the instance. Unit: MB.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceMemory
        DBInstanceNetType:
          Description: 'The type of the network over which the instance is connected. Valid
            values:
      
            Internet: Internet
      
            Intranet: internal network'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceNetType
        DBInstanceStatus:
          Description: The status of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceStatus
        DBInstanceStorage:
          Description: 'The storage capacity of the instance. Unit: GB.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceStorage
        DBInstanceStorageType:
          Description: 'The storage type of the instance. Valid values:
      
            local_ssd and ephemeral_ssd: local SSD
      
            cloud_ssd: standard SSD
      
            cloud_essd: enhanced SSD (ESSD)'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceStorageType
        DBInstanceType:
          Description: 'The type of the instance. Valid values:
      
            Primary: primary instance
      
            Readonly: read-only instance
      
            Guard: disaster recovery instance
      
            Temp: temporary instance'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceType
        DBMaxQuantity:
          Description: The maximum number of databases that can be created on the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DBMaxQuantity
        DedicatedHostGroupId:
          Description: The ID of the dedicated cluster.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DedicatedHostGroupId
        DeletionProtection:
          Description: 'Indicates whether the release protection feature is enabled. Valid
            values:
      
            true
      
            false'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - DeletionProtection
        Engine:
          Description: 'The database engine of the instance. Valid values:
      
            MySQL
      
            PostgreSQL
      
            SQLServer
      
            MariaDB'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - Engine
        EngineVersion:
          Description: The database engine version.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - EngineVersion
        ExpireTime:
          Description: 'The expiration time. The time follows the ISO 8601 standard in the
            yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
      
            Note: Pay-as-you-go instances never expire.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ExpireTime
        Extra:
          Description: The extended information of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - Extra
        GeneralGroupName:
          Description: The name of the dedicated cluster to which the instance belongs.
            This parameter is returned only when the instance is created in an ApsaraDB
            MyBase cluster that runs MySQL on Standard Edition.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - GeneralGroupName
        GuardDBInstanceId:
          Description: The ID of the disaster recovery instance that is attached to the
            instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - GuardDBInstanceId
        IPType:
          Description: The type of the IP address. Only IPv4 addresses are supported.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - IPType
        IncrementSourceDBInstanceId:
          Description: The ID of the instance from which incremental data comes. The incremental
            data of a disaster recovery instance or read-only instance comes from its primary
            instance. If this parameter is not returned, the instance is a primary instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - IncrementSourceDBInstanceId
        InstanceNetworkType:
          Description: 'The network type of the instance. Valid values:
      
            Classic
      
            VPC'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - InstanceNetworkType
        InstructionSetArch:
          Description: 'The architecture type of the instance. Valid values:
      
            x86
      
            arm'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - InstructionSetArch
        LatestKernelVersion:
          Description: The latest minor engine version that is supported by the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - LatestKernelVersion
        LockMode:
          Description: 'The lock mode of the instance. Valid values:
      
            Unlock: The instance is not locked.
      
            ManualLock: The instance is manually locked.
      
            LockByExpiration: The instance is automatically locked due to instance expiration.
      
            LockByRestoration: The instance is automatically locked due to instance restoration.
      
            LockByDiskQuota: The instance is automatically locked due to exhausted storage
            space.
      
            LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically
            locked due to exhausted storage.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - LockMode
        LockReason:
          Description: The reason why the instance was locked.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - LockReason
        MaintainTime:
          Description: The maintenance window of the instance. The time is displayed in
            UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console
            is equal to the value of this parameter plus 8 hours.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - MaintainTime
        MasterInstanceId:
          Description: 'The ID of the primary instance.
      
            Note: If this parameter is not returned, the instance is the primary instance.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - MasterInstanceId
        MasterZone:
          Description: The zone ID of the primary instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - MasterZone
        MaxConnections:
          Description: The maximum number of concurrent connections.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - MaxConnections
        MaxIOMBPS:
          Description: 'The maximum I/O throughput. Unit: MB/s.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - MaxIOMBPS
        MaxIOPS:
          Description: The maximum number of I/O requests per second.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - MaxIOPS
        PGBouncerEnabled:
          Description: Indicates whether PgBouncer is enabled.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - PGBouncerEnabled
        PayType:
          Description: 'The billing method of the instance. Valid values:
      
            Postpaid: pay-as-you-go
      
            Prepaid: subscription'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - PayType
        Port:
          Description: The port that is used to connect to the instance over an internal
            network.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - Port
        ProxyType:
          Description: 'The type of the proxy that is supported by the instance. Valid values:
      
            0: The instance does not support database proxies.
      
            1: The instance supports shared proxies, with which the instance runs in multi-tenant
            mode.
      
            2: The instance supports dedicated proxies, with which the instance runs in
            single-tenant mode.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ProxyType
        ReadOnlyDBInstanceIds:
          Description: The IDs of the read-only instances that are attached to the primary
            instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ReadOnlyDBInstanceIds
        ReadonlyInstanceSQLDelayedTime:
          Description: 'The latency at which the system replicates data to read-only instances.
            The system replicates data from the primary instance to the read-only instances
            at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter.
            Unit: seconds.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ReadonlyInstanceSQLDelayedTime
        ResourceGroupId:
          Description: The resource group ID.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ResourceGroupId
        SecurityIPList:
          Description: The IP addresses in the IP address whitelist.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - SecurityIPList
        SecurityIPMode:
          Description: 'The whitelist mode of the instance. Valid values:
      
            normal: standard whitelist mode
      
            safety: enhanced whitelist mode'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - SecurityIPMode
        ServerlessConfig:
          Description: The settings of the serverless instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ServerlessConfig
        SlaveZones:
          Description: The information about the zone of the secondary instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - SlaveZones
        SuperPermissionMode:
          Description: 'Indicates whether the instance supports superuser accounts, such
            as the system administrator (SA) account, the Active Directory (AD) account,
            and the host account.
      
            Enable
      
            Disabled'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - SuperPermissionMode
        TempDBInstanceId:
          Description: The ID of the temporary instance that is attached to the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - TempDBInstanceId
        TimeZone:
          Description: The time zone of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - TimeZone
        Tips:
          Description: The information about the exception that is detected on the instance.
            This parameter is returned only when the instance is created in an ApsaraDB
            MyBase cluster that runs MySQL on Standard Edition.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - Tips
        TipsLevel:
          Description: 'The severity level of the exception that is detected on the instance.
            This parameter is returned only when the instance is created in an ApsaraDB
            MyBase cluster that runs MySQL on Standard Edition. Valid values:
      
            1: The instance is normal.
      
            2: The specifications of the read-only instances do not match the specifications
            of the primary instance. You must adjust the specifications of these instances
            based on your business requirements.'
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - TipsLevel
        VSwitchId:
          Description: The vSwitch ID.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - VSwitchId
        VpcCloudInstanceId:
          Description: The VPC ID.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - VpcCloudInstanceId
        VpcId:
          Description: The virtual private cloud (VPC) ID of the instance.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - VpcId
        ZoneId:
          Description: The zone ID.
          Value:
            Fn::GetAtt:
            - ExtensionDataSource
            - ZoneId
                              
  5. 配置参数。

    参数名称

    是否必填

    参数说明

    示例

    资源栈名称

    资源栈的名称。

    Rds_Test

    DBInstanceId

    RDS实例ID。

    rm-bp1tuz16pa5x8****

    配置资源栈

    资源栈配置参数。

    请参见配置资源栈参数

  6. 单击创建

  7. 创建资源栈成功后,单击输出页签,查看实例详情信息。

    image