文档首页/ 资源编排服务 RFS/ API参考/ API/ 资源栈集/ 获取资源栈实例
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

获取资源栈实例

功能介绍

获取资源栈实例（ShowStackInstance）

用户可以使用此API获取资源栈实例的详细信息，包括关联资源栈名称与id，创建时间，参数覆盖等

URI

GET /v1/stack-sets/{stack_set_name}/stack-instances/{stack_instance_addr}

表1 路径参数

参数

是否必选

参数类型

描述

stack_set_name

是

String

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

最小长度：1

最大长度：128

stack_instance_addr

是

String

资源栈实例的唯一地址。该地址由region和stack_domain_id通过"/"（转义后为%2f或%2F）拼接而成。该地址在domain_id+region+stack_set_name下唯一。

最小长度：1
表2 Query参数

参数

是否必选

参数类型

描述

stack_set_id

否

String

资源栈集（stack_set）的唯一ID。

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

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

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

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

最小长度：36

最大长度：36

call_identity

否

String

仅支持资源栈集权限模式为SERVICE_MANAGED时指定该参数。用于指定用户是以组织管理账号还是成员帐户中的服务委托管理员身份调用资源栈集。默认为SELF。

  • 无论指定何种用户身份，创建或部署的资源栈集始终在组织管理账号名下。*

    • SELF - 以组织管理账号身份调用。

    • DELEGATED_ADMIN - 以服务委托管理员身份调用。用户的华为云账号必须在组织中已经被注册为”资源编排资源栈集服务“的委托管理员。

枚举值：

  • SELF

  • DELEGATED_ADMIN

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

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

最小长度：36

最大长度：128

响应参数

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

在资源栈实例状态为INOPERABLE或OPERATION_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

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表7 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表9 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表11 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表13 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 429

表14 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表15 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码： 500

表16 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表17 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

请求示例

获取region是cn-north-7，domain_id是my-domain-id的资源栈实例的详细信息

GET https://{endpoint}/v1/stack-sets/my_stack_set/stack-instances/cn-north-7%2fmy-domain-id

响应示例

状态码： 200

获取资源栈实例成功

{
  "stack_set_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
  "stack_set_name" : "my_hello_world_stack_set",
  "latest_stack_set_operation_id" : "3fef5d3e-27b6-44e8-9769-1d7262bd9430",
  "status" : "OPERATION_COMPLETE",
  "stack_id" : "ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2",
  "stack_name" : "my_hello_world_stack",
  "stack_domain_id" : "6cbcca2a2f114a63841bdbc7a19b7b09",
  "region" : "cn-north-7",
  "create_time" : "2023-05-15T15:39:25.210Z",
  "update_time" : "2023-05-15T16:39:25.210Z",
  "var_overrides" : {
    "vars_body" : "var_key1=\"var_value1\"",
    "vars_uri_content" : "var_key2=\"var_value2\""
  }
}

状态码

状态码

描述

200

获取资源栈实例成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

资源栈集不存在或资源栈实例不存在

429

请求数量过多

500

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