Deleting Stack Instances
Function
DeleteStackInstances
This API deletes the stack instance of a specified region or member account (domain_id) in a specified stack set and returns the stack set operation ID (stack_set_operation_id).
** Exercise caution when performing this operation. Deleting a stack instance will delete related stacks and all resources managed by the stacks.
You can obtain the stack set operation status by calling the ShowStackSetOperationMetadata API based on the stack set operation ID (stack_set_operation_id).
URI
POST /v1/stack-sets/{stack_set_name}/stack-instances/deletion
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 |
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 |
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 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 |
deployment_targets |
Yes |
deployment_targets object |
Deployment target information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
regions |
Yes |
Array of strings |
Regions involved in the stack set operations are specified by the user.
|
domain_ids |
No |
Array of strings |
When SELF_MANAGED permissions are used, the information about the tenant IDs involved in this operation is specified by the user.
You can specify either domain_ids or domain_ids_uri, but not both. Minimum: 1 Maximum: 64 |
domain_ids_uri |
No |
String |
When SELF_MANAGED permissions are used, the OBS address of the tenant IDs involved in this operation is specified by the user. Tenant IDs are separated by commas (,) and line breaks are supported. Currently, only CSV files are supported, and the files should be encoded in UTF-8. The file size cannot exceed 100 KB. Do not use Excel for operations on the CSV file to be uploaded. Otherwise, inconsistencies may occur in results read from the CSV file. You are advised to use Notepad to open the file and check whether the content complies with your expectation.
You can specify either domain_ids or domain_ids_uri, but not both. Minimum: 0 Maximum: 2048 |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
stack_set_operation_id |
String |
Unique ID of a stack set operation. It is a UUID generated by RFS when a stack set operation is created. Minimum: 36 Maximum: 36 |
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
Assign member account information through the URL signed by domain IDs.
POST https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances/deletion { "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids_uri" : "https://your-bucket.cn-north-7.myhuaweicloud.com/my-domain-ids.csv" } }
Assign member account information through the array of domain IDs.
POST https://{endpoint}/v1/stack-sets/my_hello_world_stack_set/stack-instances/deletion { "stack_set_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b4", "deployment_targets" : { "regions" : [ "cn-north-7" ], "domain_ids" : [ "0e0bc7572c0dfb74efa6c60ecd7b1dbf" ] } }
Example Responses
Status code: 202
The request is accepted and processed asynchronously.
{ "stack_set_operation_id" : "fb5e781e-a27d-46e2-9954-242753857a9f" }
Status Codes
Status Code |
Description |
---|---|
202 |
The request is accepted and processed asynchronously. |
400 |
Invalid request. |
401 |
Authentication failed. |
403 |
|
404 |
The stack set 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