Obtaining a Stack Instance
Function
ShowStackInstance
This API obtains details about a stack instance, including the name and ID of its associated stack, creation time, and information about variable overriding.
URI
GET /v1/stack-sets/{stack_set_name}/stack-instances/{stack_instance_addr}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
stack_set_name |
Yes |
String |
Stack set name. The name is unique within its domain (domain_id) and region. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name is case-sensitive and must start with a letter. Minimum: 1 Maximum: 128 |
stack_instance_addr |
Yes |
String |
Unique address of a stack instance. The address combines region and stack_domain_id using slashes (/, whose escape codes are %2f or %2F). The address is unique within its domain (domain_id), region, and stack set (stack_set_name). Minimum: 1 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
stack_set_id |
No |
String |
Unique ID of a stack set. It is a UUID generated by RFS when a stack set is created. Stack set names are unique only at one specific time, so you can create a stack set named HelloWorld and another stack set with the same name after deleting the first one. For parallel development in a team, users may want to ensure that the stack set they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each stack set is different and does not change with updates. If the stack_set_id value is different from the current stack set ID, 400 is returned. Minimum: 36 Maximum: 36 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Client-Request-Id |
Yes |
String |
Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended. Minimum: 36 Maximum: 128 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
stack_set_id |
String |
Unique ID of a stack set. It is a UUID generated by RFS when a stack is created. Stack set names are unique only at one specific time, so you can create a stack set named HelloWorld and another stack set with the same name after deleting the first one. For parallel development in a team, users may want to ensure that the stack set they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each stack set is different and does not change with updates. If the stack_set_id value is different from the current stack set ID, 400 is returned. Minimum: 36 Maximum: 36 |
stack_set_name |
String |
Name of a stack set. The name is unique within its domain (domain_id) and region. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name is case-sensitive and must start with a letter. Minimum: 1 Maximum: 128 |
status |
String |
Stack instance status can be:
Enumeration values:
|
status_message |
String |
When the stack instance is in an INOPERABLE or OPERATION_FAILED state, brief error information is displayed for debugging. |
stack_id |
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 in a team, users may want to ensure that the stack they operate is the one created by themselves, not the one with the same name created by other teammates after deleting the previous one. Therefore, they can use this ID for strong matching. RFS ensures that the ID of each stack is different and does not change with updates. If the stack_id value is different from the current stack ID, 400 is returned. |
stack_name |
String |
Stack name. The name is unique within its domain (domain_id), region, and project (project_id). Only letters, digits, underscores (_), and hyphens (-) are allowed. The name is case-sensitive and must start with a letter. Minimum: 1 Maximum: 128 |
stack_domain_id |
String |
Tenant ID of the stack associated with the stack instance. |
latest_stack_set_operation_id |
String |
Stack set operation ID for the latest deployment of the stack instance. It is a UUID generated by RFS when a stack set operation is created. |
region |
String |
Region of the stack associated with the stack instance. |
create_time |
String |
Time when a stack instance is created. It uses a UTC (YYYY-MM-DDTHH:mm:ss.SSSZ) format, for example, 1970-01-01T00:00:00.000Z. |
update_time |
String |
Time when a stack instance is updated. It uses a UTC (YYYY-MM-DDTHH:mm:ss.SSSZ) format, for example, 1970-01-01T00:00:00.000Z. |
var_overrides |
var_overrides object |
Overridden variables of the stack instance. If you use the CreateStackInstances or UpdateStackInstances APIs to override variables on the stack instance, this field returns the latest overridden variables recorded by the stack instance. If this field is not returned, use the variables recorded in the stack set to deploy the instance. |
Parameter |
Type |
Description |
---|---|---|
vars_uri_content |
String |
File content corresponding to vars_uri. |
vars_body |
String |
Content of the HCL variable file. Transferring parameters is supported by the HCL template. The same template can use different parameters for different purposes.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 11 Maximum: 11 |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 11 Maximum: 11 |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 11 Maximum: 11 |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 11 Maximum: 11 |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 11 Maximum: 11 |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Response code. Minimum: 11 Maximum: 11 |
error_msg |
String |
Response message. |
encoded_authorization_message |
String |
The message contains information about unauthorized requests. |
Example Requests
Obtain details about the stack instance whose region is region_id and domain_id is my-domain-id.
GET https://{endpoint}/v1/stack-sets/my_stack_set/stack-instances/region_id%2fmy-domain-id
Example Responses
Status code: 200
Stack instance obtained.
{ "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" : "region_id", "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\"" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Stack instance obtained. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
The user does not have the permission to call this API. |
404 |
The stack set or the stack instance does not exist. |
429 |
Too frequent requests. |
500 |
Internal server error. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot