文档

资源编排ROS集成示例

更新时间:

本文为您介绍RAM用户如何使用资源编排(ROS)查询云数据库ClickHouse的集群信息。

前提条件

使用资源编排需要RAM用户权限,需要您创建一个RAM用户,并为其添加以下权限。

  • 具备管理资源编排服务所有操作的权限AliyunROSFullAccess

  • 具备管理ClickHouse所有操作的权限AliyunClickHouseFullAccess

    说明

    为了便于演示,本示例使用AliyunClickHouseFullAccess权限策略,在实际项目中,请根据业务的实际情况按需分配权限后进行接口调用。ClickHouse的权限策略,请参见基于身份的策略

操作步骤

  1. 登录资源编排ROS控制台,单击顶部导航栏地域下拉框,选择您需要的地域。

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

    • 指定模板:选中选择已有模板

    • 模板录入方式:选中输入模板

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

    以下是用于查询ClickHouse集群信息的ROS资源的模板代码,更多详情,请参见DATASOURCE::ClickHouse::DBClusters

    YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DBClusterId:
        Description: Instance ID.
        Type: String
      DBClusterName:
        Description: The cluster description information.
        Type: String
    Resources:
      ExtensionDataSource:
        Properties:
          DBClusterId:
            Ref: DBClusterId
          DBClusterName:
            Ref: DBClusterName
        Type: DATASOURCE::ClickHouse::DBClusters
    Outputs:
      DBClusterIds:
        Description: The list of db cluster IDs.
        Value:
          Fn::GetAtt:
          - ExtensionDataSource
          - DBClusterIds
      DBClusters:
        Description: The list of db clusters.
        Value:
          Fn::GetAtt:
          - ExtensionDataSource
          - DBClusters

    JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DBClusterName": {
          "Type": "String",
          "Description": "The cluster description information."
        },
        "DBClusterId": {
          "Type": "String",
          "Description": "Instance ID."
        }
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::ClickHouse::DBClusters",
          "Properties": {
            "DBClusterName": {
              "Ref": "DBClusterName"
            },
            "DBClusterId": {
              "Ref": "DBClusterId"
            }
          }
        }
      },
      "Outputs": {
        "DBClusterIds": {
          "Description": "The list of db cluster IDs.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DBClusterIds"
            ]
          }
        },
        "DBClusters": {
          "Description": "The list of db clusters.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DBClusters"
            ]
          }
        }
      }
    }
  4. 单击下一步

  5. 创建资源栈页面,配置以下参数。

    为了便于演示,此处只提供了本示例的必填参数,更多创建资源栈的参数说明,请参见使用ROS模板创建资源栈

    参数名称

    是否必填

    参数说明

    示例

    资源栈名称

    资源栈的名称。

    getClickHouseInfoTest

    DBClusterId

    集群ID。

    cc-bp1gf42v00340****

    DBClusterName

    集群名称。

    testROS

  6. 单击创建

    image

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