Hasko, Vladimir 354bef10dd RTS API 0930 version (recreate of #289 )

Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>

2022-12-02 15:11:35 +00:00

12 KiB

Raw Permalink Blame History

Querying Metadata of a Stack Resource

Function

This API is used to query metadata of a stack resource.

URI

GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/metadata

For details about the parameters, see Table 1.

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	String	Yes	Specifies the project ID.
stack_name	String	Yes	Specifies the stack name.
stack_id	String	Yes	Specifies the stack UUID.
resource_name	String	Yes	Specifies the name of the resource in the stack.

Request Parameter

N/A

Response Parameter

Parameter	In	Type	Description
metadata	body	Dict	Specifies the resource metadata.

Request Example

GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/metadata

Response Example

{
    "metadata": {
        "Name": "SmokeServer"
    }
}

Return Code

**Table 2** Normal return code
Return Code	Type	Description
200	OK	Request was successful.

**Table 3** Error return code
Return Code	Type	Description
400	Bad Request	The server failed to process the request.
401	Unauthorized	Authorization failed.
404	Not found	The requested resources are not found.

Parent topic: Stack Resource Management

12 KiB Raw Permalink Blame History