文档

GetStackInstance - 查询资源栈实例信息

更新时间:

查询指定资源栈组关联的资源栈实例详情。

接口说明

本文将提供一个示例,对杭州地域已有的自助管理权限模式的资源栈组MyStackGroup,查询其在北京地域和阿里云账号151266687691****下的资源栈实例的详细信息。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
StackGroupNamestring

资源栈组名称。名称在单个地域内唯一。
长度不超过 255 个字符,必须以数字或英文字母开头,可以包含数字、英文字母、短划线(-)和下划线(_)。

MyStackGroup
StackInstanceAccountIdstring

资源栈所属目标账号 ID。

  • 自助管理权限模式下,该账号是阿里云账号。

  • 服务管理权限模式下,该账号是资源目录的成员账号。

说明 关于目标账号的更多信息,请参见概览
151266687691****
StackInstanceRegionIdstring

资源栈所属地域。

cn-beijing
OutputOptionstring

是否返回 Outputs 参数(资源栈输出列表)。取值:

  • Enabled:返回 Outputs 参数。

  • Disabled(默认值):不返回 Outputs 参数。

说明 Outputs 计算较为耗时。如果不需要获取 Outputs 信息,建议您将 OutputOption 指定为 Disabled,提高接口响应速度。
Disabled

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B8A6B693-82C8-419D-8796-DE99EC33CFF9
StackInstanceobject

资源栈详情。

Statusstring

资源栈的状态。

取值:

  • CURRENT:资源栈是最新的。

  • OUTDATED:资源栈不是资源栈组最新的。可能原因如下:

    • 在创建资源栈(CreateStackInstances)操作期间,创建对应的资源栈失败。
    • 在更新资源栈(UpdateStackInstances 或 UpdateStackGroup)操作期间,更新对应的资源栈失败,或只更新了部分资源栈。
    • 创建或更新操作未完成。
CURRENT
StackGroupIdstring

资源栈组 ID。

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

资源栈 ID。

说明 仅当资源栈状态为 CURRENT 时,才会返回该参数。
35ad60e3-6a92-42d8-8812-f0700d45****
DriftDetectionTimestring

资源栈组最近一次成功完成偏差检测的时间。

说明 仅当资源栈组做过偏差检测,才会返回该参数。
2020-02-27T07:47:47
StackDriftStatusstring

资源栈组最近一次成功完成偏差检测的状态。

取值:

  • DRIFTED:资源栈处于偏差状态。
  • NOT_CHECKED:资源栈未进行过成功的偏差检测。
  • IN_SYNC:资源栈处于同步状态。
说明 仅当资源栈组做过偏差检测,才会返回该参数。
IN_SYNC
StatusReasonstring

状态原因描述。

说明 仅当资源栈的实例状态为 OUTDATED 时,才会返回该参数。
User initiated stop
ParameterOverridesobject []

覆盖参数列表。

ParameterKeystring

覆盖参数的名称。

Amount
ParameterValuestring

覆盖参数的值。

1
StackGroupNamestring

资源栈组名称。

MyStackGroup
AccountIdstring

资源栈所属目标账号 ID。

151266687691****
RegionIdstring

资源栈所属地域。

cn-beijing
RdFolderIdstring

资源目录的资源夹 ID。

说明 仅限使用服务管理权限模式的资源栈组,才会返回该参数。
fd-4PvlVLOL8v
Outputsobject []

资源栈输出列表。

说明 当 OutputOption 取值为 Enabled 时返回该参数。
object

资源栈输出列表。

说明 当 OutputOption 取值为 Enabled 时返回该参数。
[{'OutputKey': 'rds_connection_string', 'OutputValue': 'rm-gw868n4lzy0i7kzx3.mysql.germany.rds.aliyuncs.com'}]

示例

正常返回示例

JSON格式

{
  "RequestId": "B8A6B693-82C8-419D-8796-DE99EC33CFF9",
  "StackInstance": {
    "Status": "CURRENT",
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "StackId": "35ad60e3-6a92-42d8-8812-f0700d45****",
    "DriftDetectionTime": "2020-02-27T07:47:47",
    "StackDriftStatus": "IN_SYNC",
    "StatusReason": "User initiated stop",
    "ParameterOverrides": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "1"
      }
    ],
    "StackGroupName": "MyStackGroup",
    "AccountId": "151266687691****",
    "RegionId": "cn-beijing",
    "RdFolderId": "fd-4PvlVLOL8v",
    "Outputs": [
      {
        "test": "test",
        "test2": 1
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OutputOption
出参OpenAPI 返回结构发生变更
错误代码错误信息HTTP 状态码描述
InvalidParameterThe specified parameter {name} is invalid, {reason}.400无效参数,name 为参数名,reason 为原因。
StackGroupNotFoundThe StackGroup ({name}) could not be found.404资源栈组不存在。name 为资源栈组名称。
StackInstanceNotFoundThe StackInstance could not be found.404资源栈不存在。
  • 本页导读 (1)
文档反馈