文档

GetStackGroupOperation - 查询资源栈组操作的信息

更新时间:

在一个阿里云地域下查询指定资源栈组的操作详情。

接口说明

本文将提供一个示例,对杭州地域已有的自助管理权限模式的资源栈组MyStackGroup,查询操作 ID 为6da106ca-1784-4a6f-a7e1-e723863d****的操作信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ros:GetStackGroupOperationRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
OperationIdstring

操作 ID。您可以调用 ListStackGroupOperations 获取操作 ID。

6da106ca-1784-4a6f-a7e1-e723863d****

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroupOperationobject

资源栈组操作详情。

Statusstring

操作状态。

取值:

  • RUNNING:操作正在进行中。

  • SUCCEEDED:操作成功。

  • FAILED:操作失败。

  • STOPPING:操作正在停止中。

  • STOPPED:操作已停止。

SUCCEEDED
StackGroupIdstring

资源栈组 ID。

fd0ddef9-9540-4b42-a464-94f77835****
Actionstring

操作动作。

取值:

  • CREATE:创建。

  • UPDATE:更新。

  • DELETE:删除。

  • DETECT_DRIFT:偏差检测。

DELETE
CreateTimestring

操作开始时间。

2020-01-20T09:22:3
RetainStacksboolean

是否保留资源栈。删除资源栈实例时可选择删除或保留它所指向的资源栈。

取值:

  • true:只删除资源栈实例,不删除相应的资源栈。

  • false:删除资源栈实例和相应的资源栈,请您谨慎操作。

说明 仅在您执行删除资源栈实例的操作时,才会返回该参数。
true
StackGroupNamestring

资源栈组名称。

MyStackGroup
OperationIdstring

资源栈组操作 ID。

6da106ca-1784-4a6f-a7e1-e723863d****
OperationDescriptionstring

操作描述。

说明 仅在您调用 CreateStackInstances 执行创建资源栈实例操作时,指定了请求参数 OperationDescription,此处才会返回该参数。
Create stack instance in hangzhou
StackGroupDriftDetectionDetailobject

偏差检测的详情。

说明 仅在您执行偏差检测的操作时,才会返回该参数。
DriftDetectionTimestring

偏差检测时间。

2020-02-27T07:47:47
TotalStackInstancesCountinteger

资源栈实例的数量。

2
FailedStackInstancesCountinteger

偏差检测失败的资源栈实例的数量。

0
DriftDetectionStatusstring

偏差检测状态。

取值:

  • COMPLETED:资源栈组偏差检测结束,所有资源栈实例均成功完成了偏差检测。
  • FAILED:资源栈组偏差检测结束,失败的资源栈实例偏差检测数量超过了设定的阈值。
  • PARTIAL_SUCCESS:资源栈组偏差检测结束,部分资源栈实例偏差检测失败,但失败数量没有超过阈值。
  • IN_PROGRESS:资源栈组偏差检测进行中。
  • STOPPED:用户取消了资源栈组的偏差检测。
COMPLETED
StackGroupDriftStatusstring

资源栈组偏差状态。

取值:

  • DRIFTED:至少一个资源栈实例处于偏差状态。
  • NOT_CHECKED:资源栈组未进行过成功的偏差检测。
  • IN_SYNC:所有资源栈实例均处于同步状态。
DRIFTED
InProgressStackInstancesCountinteger

偏差检测中的资源栈实例的数量。

0
InSyncStackInstancesCountinteger

处于同步状态的资源栈实例的数量。

1
CancelledStackInstancesCountinteger

取消偏差检测的资源栈实例的数量。

0
DriftedStackInstancesCountinteger

处于偏差状态的资源栈实例的数量。

1
OperationPreferencesobject

操作设置。

MaxConcurrentCountinteger

最大并发账号数。每个地域中可同时部署资源栈的账号数。

取值范围:1~20。

说明 只能返回 MaxConcurrentCount 和 MaxConcurrentPercentage 其中一个参数。
1
FailureToleranceCountinteger

容错数。每个地域中资源栈可以失败的账号数,超过该数字将停止该地域中的操作。如果停止了一个地域中的操作,此操作在其他地域中不继续执行。

