全部产品
Search

搜索本产品

    资源编排：GetStackResource - 查询某个资源栈的资源

    文档中心

    资源编排：GetStackResource - 查询某个资源栈的资源

    更新时间：Sep 12, 2024

    查询某个资源栈的资源。

    接口说明

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    StackIdstring是

    资源栈 ID。

    		4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    ClientTokenstring否

    保证请求的幂等性。该值由客户端生成，并且必须是全局唯一的。
    长度不超过 64 个字符，可包含英文字母、数字、短划线（-）和下划线（_）。
    更多信息，请参见如何保证幂等性。

    		123e4567-e89b-12d3-a456-42665544****
    RegionIdstring是

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

    		cn-hangzhou
    ShowResourceAttributesboolean否

    是否查询资源属性。取值：

    • true：查询资源属性。

    • false：不查询资源属性。

    		true
    LogicalResourceIdstring是

    资源逻辑 ID，即模板中资源的名称。

    		WebServer
    ResourceAttributesarray否

    指定要查询的资源输出属性的列表。

    说明 N 最大值为 20。
    string否

    指定要查询的资源输出属性名称。

    说明 N 最大值为 20。
    		InstanceId

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

    返回参数

    名称类型描述示例值
    object
    Statusstring

    资源状态。取值：

    • CREATE_COMPLETE
    • CREATE_FAILED
    • CREATE_IN_PROGRESS
    • UPDATE_IN_PROGRESS
    • UPDATE_FAILED
    • UPDATE_COMPLETE
    • DELETE_IN_PROGRESS
    • DELETE_FAILED
    • CHECK_IN_PROGRESS
    • CHECK_FAILED
    • CHECK_COMPLETE
    • IMPORT_IN_PROGRESS
    • IMPORT_FAILED
    • IMPORT_COMPLETE
    		CREATE_COMPLETE
    Descriptionstring

    资源描述。

    		no description
    RequestIdstring

    请求 ID。

    		B288A0BE-D927-4888-B0F7-B35EF84B6E6
    StatusReasonstring

    资源状态原因。

    		state changed
    PhysicalResourceIdstring

    资源物理 ID，即实际资源 ID。

    		d04af923-e6b7-4272-aeaa-47ec9777****
    CreateTimestring

    创建时间。 按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。

    		2019-08-01T06:01:23
    Metadataobject

    元数据。

    		{"key": "value"}
    ResourceTypestring

    资源类型。

    		ALIYUN::ROS::WaitConditionHandle
    ResourceAttributesarray<object>

    资源属性列表。

    object

    资源属性列表。

    		[{"ResourceAttributeKey": "CurlCli","ResourceAttributeValue": "curl -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'x-acs-region-id: cn-beijing' http://192.168.XX.XX/waitcondition?stackname=test-describe-resource\\&stackid=efdf5c10-96a5-4fd7-ab89-68e7baa2****\\&resource=WaitConditionHandle\\&expire=156468****\\&signature=991d910a901a89db6580d74233119960c004****"}]
    LogicalResourceIdstring

    资源逻辑 ID，即模板中资源的名称。

    		WebServer
    ResourceDriftStatusstring

    资源栈最近一次成功的偏差检测中的资源的偏差状态。取值：

    • DELETED：资源与预期的模板配置不同，因为资源已被删除。
    • MODIFIED：资源与预期的模板配置不同。
    • NOT_CHECKED：ROS 没有检测资源是否与预期的模板配置不同。
    • IN_SYNC：资源的当前配置与其预期的模板配置相匹配。
    		IN_SYNC
    UpdateTimestring

    更新时间。 按照 ISO8601 标准表示，需使用 UTC 时间，格式：YYYY-MM-DDThh:mm:ss。

    		2019-08-01T06:01:29
    DriftDetectionTimestring

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

    		2020-02-27T07:47:47
    StackNamestring

    资源栈名称。
    长度不超过 255 个字符，必须以数字或英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_）。

    		test-describe-resource
    StackIdstring

    资源栈 ID。

    		efdf5c10-96a5-4fd7-ab89-68e7baa2****
    ModuleInfoobject

    资源来源模块的信息。资源来自于模块时，才返回该字段。

    LogicalIdHierarchystring

    包含资源的一个或多个模块的逻辑 ID 的串联列表。 模块从最外层开始列出，并以 /分隔。

    在以下示例中，资源是从嵌套在父模块 moduleA 中的模块 moduleB 创建的。

    moduleA/moduleB

    		moduleA/moduleB
    TypeHierarchystring

    包含资源的一个或多个模块类型的串联列表。 模块类型从最外层开始列出，并以 /分隔。

    在以下示例中，资源是从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格式

    {
  "Status": "CREATE_COMPLETE",
  "Description": "no description",
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6",
  "StatusReason": "state changed",
  "PhysicalResourceId": "d04af923-e6b7-4272-aeaa-47ec9777****",
  "CreateTime": "2019-08-01T06:01:23",
  "Metadata": {
    "key": "value"
  },
  "ResourceType": "ALIYUN::ROS::WaitConditionHandle",
  "ResourceAttributes": [
    [
      {
        "ResourceAttributeKey": "CurlCli",
        "ResourceAttributeValue": "curl -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'x-acs-region-id: cn-beijing' http://192.168.XX.XX/waitcondition?stackname=test-describe-resource\\&stackid=efdf5c10-96a5-4fd7-ab89-68e7baa2****\\&resource=WaitConditionHandle\\&expire=156468****\\&signature=991d910a901a89db6580d74233119960c004****"
      }
    ]
  ],
  "LogicalResourceId": "WebServer",
  "ResourceDriftStatus": "IN_SYNC",
  "UpdateTime": "2019-08-01T06:01:29",
  "DriftDetectionTime": "2020-02-27T07:47:47",
  "StackName": "test-describe-resource",
  "StackId": "efdf5c10-96a5-4fd7-ab89-68e7baa2****",
  "ModuleInfo": {
    "LogicalIdHierarchy": "moduleA/moduleB\n",
    "TypeHierarchy": "MODULE::ROS::Parent::Example/MODULE::ROS::Child::Example"
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-05-10OpenAPI 返回结构发生变更查看变更详情
    HttpCode错误码错误信息描述
    404ResourceNotFoundThe Resource ({name}) could not be found in Stack {stack}.资源栈中不存某资源。name 为资源名，stack 为资源栈名称或 ID。
    404StackNotFoundThe Stack ({name}) could not be found.资源栈不存在。name 为资源栈名称或 ID。