UpdateStack_资源编排_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

请求中 Parameters 和 UsePreviousParameters 取值相关。若 Parameters 中未指定模板中定义的参数:

  • 当 UsePreviousParameters 取值为 false 时:如果模板中参数有默认值,则使用默认值;如果模板中参数没有默认值,则需要在 Parameters 中指定该参数。

  • 当 UsePreviousParameters 取值为 true 时:如果创建资源栈时指定了该参数,则使用指定值;如果创建资源栈时未指定该参数,参数在模板中有默认值,则使用默认值。

本文将提供一个示例,将北京地域 ID 为4a6c9851-3b0f-4f5f-b4ca-a14bf691****的资源栈的模板内容更新为{"ROSTemplateFormatVersion": "2015-09-01"}

流控信息

请求速率为100/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ros:UpdateStack
Update
stack
acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

请求参数

字段名称字段详情
StackIdstring

资源栈 ID。

示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691****参考取值来源:
    ListStacks
    CreateStack
    GetStackInstance
ClientTokenstring

保证请求的幂等性。此参数值由客户端生成,并且必须全局唯一。 展开详情

示例值:123e4567-e89b-12d3-a456-42665544****
StackPolicyDuringUpdateBodystring

临时覆盖资源栈策略主体的结构。长度为 1~16,384 个字节。 展开详情

示例值:{"Statement": [{"Effect": "Allow", "Action": "Update:*", "Principal": "*", "Resource": "*"}]}
TimeoutInMinutesinteger<int64>

更新资源栈的超时时间。 展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:10
TemplateBodystring

模板主体的结构。长度为 1~524,288 个字节。 如果长度较大,则建议通过 HTTP POST+Body Param 的方式,将参数放在请求体中进行传递,避免 URL 过长而导致请求失败。 展开详情

示例值:{"ROSTemplateFormatVersion": "2015-09-01"}参考取值来源:
    GetTemplate
    UpdateStackTemplateByResources
    GenerateTemplateByScratch
StackPolicyURLstring

包含资源栈策略的文件的位置。URL 必须指向位于 Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储空间(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)的策略,策略的文件最大值为 16,384 个字节。如未指定 OSS 地域,默认与接口参数 RegionId 相同。 展开详情

示例值:oss://ros-stack-policy/demo
StackPolicyDuringUpdateURLstring

更新资源栈策略的文件的位置。URL 必须指向位于 Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储空间(例如:oss://ros/stack-policy/demo、oss://ros/stack-policy/demo?RegionId=cn-hangzhou)中的策略,策略的文件最大值为 16,384 个字节。 展开详情

示例值:oss://ros-stack-policy/demo
StackPolicyBodystring

资源栈策略主体的结构,长度为 1~16,384 个字节。 展开详情

示例值:{"Statement": [{"Action": "Update:*", "Resource": "*", "Effect": "Allow", "Principal": "*"}]}参考取值来源:
    GetStackPolicy
    PreviewStack
UsePreviousParametersboolean

未传递的参数是否使用上次传递的值。展开详情

示例值:true
RegionIdstring

资源栈所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

示例值:cn-beijing参考取值来源:
    DescribeRegions
deprecatedDisableRollbackboolean

资源栈更新失败时,是否强制回滚。展开详情

示例值:false
TemplateURLstring

包含模板主体的文件的位置。URL 必须指向位于 HTTP Web 服务器(HTTP 或 HTTPS)或阿里云 OSS 存储空间中的模板(1~524,288 个字节)。OSS 存储空间的 URL,例如 oss://ros/template/demo 或 oss://ros/template/demo?RegionId=cn-hangzhou。如未指定 OSS 地域,默认与接口参数 RegionId 相同。展开详情

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

RAM 角色名称。ROS 会扮演该角色创建资源栈,使用角色的凭证代表用户进行接口调用。 展开详情

示例值:test-role
ReplacementOptionstring

是否使用替换更新。当资源属性不支持修改更新时,可以使用替换更新改变资源属性。替换更新会删除资源后重新创建资源,新资源物理 ID 会发生变化。展开详情

示例值:Disabled
TemplateIdstring

模板 ID。支持共享模板和私有模板。展开详情

示例值:5ecd1e10-b0e9-4389-a565-e4c15efc****参考取值来源:
    GetTemplate
    UpdateTemplate
    ListTemplates
    CreateTemplate
TemplateVersionstring

模板版本。仅在指定 TemplateId 时生效。

示例值:v1参考取值来源:
    ListTemplateVersions
    GetTemplate
    UpdateTemplate
Parametersarray<object>

参数。

子级条数 <= 200
Tagsarray<object>

资源栈的标签。

子级条数 <= 20
Parallelisminteger<int64>

资源最大并发数。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmxazb4ph6aiy****参考取值来源:
    GetStackGroup
    ListStackGroups
DryRunboolean

此次请求是否只进行检验。取值:展开详情

示例值:false
DryRunOptionsarray<string>

校验选项列表。列表最大长度为 1。展开详情

子级条数 <= 1

请求说明

关于公共请求参数的详情,请参见公共参数

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:B288A0BE-D927-4888-B0F7-B35EF84B6E6F
StackIdstring

资源栈 ID。

示例值:4a6c9851-3b0f-4f5f-b4ca-a14bf691****
DryRunResultobject

校验结果。仅在 DryRun 为 true 时返回。

返回示例

变更历史

变更时间变更内容概要操作
2024-01-11
变更请求参数TemplateBody
2023-07-27
新增请求参数DryRunOptions
删除返回参数

相关示例

调用UpdateStack接口更新资源栈。
2022-09-19