取值范围:0~20。

说明 只能返回 FailureToleranceCount 和 FailureTolerancePercentage 其中一个参数。
1
MaxConcurrentPercentageinteger

最大并发账号百分比。每个地域中可同时部署资源栈的账号数占总账号数的百分比。

取值范围:1~100。

说明 只能返回 MaxConcurrentCount 和 MaxConcurrentPercentage 其中一个参数。
10
RegionIdsOrderarray

操作中按执行顺序排列的地域列表。

string

操作中按执行顺序排列的地域列表。

["cn-hangzhou","cn-beijing"]
FailureTolerancePercentageinteger

容错百分比。每个地域中资源栈可以失败的账号数占总账号数的百分比,超过该百分比将停止该地域中的操作。

取值范围:0~100。

说明 只能返回 FailureToleranceCount 和 FailureTolerancePercentage 其中一个参数。
10
EndTimestring

操作结束时间。

2020-01-20T09:22:4
ExecutionRoleNamestring

创建自助管理权限模式的资源栈组时,需指定的供管理员角色(AliyunROSStackGroupAdministrationRole)扮演的 RAM 执行角色名称。若不指定,则默认返回 AliyunROSStackGroupExecutionRole。

AliyunROSStackGroupExecutionRole
AdministrationRoleNamestring

创建自助管理权限模式的资源栈组时,指定的供 ROS 扮演的 RAM 管理员角色名称。若不指定,则默认返回 AliyunROSStackGroupAdministrationRole。

AliyunROSStackGroupAdministrationRole
DeploymentTargetsobject

使用服务管理权限模式时,资源栈实例的部署目标。

RdFolderIdsarray

资源目录的资源夹 ID 列表。

string

资源目录的资源夹 ID 列表。

["fd-4PvlVLOL8v"]
AccountIdsarray

资源目录中的成员账号 ID 列表。

说明 仅在您调用 UpdateStackInstances 执行更新资源栈实例操作时,指定了请求参数 AccountIds,此处才会返回该参数。
string

资源目录中的成员账号 ID 列表。

说明 仅在您调用 UpdateStackInstances 执行更新资源栈实例操作时,指定了请求参数 AccountIds,此处才会返回该参数。
["151266687691****","141261387191****"]

示例

正常返回示例

JSON格式

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroupOperation": {
    "Status": "SUCCEEDED",
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "Action": "DELETE",
    "CreateTime": "2020-01-20T09:22:3",
    "RetainStacks": true,
    "StackGroupName": "MyStackGroup",
    "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****",
    "OperationDescription": "Create stack instance in hangzhou",
    "StackGroupDriftDetectionDetail": {
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "TotalStackInstancesCount": 2,
      "FailedStackInstancesCount": 0,
      "DriftDetectionStatus": "COMPLETED",
      "StackGroupDriftStatus": "DRIFTED",
      "InProgressStackInstancesCount": 0,
      "InSyncStackInstancesCount": 1,
      "CancelledStackInstancesCount": 0,
      "DriftedStackInstancesCount": 1
    },
    "OperationPreferences": {
      "MaxConcurrentCount": 1,
      "FailureToleranceCount": 1,
      "MaxConcurrentPercentage": 10,
      "RegionIdsOrder": [
        "[\"cn-hangzhou\",\"cn-beijing\"]"
      ],
      "FailureTolerancePercentage": 10
    },
    "EndTime": "2020-01-20T09:22:4",
    "ExecutionRoleName": "AliyunROSStackGroupExecutionRole",
    "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole",
    "DeploymentTargets": {
      "RdFolderIds": [
        "[\"fd-4PvlVLOL8v\"]"
      ],
      "AccountIds": [
        "[\"151266687691****\",\"141261387191****\"]"
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
错误代码错误信息HTTP 状态码描述
InvalidParameterThe specified parameter {name} is invalid, {reason}.400无效参数,name 为参数名,reason 为原因。
StackGroupOperationNotFoundThe StackGroupOperation ({OperationId}) could not be found.404资源栈组操作不存在。OperationId 为操作 ID。
  • 本页导读 (1)
文档反馈