资源编排服务 RFS-获取资源栈实例:响应参数

时间:2024-04-22 15:17:29

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

stack_set_id

String

资源栈集(stack_set)的唯一ID。

此ID由资源编排服务在生成资源栈集的时候生成,为UUID。

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

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

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

最小长度:36

最大长度:36

stack_set_name

String

资源栈集(stack_set)的名字。此名字在domain_id+region下应唯一,可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文,区分大小写。

最小长度:1

最大长度:128

status

String

资源栈实例的状态

  • WAIT_IN_PROGRESS - 资源栈实例等待操作中

  • CANCEL_COMPLETE - 资源栈实例操作取消完成

  • OPERATION_IN_PROGRESS - 资源栈实例操作中

  • OPERATION_FAILED - 资源栈实例操作失败

  • INOPERABLE - 资源栈实例不可操作

  • OPERATION_COMPLETE - 资源栈实例操作完成

枚举值:

  • WAIT_IN_PROGRESS

  • CANCEL_COMPLETE

  • OPERATION_IN_PROGRESS

  • OPERATION_FAILED

  • INOPERABLE

  • OPERATION_COMPLETE

status_message

String

在资源栈实例状态为INOPERABLEOPERATION_FAILED时,会显示简要的错误信息总结以供debug

stack_id

String

资源栈(stack)的唯一ID。

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

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

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

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

stack_name

String

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

最小长度:1

最大长度:128

stack_domain_id

String

资源栈实例所关联的资源栈所在的租户ID

latest_stack_set_operation_id

String

最新一次部署该资源栈实例的资源栈集操作ID

此ID由资源编排服务在生成资源栈集操作的时候生成,为UUID

region

String

资源栈实例所关联的资源栈所在的区域

create_time

String

资源栈实例的创建时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z

update_time

String

资源栈实例的更新时间,格式为YYYY-MM-DDTHH:mm:ss.SSSZ,精确到毫秒,UTC时区,即,如1970-01-01T00:00:00.000Z

var_overrides

var_overrides object

该资源栈实例的参数覆盖内容

如果用户通过CreateStackInstances或UpdateStackInstances API 对该资源栈实例设置了参数覆盖,该字段会返回资源栈实例记录的最新参数覆盖内容

如果该字段未返回,用户使用资源栈集中记录的参数部署该实例

表5 var_overrides

参数

参数类型

描述

vars_uri_content

String

vars_uri对应的文件内容

vars_body

String

HCL参数文件的内容。HCL模板支持参数传入,即,同一个模板可以给予不同的参数而达到不同的效果

  • vars_body使用HCL的tfvars格式,用户可以将“.tfvars”中的内容提交到vars_body中

  • 资源编排服务支持vars_body和vars_uri,如果以上两种方式中声名了同一个变量,将报错400

  • 如果vars_body过大,可以使用vars_uri

  • 资源栈集不支持敏感数据加密,资源编排服务会直接明文使用、log、展示、存储对应的vars_body

状态码: 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

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

support.huaweicloud.com/api-aos/ShowStackInstance.html