文档

自定义创建资源栈页面

更新时间:

如果您希望通过URL跳转到一个预先配置了相关属性的ROS创建资源栈页面,可以选择定制ROS创建资源栈页面来完成这一集成。这将使您能够在快速启动特定配置的资源栈创建流程,减少手动输入和选择的步骤,从而提高效率。

编写定制页面的URL

本文以创建一个名为MyStack的资源栈为例,其中包含从指定模板创建的RAM角色,该角色名称被参数化为CustomRole,并且页面标题被设置为创建RAM角色

  • 示例URL

    说明

    您可直接访问此URL查看效果。

    #此处换行是为了方便讲解,实际使用中请勿换行。
    https://ros.console.aliyun.com/cn-hangzhou/stacks/create?
    step=2&exampleTemplateUrl=http://ros-template.cn-hangzhou.oss.aliyun-inc.com/ECS_Ram_Role.json&stackNamePrefix=MyStack&parameters={"RoleName":"CustomRole"}&isSimplified=true&productNavBar=disabled&pageTitle={"zh-cn": "创建RAM角色", "en": "Create RAM Role"}
  • 访问或浏览器加载此URL时,会发送一个GET请求到指定的ROS控制台URL,并且ROS服务会根据提供的查询参数来定制化展示创建资源栈的页面。

    image

解析定制页面的URL

示例URL中,根据?可以分为两部分。

  • 基本部分即访问路径。

    https://ros.console.aliyun.com/cn-hangzhou/stacks/create
    • 指定了要访问的资源路径,即ROS控制台中的创建资源栈页面。

    • 其中cn-hangzhou为该资源栈在杭州区域创建,您可根据实际情况替换区域 ID,请参见ROS地域列表

  • 定制参数 。

    #此处换行是为了方便讲解,实际使用中请勿换行。
    step=2&
    exampleTemplateUrl=http://ros-template.cn-hangzhou.oss.aliyun-inc.com/ECS_Ram_Role.json&
    stackNamePrefix=MyStack&
    parameters={"RoleName":"CustomRole"}&
    isSimplified=true&
    productNavBar=disabled&
    pageTitle={"zh-cn": "创建RAM角色", "en": "Create RAM Role"}

    定制参数由一系列键值对组成,这些键值对之间用&符号分隔。每个键值对用于设置特定的页面配置选项,这些参数用于定制创建资源栈页面的初始状态和外观,示例包括以下内容,更多参数,请参见支持定制的参数

    键值对

    参数

    取值

    表示的含义

    step=2

    step

    2

    创建资源栈默认直接跳转到配置参数步骤。

    exampleTemplateUrl=http://ros-template.cn-hangzhou.oss.aliyun-inc.com/ECS_Ram_Role.json

    exampleTemplateUrl

    http://ros-template.cn-hangzhou.oss.aliyun-inc.com/ECS_Ram_Role.json

    使用指定的模板URL加载模板:ECS实例RAM角色

    stackNamePrefix=MyStack

    stackNamePrefix

    MyStack

    设置资源栈名称前缀为MyStack。

    parameters={"RoleName":"CustomRole"}

    parameters

    {"RoleName":"CustomRole"}

    设置模板参数RoleName为CustomRole。

    isSimplified=true

    isSimplified

    true

    使用简版创建页面。

    productNavBar=disabled

    productNavBar

    disabled

    隐藏页面左侧的产品导航栏。

    pageTitle={"zh-cn": "创建RAM角色", "en": "Create RAM Role"}

    pageTitle

    {"zh-cn": "创建RAM角色", "en": "Create RAM Role"}

    页面标题为创建RAM角色。

支持定制的参数

名称

类型

描述

约束及示例

step

number

指定创建资源栈的默认步骤。

取值:

  • 0:选择模板。

  • 1:配置参数。

  • 2:合规预检。

  • 3:检查并确认。

当isSimplified参数取值为true时,该参数取值为2、3不生效。

stackName

string

指定资源栈名称。

