文档首页> 资源编排服务 RFS> API参考> 资源编排API> 资源栈> 列举资源栈输出
更新时间：2024-04-19 GMT+08:00
查看PDF

列举资源栈输出

功能介绍

列举资源栈输出（ListStackOutputs）

此API用于列举该资源栈的所有输出

资源栈输出为用户在模板中定义的 output 语句块在部署结束后所产生的返回信息，用户可在部署结束后，调用此API获取其具体的输出信息

当资源栈状态处于非终态（状态以IN_PROGRESS结尾）状态时，此API将返回空。非终态包括但不限于以下状态：

  • 正在部署（DEPLOYMENT_IN_PROGRESS）

  • 正在删除（DELETION_IN_PROGRESS）

  • 正在回滚（ROLLBACK_IN_PROGRESS）

output为HCL官方定义的语法，其返回信息类似于常见编程语言中的返回值，详细定义请参考HCL官方的说明

URI

GET /v1/{project_id}/stacks/{stack_name}/outputs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从调用API处获取，也可以从控制台获取。

项目ID获取方式

最小长度：3

最大长度：64

stack_name

是

String

资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

stack_id

否

String

资源栈（stack）的唯一Id。

此Id由资源编排服务在生成资源栈的时候生成，为UUID。

由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。

对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400

最小长度：36

最大长度：36

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID

最小长度：36

最大长度：128

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

outputs

Array of StackOutput objects

资源栈输出列表
表5 StackOutput

参数

参数类型

描述

name

String

资源栈输出的名称，由用户在模板中定义

以 HCL 模板为例，name 为 vpc_id

output "vpc_id" {
  value = huaweicloud_vpc.my_hello_world_vpc.id
}

以 json 模板为例，name 为 vpc_id

{
  "output": {
    "vpc_id": [
      {
        "value": "${huaweicloud_vpc.my_hello_world_vpc.id}"
      }
    ]
  }
}

description

String

资源栈输出的描述，由用户在模板中定义

type

String

资源栈输出的类型

value

String

资源栈输出的值

sensitive

Boolean

标识该资源栈输出是否为敏感信息，由用户在模板中定义

如果用户在模板中将该输出定义为sensitive，则返回体中该输出的value和type不会返回真实值，而是返回<sensitive>

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 429

表10 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

请求示例

  • 列举资源栈输出

    GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/outputs

  • 列举资源栈输出，并提供资源栈id以校验是否与当前资源栈匹配

    GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/outputs?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2

响应示例

状态码： 200

列举资源栈输出成功

{
  "outputs" : [ {
    "name" : "my_first_vpc",
    "sensitive" : true,
    "type" : "<sensitive>",
    "value" : "<sensitive>",
    "description" : "type and value is invisible when sensitive is true."
  }, {
    "name" : "my_second_vpc",
    "type" : "string",
    "value" : "\"huaweicloud_vpc.my_second_vpc\"",
    "description" : "type and value is real when sensitive not set or is false."
  } ]
}

状态码

状态码

描述

200

列举资源栈输出成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

资源栈不存在

429

请求数量过多

500

服务器内部错误
父主题： 资源栈