调用ListStackResources查询资源栈的资源列表_资源编排(ROS)-阿里云帮助中心

查询指定资源栈的资源列表。

接口说明

本文将提供一个示例，为您查询杭州地域 ID 为4a6c9851-3b0f-4f5f-b4ca-a14bf691****的资源栈的资源列表。

调试

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

调试

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
StackId	string	是	资源栈 ID。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	是	资源栈所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B288A0BE-D927-4888-B0F7-B35EF84B6E6
Resources	array<object>	资源对象的列表。
	object
Status	string	资源状态。取值： INIT_COMPLETE：资源待创建。 CREATE_COMPLETE：资源创建完成。 CREATE_FAILED：资源创建失败。 CREATE_IN_PROGRESS：资源创建中。 UPDATE_IN_PROGRESS：资源更新中。 UPDATE_FAILED：资源更新失败。 UPDATE_COMPLETE：资源更新完成。 DELETE_IN_PROGRESS：资源删除中。 DELETE_FAILED：资源删除失败。 DELETE_COMPLETE：资源删除完成。 CHECK_IN_PROGRESS：资源校验中。 CHECK_FAILED：资源校验失败。 CHECK_COMPLETE：资源校验完成。 IMPORT_IN_PROGRESS：资源导入中。 IMPORT_FAILED：资源导入失败。 IMPORT_COMPLETE：资源导入完成。	UPDATE_COMPLETE
LogicalResourceId	string	资源逻辑 ID，即模板定义的名称。	dummy
UpdateTime	string	更新时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ss。	2019-08-01T06:01:29
StackId	string	资源栈 ID。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
PhysicalResourceId	string	资源的物理 ID，即实际资源 ID。	d04af923-e6b7-4272-aeaa-47ec9777****
DriftDetectionTime	string	资源栈最近一次成功的偏差检测中资源偏差检测的时间。	2020-02-27T07:47:47
ResourceType	string	资源类型。	ALIYUN::ROS::Stack
ResourceDriftStatus	string	资源栈最近一次成功的偏差检测中的资源的偏差状态。取值： DELETED：资源与预期的模板配置不同，因为资源已被删除。 MODIFIED：资源与预期的模板配置不同。 NOT_CHECKED：ROS 没有检测资源是否与预期的模板配置不同。 IN_SYNC：资源的当前配置与其预期的模板配置相匹配。	IN_SYNC
StatusReason	string	资源状态的原因。	state changed
CreateTime	string	创建时间，按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ss。	2019-08-01T06:01:23
StackName	string	资源栈名称。长度不超过 255 个字符，必须以数字或英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_）。	test-describe-resource
ModuleInfo	object	资源来源模块的信息。资源来自于模块时，才返回该字段。
LogicalIdHierarchy	string	包含资源的一个或多个模块的逻辑 ID 的串联列表。模块从最外层开始列出，并以 `/` 分隔。在以下示例中，资源是从嵌套在父模块 moduleA 中的模块 moduleB 创建的。 `moduleA/moduleB`	moduleA/moduleB
TypeHierarchy	string	包含资源的一个或多个模块类型的串联列表。模块类型从最外层开始列出，并以 `/` 分隔。在以下示例中，资源是从`MODULE::ROS::Child::Example`类型的模块创建的，该模块嵌套在`MODULE::ROS::Parent::Example`类型的父模块中。 `MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example`	MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example

示例

正常返回示例

JSON格式

{
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "Resources": [
    {
      "Status": "UPDATE_COMPLETE",
      "LogicalResourceId": "dummy",
      "UpdateTime": "2019-08-01T06:01:29",
      "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
      "PhysicalResourceId": "d04af923-e6b7-4272-aeaa-47ec9777****",
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "ResourceType": "ALIYUN::ROS::Stack",
      "ResourceDriftStatus": "IN_SYNC",
      "StatusReason": "state changed",
      "CreateTime": "2019-08-01T06:01:23",
      "StackName": "test-describe-resource",
      "ModuleInfo": {
        "LogicalIdHierarchy": "moduleA/moduleB",
        "TypeHierarchy": "MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example"
      }
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-05-10	OpenAPI 返回结构发生变更	查看变更详情

错误代码	错误信息	HTTP 状态码	描述
StackNotFound	The Stack ({name}) could not be found.	404	资源栈不存在，name 为资源栈名称或 ID。