资源编排资源栈组相关接口有什么? -问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文

资源编排资源栈组相关接口有什么?

小天使爱美 2020-03-24 19:13:19 120

资源编排资源栈组相关接口有什么?

分享到
取消 提交回答
全部回答(1)
  • 小天使爱美
    2020-03-24 19:21:24

    调用CreateStackGroup接口创建资源栈组。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 CreateStackGroup 系统规定参数。取值:CreateStackGroup。

    Parameters.N.ParameterKey String 是 Amount 参数的名称。 如果未指定特定参数的名称和值,则ROS将使用模板中指定的默认值。

    N最大值为200。

    Parameters.N.ParameterValue String 是 12 参数的值。

    N最大值为200。

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

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    Description String 否 StackGroup Description 资源栈组描述。长度限制:1~256个字符。

    TemplateBody String 否 {"ROSTemplateFormatVersion":"2015-09-01"} 模板的结构。长度为1~51200个字节。您必须指定TemplateBody或TemplateURL参数,但不能同时指定两者。

    TemplateURL String 否 oss://ros-template/demo 包含模板主体的文件的位置。URL必须指向位于HTTP Web服务器(HTTP或HTTPS),或阿里云OSS存储桶(例如oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou。OSS地域如未指定,默认与接口参数RegionId相同。)中的模板(最大大小:524288个字节)。

    您必须指定TemplateBody或TemplateURL参数,但不能同时指定两者。

    ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。 该值由客户端生成,并且必须是全局唯一的。 仅允许使用英文字母(区分大小写)、数字、字符、连字符和下划线。它最多可包含64个字符。更多详情,请参见如何保证幂等性。

    AdministrationRoleName String 否 AliyunROSStackGroupAdministrationRole 用来供ROS服务扮演的RAM管理员角色名称。ROS会以该角色身份进一步扮演执行角色来操作资源栈组中资源栈实例所对应的资源栈。

    仅在使用自定义管理员角色来控制哪些用户或组可以管理同一管理员账号中的特定资源栈组时,才指定RAM角色。若不指定,则使用AliyunROSStackGroupAdministrationRole作为默认值。

    长度限制:1~64个字符。允许英文字母(区分大小写)、数字或连字符。

    ExecutionRoleName String 否 AliyunROSStackGroupExecutionRole 用来供管理员角色扮演的RAM执行角色名称。ROS以该角色身份来操作资源栈组中资源栈实例所对应的资源栈。

    若不指定,则使用AliyunROSStackGroupExecutionRole作为默认值。

    长度限制:1~64个字符。允许英文字母(区分大小写)、数字或连字符。

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    StackGroupId String 2c036e78-9e82-428e-afd6-177f5d04db9d 资源栈组ID。

    示例 请求示例

    http(s)://[Endpoint]/?Action=CreateStackGroup &Parameters.1.ParameterKey=Amount &Parameters.1.ParameterValue=12 &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    fd0ddef9-9540-4b42-a464-94f7783501d0 FEA9B039-1062-4C7F-8659-CB02B9C68017 JSON 格式

    { "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "RequestId": "FEA9B039-1062-4C7F-8659-CB02B9C68017" } 错误码 访问错误中心查看更多错误码。调用DeleteStackGroup接口删除资源栈组。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 RegionId String 是 cn-hangzhou 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    示例 请求示例

    http(s)://[Endpoint]/?Action=DeleteStackGroup &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    14A07460-EBE7-47CA-9757-12CC4761D47A JSON 格式

    { "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A" } 错误码 访问错误中心查看更多错误码。调用GetStackGroup接口查询指定资源栈组的信息。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetStackGroup 系统规定参数。取值:GetStackGroup。

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

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    StackGroup Struct 资源栈组详情。

    示例 请求示例

    http(s)://[Endpoint]/?Action=GetStackGroup &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    ACTIVE fd0ddef9-9540-4b42-a464-94f7783501d0 AliyunROSStackGroupAdministrationRole 2015-09-01 MyStackGroup AliyunROSStackGroupExecutionRole 2020-02-27T07:47:47 DRIFTED COMPLETED 1 0 0 0 1 2 B494A424-77FE-426A-AF1F-A720B4D80DBE JSON 格式

    { "StackGroup": { "Status": "ACTIVE", "Parameters": [], "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole", "TemplateBody": { "ROSTemplateFormatVersion": "2015-09-01" }, "StackGroupName": "MyStackGroup", "ExecutionRoleName": "AliyunROSStackGroupExecutionRole" }, "StackGroupDriftDetectionDetail": { "DriftDetectionTime": "2020-02-27T07:47:47", "StackGroupDriftStatus": "DRIFTED", "DriftDetectionStatus": "COMPLETED", "DriftedStackInstancesCount": 1, "FailedStackInstancesCount": 0, "CancelledStackInstancesCount": 0, "InProgressStackInstancesCount": 0, "InSyncStackInstancesCount": 1, "TotalStackInstancesCount": 2 }, "RequestId": "B494A424-77FE-426A-AF1F-A720B4D80DBE" } 错误码 访问错误中心查看更多错误码。调用ListStackGroups接口查询资源栈组列表。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListStackGroups 系统规定参数。取值:ListStackGroups。

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

    Status String 是 ACTIVE 资源栈组状态。取值范围:

    ACTIVE DELETED PageSize Long 否 10 分页查询时设置的每页行数。

    取值范围:1~50。

    默认值:10。

    PageNumber Long 否 1 分页查询时设置的页码。起始值:1。默认值:1。

    返回数据 名称 类型 示例值 描述 PageNumber Integer 1 分页查询时设置的页码。

    PageSize Integer 10 分页查询时设置的每页行数。

    RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    StackGroups Array 资源栈组列表。

    TotalCount Integer 1 查询到的资源栈组总数。

    示例 请求示例

    http(s)://[Endpoint]/?Action=ListStackGroups &RegionId=cn-hangzhou &Status=ACTIVE &<公共请求参数> 正常返回示例

    XML 格式

    1 1 10 6523DA68-4FA0-410E-BA85-82F91F5DCD48 ACTIVE fd0ddef9-9540-4b42-a464-94f7783501d0 MyStackGroup 2020-02-27T07:47:47 IN_SYNC JSON 格式

    { "PageNumber": 1, "TotalCount": 1, "PageSize": 10, "RequestId": "6523DA68-4FA0-410E-BA85-82F91F5DCD48", "StackGroups": [ { "Status": "ACTIVE", "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "StackGroupName": "MyStackGroup", "DriftDetectionTime": "2020-02-27T07:47:47", "StackGroupDriftStatus": "IN_SYNC" } ] } 错误码 访问错误中心查看更多错误码。调用UpdateStackGroup接口更新资源栈组。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 UpdateStackGroup 系统规定参数。取值:UpdateStackGroup。

    Parameters.N.ParameterKey String 是 Amount 参数的名称。 如果未指定特定参数的名称和值,则ROS将使用模板中指定的默认值。

    N最大值为200。

    Parameters.N.ParameterValue String 是 1 参数的值。

    N最大值为200。

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

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    Description String 否 My Stack Group 资源栈组描述。

    取值范围:1~256个字符。

    AccountIds Json 否 ["123456"] 目标执行账号列表。类型为Json列表。列表长度不超过20。

    RegionIds Json 否 ["cn-hangzhou", "cn-beijing"] 目标执行地域列表。类型为Json列表。列表长度不超过20。

    TemplateBody String 否 { "ROSTemplateFormatVersion": "2015-09-01" } 模板主体的结构。长度为1~524288个字节。如果长度较大,则建议通过HTTP POST+Body Param的方式,将参数放在请求体中进行传递,避免URL过长而导致请求失败。您必须指定参数TemplateBody或TemplateURL,但不能同时指定。

    TemplateURL String 否 oss://ros-template/demo 包含模板主体的文件的位置。URL必须指向位于HTTP Web服务器(HTTP或HTTPS),或阿里云OSS存储桶(例如oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou。OSS地域如未指定,默认与接口参数RegionId相同。)中的模板(最大大小:524288个字节)。

    您必须指定TemplateBody或TemplateURL参数,但不能同时指定。

    ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。 该值由客户端生成,并且必须是全局唯一的。 仅允许使用字母数字字符(区分大小写),连字符和下划线。 它最多可包含64个字符。更多详情,请参见如何保证幂等性。

    OperationDescription String 否 Update stack instances in hangzhou 操作描述。描述该操作的目的或行为。

    OperationPreferences Json 否 {"FailureToleranceCount": 1, "MaxConcurrentCount": 2} 操作设置。类型为Json字典。可包含如下字段:

    FailureToleranceCount 失败容错数。一个资源栈组操作中,若操作结果的失败总数不超过失败容错数,操作则成功,反之则失败。

    若不指定FailureToleranceCount,则默认为0。不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    取值范围:0~20。

    FailureTolerancePercentage 失败容错百分比。一个资源栈组操作中,若操作结果的失败百分比不超过失败容错百分比,操作则成功,反之则失败。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    取值范围:0~100。

    MaxConcurrentCount 最大账号并发数。一个资源栈组操作中,最多能有多少个账号同时执行。

    不能同时指定MaxConcurrentCount和MaxConcurrentPercentage。

    取值范围:1~20。

    MaxConcurrentPercentage 最大账号并发百分比。一个资源栈组操作中,最多能有多少百分比的账号同时执行。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    取值范围:1~100。

    AdministrationRoleName String 否 AliyunROSStackGroupAdministrationRole 用来供ROS服务扮演的RAM管理员角色名称。ROS会以该角色身份进一步扮演执行角色来操作资源栈组中资源栈实例所对应的资源栈。

    仅在使用自定义管理员角色来控制哪些用户或组可以管理同一管理员账号中的特定资源栈组时,才指定RAM角色。若不指定,则使用AliyunROSStackGroupAdministrationRole作为默认值。

    取值范围:1~64个字符。允许英文字母(区分大小写)、数字或连字符。

    ExecutionRoleName String 否 AliyunROSStackGroupExecutionRole 用来供管理员角色扮演的RAM执行角色名称。ROS以该角色身份来操作资源栈组中资源栈实例所对应的资源栈。

    若不指定,则使用AliyunROSStackGroupExecutionRole作为默认值。

    取值范围:1~64个字符。允许英文字母(区分大小写)、数字或连字符。

    返回数据 名称 类型 示例值 描述 OperationId String 6da106ca-1784-4a6f-a7e1-e723863dc75a 操作ID。

    RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    示例 请求示例

    http(s)://[Endpoint]/?Action=UpdateStackGroup &Parameters.1.ParameterKey=Amount &Parameters.1.ParameterValue=1 &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    14A07460-EBE7-47CA-9757-12CC4761D47A 6da106ca-1784-4a6f-a7e1-e723863dc75a JSON 格式

    { "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863dc75a" } 错误码 访问错误中心查看更多错误码。调用CreateStackInstances接口在特定账号和地域下创建资源栈实例。

    资源栈实例是指特定账号和地域中的资源栈。账号和地域是必填参数——您必须至少指定一个账号和一个地域。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 AccountIds Json 是 ["123456"] 目标执行账号列表。类型为Json列表。列表长度不超过20。

    ParameterOverrides.N.ParameterKey String 是 Amount 覆盖参数的名称。 如果未指定特定参数的名称和值,ROS将使用创建资源栈组时所指定的参数。

    N最大值为200。

    ParameterOverrides.N.ParameterValue String 是 1 覆盖参数的值。如果未指定特定参数的名称和值,ROS将使用创建资源栈组时所指定的参数。

    N最大值为200。

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

    RegionIds Json 是 ["cn-hangzhou", "cn-beijing"] 目标执行地域列表。类型为Json列表。列表长度不超过20。

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。 该值由客户端生成,并且必须是全局唯一的。 仅允许使用英文字母(区分大小写)、数字、字符、连字符和下划线。它最多可包含64个字符。更多详情,请参见如何保证幂等性。

    OperationDescription String 否 Create stack instances in hangzhou and beijing 操作描述。描述该操作的目的或行为。

    长度限制:1~256个字符。

    OperationPreferences Json 否 {"FailureToleranceCount": 1, "MaxConcurrentCount": 2} 操作设置。类型为Json字典。可包含如下字段:

    FailureToleranceCount 失败容错数。一个资源栈组操作中,若操作结果的失败总数不超过失败容错数,操作则成功,反之则失败。

    若不指定FailureToleranceCount,则默认为0。不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:0~20

    FailureTolerancePercentage 失败容错百分比。一个资源栈组操作中,若操作结果的失败百分比不超过失败容错百分比,操作则成功,反之则失败。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:0~100

    MaxConcurrentCount 最大账号并发数。一个资源栈组操作中,最多能有多少个账号同时执行。

    不能同时指定MaxConcurrentCount和MaxConcurrentPercentage。

    范围限制:1~20

    MaxConcurrentPercentage 最大账号并发百分比。一个资源栈组操作中,最多能有多少百分比的账号同时执行。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:1~100

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    OperationId String 6da106ca-1784-4a6f-a7e1-e723863dc75a 操作ID。

    示例 请求示例

    http(s)://[Endpoint]/?Action=CreateStackInstances &AccountIds=["123456"] &ParameterOverrides.1.ParameterKey=Amount &ParameterOverrides.1.ParameterValue=1 &RegionId=cn-hangzhou &RegionIds=["cn-hangzhou", "cn-beijing"] &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    14A07460-EBE7-47CA-9757-12CC4761D47A 6da106ca-1784-4a6f-a7e1-e723863dc75a JSON 格式

    { "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863dc75a" } 错误码 访问错误中心查看更多错误码。调用GetStackInstance接口查询指定资源栈组关联的资源栈实例的详细信息。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetStackInstance 系统规定参数。取值:GetStackInstance。

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

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    StackInstanceAccountId String 是 123456 资源栈实例所属账号。

    StackInstanceRegionId String 是 cn-beijing 资源栈实例所属地域。

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    StackInstance Struct 资源栈实例详情。

    示例 请求示例

    http(s)://[Endpoint]/?Action=GetStackInstance &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &StackInstanceAccountId=123456 &StackInstanceRegionId=cn-beijing &<公共请求参数> 正常返回示例

    XML 格式

    B8A6B693-82C8-419D-8796-DE99EC33CFF9 CURRENT fd0ddef9-9540-4b42-a464-94f7783501d0 123456 MyStackGroup 35ad60e3-6a92-42d8-8812-f0700d450971 cn-hangzhou 2020-02-27T07:47:47 IN_SYNC JSON 格式

    { "RequestId": "B8A6B693-82C8-419D-8796-DE99EC33CFF9", "StackInstance": { "Status": "CURRENT", "StatusReason": "", "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "ParameterOverrides": [], "AccountId": "123456", "StackGroupName": "MyStackGroup", "StackId": "35ad60e3-6a92-42d8-8812-f0700d450971", "RegionId": "cn-hangzhou", "DriftDetectionTime": "2020-02-27T07:47:47", "StackDriftStatus": "IN_SYNC" } } 错误码 访问错误中心查看更多错误码。调用ListStackInstances接口查询指定资源栈组关联的资源栈实例列表。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ListStackInstances 系统规定参数。取值:ListStackInstances。

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

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    StackInstanceAccountId String 否 123456 资源栈实例所属账号。

    StackInstanceRegionId String 否 cn-beijing 资源栈实例所属地域。

    PageSize Long 否 10 分页查询时设置的每页行数。

    取值范围:1~50。

    默认值:10。

    PageNumber Long 否 1 分页查询时设置的页码。

    起始值:1。

    默认值:1。

    返回数据 名称 类型 示例值 描述 PageNumber Integer 1 分页查询时设置的页码。

    PageSize Integer 10 分页查询时设置的每页行数。

    RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    StackInstances Array 资源栈实例列表。

    TotalCount Integer 1 查询到的总数。

    示例 请求示例

    http(s)://[Endpoint]/?Action=ListStackInstances &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    1 1 10 CURRENT fd0ddef9-9540-4b42-a464-94f7783501d0 123456 35ad60e3-6a92-42d8-8812-f0700d450971 MyStackGroup cn-hangzhou 2020-02-27T07:47:47 IN_SYNC 85DE34BD-7FF9-480F-8C21-556E9DA93ACD JSON 格式

    { "PageNumber": 1, "TotalCount": 1, "PageSize": 10, "StackInstances": [ { "StatusReason": "", "Status": "CURRENT", "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "AccountId": "123456", "StackId": "35ad60e3-6a92-42d8-8812-f0700d450971", "StackGroupName": "MyStackGroup", "RegionId": "cn-hangzhou", "DriftDetectionTime": "2020-02-27T07:47:47", "StackDriftStatus": "IN_SYNC" } ], "RequestId": "85DE34BD-7FF9-480F-8C21-556E9DA93ACD" } 错误码 访问错误中心查看更多错误码。调用GetStackGroupOperation查询资源栈组操作的信息。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetStackGroupOperation 系统规定参数。取值:GetStackGroupOperation。

    OperationId String 是 6da106ca-1784-4a6f-a7e1-e723863dc75a 资源栈组操作ID。

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

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    StackGroupOperation Struct 资源栈组详情。

    示例 请求示例

    http(s)://[Endpoint]/?Action=GetStackGroupOperation &OperationId=6da106ca-1784-4a6f-a7e1-e723863dc75a &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例

    XML 格式

    D1E404E6-26EC-4E5F-9AFB-5DFA10C66C1F SUCCEEDED CREATE 2020-01-20T09:22:41.000000 6da106ca-1784-4a6f-a7e1-e723863dc75a MyStackGroup 2020-01-20T09:22:36.000000 fd0ddef9-9540-4b42-a464-94f7783501d0 1 1 cn-hangzhou cn-beijing 2020-02-27T07:47:47 DRIFTED COMPLETED 1 0 0 0 1 2 JSON 格式

    { "RequestId": "D1E404E6-26EC-4E5F-9AFB-5DFA10C66C1F", "StackGroupOperation": { "Status": "SUCCEEDED", "Action": "CREATE", "EndTime": "2020-01-20T09:22:41.000000", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863dc75a", "StackGroupName": "MyStackGroup", "CreateTime": "2020-01-20T09:22:36.000000", "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "OperationPreferences": { "FailureToleranceCount": 1, "MaxConcurrentCount": 1, "RegionIdsOrder": ["cn-hangzhou", "cn-beijing"] }, "StackGroupDriftDetectionDetail": { "DriftDetectionTime": "2020-02-27T07:47:47", "StackGroupDriftStatus": "DRIFTED", "DriftDetectionStatus": "COMPLETED", "DriftedStackInstancesCount": 1, "FailedStackInstancesCount": 0, "CancelledStackInstancesCount": 0, "InProgressStackInstancesCount": 0, "InSyncStackInstancesCount": 1, "TotalStackInstancesCount": 2 } } } 错误码 访问错误中心查看更多错误码。调用ListStackGroupOperations接口查询资源栈组操作列表。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 RegionId String 是 cn-hangzhou 资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    PageSize Long 否 10 分页查询时设置的每页行数。取值:1~50。默认值:10。

    PageNumber Long 否 1 分页查询时设置的页码。起始值:1。默认值:1。

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    PageNumber Integer 1 分页查询时设置的页码。

    PageSize Integer 10 分页查询时设置的每页行数。

    TotalCount Integer 1 查询到的总数。

    StackGroupOperations Array 资源栈组操作详情列表。

    示例 请求示例

    http(s)://[Endpoint]/?Action=ListStackGroupOperations &RegionId=cn-hangzhou &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    1 1 10 4D838E26-B457-4871-B6DE-18814050D13D SUCCEEDED fd0ddef9-9540-4b42-a464-94f7783501d0 CREATE MyStackGroup 2020-01-20T09:22:36.000000 6da106ca-1784-4a6f-a7e1-e723863dc75a 2020-01-20T09:22:41.000000 JSON 格式

    { "PageNumber": 1, "TotalCount": 1, "PageSize": 10, "RequestId": "4D838E26-B457-4871-B6DE-18814050D13D", "StackGroupOperations": [ { "Status": "SUCCEEDED", "StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0", "Action": "CREATE", "StackGroupName": "MyStackGroup", "CreateTime": "2020-01-20T09:22:36.000000", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863dc75a", "EndTime": "2020-01-20T09:22:41.000000" } ] } 错误码 访问错误中心查看更多错误码。调用StopStackGroupOperation接口停止资源栈组操作。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 StopStackGroupOperation 系统规定参数。取值:StopStackGroupOperation。

    OperationId String 是 6da106ca-1784-4a6f-a7e1-e723863dc75a 操作ID。

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

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 示例 请求示例

    http(s)://[Endpoint]/?Action=StopStackGroupOperation &OperationId=6da106ca-1784-4a6f-a7e1-e723863dc75a &RegionId=cn-hangzhou &<公共请求参数> 正常返回示例

    XML 格式

    14A07460-EBE7-47CA-9757-12CC4761D47A JSON 格式

    { "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A" } 错误码 访问错误中心查看更多错误码。 调用DeleteStackInstances接口删除特定账号和地域下的资源栈实例。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DeleteStackInstances 系统规定参数。取值:DeleteStackInstances。

    AccountIds Json 是 ["123456"] 目标执行账号列表。类型为JSON列表。最多可以指定20个账号。

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

    RegionIds Json 是 ["cn-hangzhou", "cn-beijing"] 目标执行地域列表。类型为JSON列表。最多可以指定20个地域。

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    RetainStacks Boolean 否 false 是否保留资源栈实例所对应的资源栈。若保留,则从资源栈组中删除资源栈组实例时,不会删除对应的资源栈。

    ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。 该值由客户端生成,并且必须是全局唯一的。 仅允许使用英文字母(区分大小写)、数字、字符、连字符和下划线。它最多可包含64个字符。更多详情,请参见如何保证幂等性。

    OperationDescription String 否 Delete stack instances in hangzhou and beijing 操作描述。描述该操作的目的或行为。

    长度限制:1~256个字符。

    OperationPreferences Json 否 {"FailureToleranceCount": 1, "MaxConcurrentCount": 2} 操作设置。类型为JSON字典。可包含如下字段:

    FailureToleranceCount 失败容错数。一个资源栈组操作中,若操作结果的失败总数不超过失败容错数,操作则成功,反之则失败。

    若不指定FailureToleranceCount,则默认为0。不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:0~20

    FailureTolerancePercentage 失败容错百分比。一个资源栈组操作中,若操作结果的失败百分比不超过失败容错百分比,操作则成功,反之则失败。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:0~100

    MaxConcurrentCount 最大账号并发数。一个资源栈组操作中,最多能有多少个账号同时执行。

    不能同时指定MaxConcurrentCount和MaxConcurrentPercentage。

    范围限制:1~20

    MaxConcurrentPercentage 最大账号并发百分比。一个资源栈组操作中,最多能有多少百分比的账号同时执行。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:1~100

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    OperationId String 6da106ca-1784-4a6f-a7e1-e723863dc75a 操作ID。

    示例 请求示例

    http(s)://[Endpoint]/?Action=DeleteStackInstances &AccountIds=["123456"] &RegionId=cn-hangzhou &RegionIds=["cn-hangzhou", "cn-beijing"] &StackGroupName=MyStackGroup &RetainStacks=false &<公共请求参数> 正常返回示例

    XML 格式

    14A07460-EBE7-47CA-9757-12CC4761D47A 6da106ca-1784-4a6f-a7e1-e723863dc75a JSON 格式

    { "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863dc75a" } 错误码 访问错误中心查看更多错误码。调用UpdateStackInstances接口在特定账号和地域下更新资源栈实例。

    资源栈实例是指特定账号和地域中的资源栈。您必须至少指定一个账号和一个地域。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求参数 名称 类型 是否必选 示例值 描述 AccountIds Json 是 ["123456"] 目标执行账号列表。类型为JSON列表。最多可以指定20个账号。

    ParameterOverrides.N.ParameterKey String 是 Amount 覆盖参数的名称。 如果未指定特定参数的名称和值,ROS将使用创建资源栈组时所指定的参数。

    N最大值为200。

    ParameterOverrides.N.ParameterValue String 是 1 覆盖参数的值。如果未指定特定参数的名称和值,ROS将使用创建资源栈组时所指定的参数。

    N最大值为200。

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

    RegionIds Json 是 ["cn-hangzhou", "cn-beijing"] 目标执行地域列表。类型为JSON列表。最多可以指定20个地域。

    StackGroupName String 是 MyStackGroup 资源栈组名称。名称在单个Region内唯一,可以包含数字、英文字母(区分大小写)、连字符、下划线。必须以数字或英文字母开头,且长度不超过255个字符。

    ClientToken String 否 123e4567-e89b-12d3-a456-426655440000 保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。 仅允许使用英文字母(区分大小写)、数字、字符、连字符和下划线。它最多可包含64个字符。更多详情,请参见如何保证幂等性。

    OperationDescription String 否 Update stack instances in hangzhou and beijing 操作描述。描述该操作的目的或行为。

    长度限制:1~256个字符。

    OperationPreferences Json 否 {"FailureToleranceCount": 1, "MaxConcurrentCount": 2} 操作设置。类型为JSON字典。可包含如下字段:

    FailureToleranceCount 失败容错数。一个资源栈组操作中,若操作结果的失败总数不超过失败容错数,操作则成功,反之则失败。

    若不指定FailureToleranceCount,则默认为0。不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:0~20

    FailureTolerancePercentage 失败容错百分比。一个资源栈组操作中,若操作结果的失败百分比不超过失败容错百分比,操作则成功,反之则失败。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:0~100

    MaxConcurrentCount 最大账号并发数。一个资源栈组操作中,最多能有多少个账号同时执行。

    不能同时指定MaxConcurrentCount和MaxConcurrentPercentage。

    范围限制:1~20

    MaxConcurrentPercentage 最大账号并发百分比。一个资源栈组操作中,最多能有多少百分比的账号同时执行。

    不能同时指定FailureToleranceCount和FailureTolerancePercentage。

    范围限制:1~100

    返回数据 名称 类型 示例值 描述 RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A 请求ID。

    OperationId String 6da106ca-1784-4a6f-a7e1-e723863dc75a 操作ID。

    示例 请求示例

    http(s)://[Endpoint]/?Action=UpdateStackInstances &AccountIds=["123456"] &ParameterOverrides.1.ParameterKey=Amount &ParameterOverrides.1.ParameterValue=1 &RegionId=cn-hangzhou &RegionIds=["cn-hangzhou", "cn-beijing"] &StackGroupName=MyStackGroup &<公共请求参数> 正常返回示例

    XML 格式

    14A07460-EBE7-47CA-9757-12CC4761D47A 6da106ca-1784-4a6f-a7e1-e723863dc75a JSON 格式

    { "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A", "OperationId": "6da106ca-1784-4a6f-a7e1-e723863dc75a" } 错误码 访问错误中心查看更多错误码。

    0 0
云计算
使用钉钉扫一扫加入圈子
+ 订阅

时时分享云计算技术内容,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。

推荐文章