示例值:MyStack。

该参数与stackNamePrefix参数选其一配置。

stackNamePrefix

string

指定资源栈名称前缀,其余部分随机生成。

示例值:MyPrefix。

该参数与stackName参数选其一配置。

stackId

string

指定克隆的资源栈ID。

示例值:91062917-1467-4f66-ab7a-f176c3ae****。

该参数与privateTemplateId、exampleTemplateUrl、templateUrl选其一配置。

pageTitle

map

指定定制页面的标题。

支持国际化,形式为JSON类型的字符串。

示例值:{"zh-cn":"创建服务","en":"Create Service"}。

productNavBar

string

隐藏页面左侧菜单栏。

取值:

  • 无(默认值):显示左侧菜单栏。

  • disabled:隐藏左侧菜单栏。

disableNavigation

boolean

是否隐藏顶部面包屑导航。

取值:

  • true:隐藏顶部面包屑导航。

  • false(默认值):显示顶部面包屑导航 。

hideTitle

boolean

是否隐藏页面标题。

取值:

  • true:隐藏页面标题。

  • false(默认值):显示页面标题。

hideStepRow

boolean

是否隐藏页面上方步骤条。

取值:

  • true:隐藏页面上方步骤条。

  • false(默认值):显示页面上方步骤条。

timeoutMins

number

资源栈操作超时时间。

单位:分钟。

默认值:60。

取值范围:10~1440。

示例值:60。

disableRollback

boolean

资源栈操作失败时是否回滚。

取值:

  • true:操作失败回滚。

  • false(默认值):操作失败不回滚。

showTag

boolean

是否显示标签设置。

取值:

  • true:显示标签设置。

  • false:不显示标签设置。

privateTemplateId

string

指定我的模板ID。

示例:5ecd1e10-b0e9-4389-a565-e4c15efc****。

该参数与exampleTemplateUrl、templateUrl、stackId选其一配置。

privateTemplateVersion

string

指定我的模板版本。

示例:v1。

当您设置privateTemplateId参数时,可以选择设置该参数。

exampleTemplateUrl

string

指定模板示例URL。

示例值:oss://ros-template/demo

该参数与privateTemplateId、templateUrl、stackId选其一配置。

templateType

string

模板录入方式。

取值:

  • url:使用URL。

  • text:输入模板。

  • my_tpl:我的模板。

  • share_tpl:共享模板。

templateUrl

string

指定模板URL,ROS会根据这个参数去解析对应模板内容。

URL必须指向位于Web服务器(HTTP或HTTPS)或阿里云OSS存储空间(例如:oss://ros/stack-policy/demooss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的模板,模板的最大长度为524,288个字节。如未指定OSS地域,默认与RegionId取值相同。

示例值:oss://ros-template/demo

该参数与privateTemplateId、exampleTemplateUrl、stackId选其一配置。

hideTemplateSelector

boolean

是否隐藏模板录入方式。

取值:

  • true:隐藏模板录入方式。

  • false(默认值):显示模板录入方式。

parameters

string

指定模板的参数。

形式为JSON类型的字符串。

示例值:{"ZoneId":"cn-beijing-c"}。

createType

string

创建类型。

取值:

  • 无:创建资源栈。

  • import:资源导入。

isSimplified

boolean

是否使用简版创建页面。

取值:

  • true:使用简版创建页面。

  • false(默认值):不使用简版创建页面。

tags

map

设置标签。

形式为JSON类型的字符串。

示例值:{"key1": "value1", "key2": "value2"}。

当showTag参数设置为false时,该参数不生效。

immutableTags

map

指定不可修改的标签。

形式为JSON类型的字符串。

示例值:{"key1": "value1", "key2": "value2"}。

notificationURLs

string

资源栈事件的回调地址。

形式为List类型的字符串。

示例值:["url1", "url2"]。

immutableNotificationURLs

string

指定不可修改的资源栈事件回调地址。

形式为List类型的字符串。

示例值:["url1", "url2"]。