列举资源栈资源

project_id

是

String

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

项目ID获取方式

最小长度：3

最大长度：64

stack_name

是

String

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

最小长度：1

最大长度：128

stack_id

否

String

资源栈（stack）的唯一Id。

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

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

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

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

最小长度：36

最大长度：36

Client-Request-Id

是

String

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

最小长度：36

最大长度：128

stack_resources

Array of StackResource objects

资源栈中所管理的资源信息列表

physical_resource_id

String

资源的物理id，由该资源的provider、云服务或其他服务提供方在资源部署的时候生成

注：与physical相关的参数可以在模板以外的地方，作为该资源的一种标识

physical_resource_name

String

资源的物理名称，由该资源的provider、云服务或其他服务提供方在资源部署的时候定义

注：与physical相关的参数可以在模板以外的地方，作为该资源的一种标识

logical_resource_name

String

资源的逻辑名称，由用户在模板中定义

注：与 logical 相关的参数仅仅在模板内部，作为该资源的一种标识

以HCL格式的模板为例，logical_resource_name 为 my_hello_world_vpc

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  name = "test_vpc"
}

以json格式的模板为例，logical_resource_name 为 my_hello_world_vpc

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "name": "test_vpc"
      }
    }
  }
}

logical_resource_type

String

资源的类型

注：与 logical 相关的参数仅仅在模板内部，作为该资源的一种标识

以HCL格式的模板为例，logical_resource_type 为 huaweicloud_vpc

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  name = "test_vpc"
}

以json格式的模板为例，logical_resource_type 为 huaweicloud_vpc

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "name": "test_vpc"
      }
    }
  }
}

index_key

String

资源的索引，如果用户在模板中使用了count或for_each则会返回index_key。如果index_key出现，则logical_resource_name + index_key可以作为该资源的一种标识

如果用户在模板中使用count，则index_key为从0开始的数字

以HCL格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc[0]和huaweicloud_vpc.my_hello_world_vpc[1]标识两个资源

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  count = 2
  name = "test_vpc"
}

以json格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc[0]和huaweicloud_vpc.my_hello_world_vpc[1]标识两个资源

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "name": "test_vpc",
        "count": 2
      }
    }
  }
}

如果用户在模板中使用for_each，则index_key为用户自定义的字符串

以HCL格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc["vpc1"]和huaweicloud_vpc.my_hello_world_vpc["vpc2"]标识两个资源

resource "huaweicloud_vpc" "my_hello_world_vpc" {
  for_each = {
    "vpc1" = "test_vpc"
    "vpc2" = "test_vpc"
  }
  name = each.value
}

以json格式的模板为例，用户在模板中可以通过huaweicloud_vpc.my_hello_world_vpc["vpc1"]和huaweicloud_vpc.my_hello_world_vpc["vpc2"]标识两个资源

{
  "resource": {
    "huaweicloud_vpc": {
      "my_hello_world_vpc": {
        "for_each": {
          "vpc1": "test_vpc",
          "vpc2": "test_vpc"
        }
        "name": "${each.value}"
      }
    }
  }
}

resource_status

String

资源的状态

• CREATION_IN_PROGRESS - 正在生成

• CREATION_FAILED - 生成失败

• CREATION_COMPLETE - 生成完成

• DELETION_IN_PROGRESS - 正在删除

• DELETION_FAILED - 删除失败

• DELETION_COMPLETE - 已经删除

• UPDATE_IN_PROGRESS - 正在更新。此处的更新特指非替换式更新，如果是替换式更新，则使用CREATION后DELETION

• UPDATE_FAILED - 更新失败。此处的更新特指非替换式更新，如果是替换式更新，则使用CREATION后DELETION

• UPDATE_COMPLETE - 更新完成。此处的更新特指非替换式更新，如果是替换式更新，则使用CREATION后DELETION

枚举值：

• CREATION_IN_PROGRESS

• CREATION_FAILED

• CREATION_COMPLETE

• DELETION_IN_PROGRESS

• DELETION_FAILED

• DELETION_COMPLETE

• UPDATE_IN_PROGRESS

• UPDATE_FAILED

• UPDATE_COMPLETE

status_message

String

当该资源状态为任意失败状态（即以 FAILED 结尾时），将会展示简要的错误信息总结以供debug

resource_attributes

Array of ResourceAttribute objects

资源属性列表

key

String

资源属性的键

value

String

资源属性的值

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

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

200

列举资源栈资源成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

资源栈不存在

429

请求数量过多

500

服务器内部错误