Listing Stack Resources

project_id

Yes

String

A project ID is obtained by calling an API or from the console.

Obtaining a Project ID

stack_name

Yes

String

A stack name is unique within its domain (domain_id), region, and project (project_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

stack_id

No

String

Unique stack ID.

It is a UUID generated by RFS when a stack is created.

Stack names are unique at one specific time, so you can create a stack named HelloWorld and another stack with the same name after deleting the first one.

For parallel development, team members may want to ensure that they are operating the stack they created, not one with the same name created by other members after deleting the previous one.

To avoid this mismatch, check the ID, since RFS ensures each stack has a unique ID that does not change with updates. If the stack_id value differs from the current stack ID, 400 is returned.

marker

No

String

Pagination marker. When a single page cannot return all results, the previous request will return a next_marker to indicate there are more pages. Users can place the value of next_marker here to query information from the next page. This marker can only be used for requests with the same parameters as the previous request. If not specified, the query will start from the first page by default.

limit

No

Integer

The maximum number of results to return per page

Client-Request-Id

Yes

String

A unique request ID is specified by a user to locate a request. UUID is recommended.

stack_resources

Array of StackResource objects

List of resources managed by a stack.

page_info

page_info object

Pagination information

physical_resource_id

String

Physical ID of a resource, generated by the resource provider, cloud service provider, or other service providers during resource deployment.

physical_resource_name

String

Physical name of the resource, defined by the resource provider, cloud service provider, or other service providers during resource deployment.

logical_resource_name

String

Logical name of the resource, defined in a template.

Logical variables are only used as identifiers of the resource in the template.

For example, in the following HCL template, the value of logical_resource_name is my_hello_world_vpc.

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

In a JSON template, the value of logical_resource_name is my_hello_world_vpc.

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

logical_resource_type

String

Resource type.

Logical variables are only used as identifiers of the resource in the template.

For example, in the following HCL template, the value of logical_resource_type is huaweicloud_vpc.

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

In a JSON template, the value of logical_resource_type is huaweicloud_vpc.

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

index_key

String

Resource index. If count or for_each is used in a template, index_key is returned. If index_key appears, logical_resource_name + index_key can be used as an identifier of the resource.

If count is used in a template, index_key is a number starting from 0.

For example, in the following HCL template, you can use huaweicloud_vpc.my_hello_world_vpc[0] and huaweicloud_vpc.my_hello_world_vpc[1] to identify two resources.

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

In a JSON template, you can use huaweicloud_vpc.my_hello_world_vpc[0] and huaweicloud_vpc.my_hello_world_vpc[1] to identify two resources.

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

If for_each is used in a template, index_key is a user-defined string.

For example, in the following HCL template, huaweicloud_vpc.my_hello_world_vpc["vpc1"] and huaweicloud_vpc.my_hello_world_vpc["vpc2"] identify two resources.

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

In a JSON template, huaweicloud_vpc.my_hello_world_vpc["vpc1"] and

huaweicloud_vpc.my_hello_world_vpc["vpc2"] identify two resources.

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

resource_status

String

Status of the resource.

• CREATION_IN_PROGRESS: The resource is being created.

• CREATION_FAILED: Create resource failed.

• CREATION_COMPLETE: Resource created.

• DELETION_IN_PROGRESS: The resource is being deleted.

• DELETION_FAILED: Delete resource failed.

• DELETION_COMPLETE: Resource deleted.

• UPDATE_IN_PROGRESS: The resource is being updated. The update is not a replacement. In the case of a replacement update, a replacement resource is created and then the old resource is deleted.

• UPDATE_FAILED: Update resource failed. The update is not a replacement. In the case of a replacement update, a replacement resource is created and then the old resource is deleted.

• UPDATE_COMPLETE: Resource updated. The update is not a replacement. In the case of a replacement update, a replacement resource is created and then the old resource is deleted.

status_message

String

If the resource is in a failure state (ending with FAILED), a summary of the error information is displayed for debugging.

resource_attributes

Array of ResourceAttribute objects

Resource attribute list.

key

String

Resource attribute key.

value

String

Resource attribute value.

next_marker

String

Forward pagination identifier. Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to get the next part of the outputs. You should repeat this until the next_marker response is set to null.

previous_marker

String

Backward pagination identifier.

current_count

Integer

The number of items returned on current page.

error_code

String

Response code.

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error messages returned by service when permission is denied.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error messages returned by service when permission is denied.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error messages returned by service when permission is denied.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error messages returned by service when permission is denied.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error messages returned by service when permission is denied.

error_code

String

Response code.

error_msg

String

Response message.

error_code

String

Response code.

error_msg

String

Response message.

encoded_authorization_message

String

The message contains information about unauthorized requests.

details

Array of Detail objects

Detailed error messages returned by service when permission is denied.

error_code

String

Response code.

error_msg

String

Response message.

200

Stack resources listed.

400

Invalid request.

401

Authentication failed.

403

The user does not have the permission to call this API.

404

The stack does not exist.

429

Too frequent requests.

500

Internal server error.