API Overview

Category	Description
Template management APIs	AOS template management APIs, which include APIs for creating, querying, updating, downloading, and deleting AOS templates. These APIs enable you to create, update, and delete templates; query templates, template lists, and template inputs.
Stack management APIs	AOS stack management APIs, which include APIs for creating, querying, and deleting stacks. These APIs enable you to create and delete stacks, execute stack lifecycle; query stacks, stack lists, stack elements, stack element lists, stack input and output, stack execution records, and lists of stack execution records.

Template Management APIs

AOS template management APIs include APIs for creating, querying, updating, and deleting AOS templates. These APIs enable you to create, update, download, and delete templates; query templates, template lists, and template inputs.

**Table 1** Template management APIs
API	Description
Creating a template	This API is used to create a template by uploading a local template to the server.
Querying a template list	This API is used to query a template list based on the parameters provided.
Updating a template	This API is used to update a template through either uploading local binary files or providing a template URL. The update can be performed only when the template has not been used to create any stacks or stacks created from this template have been deleted.
Deleting a template	This API is used to delete a specific template. The deletion can be performed only when the template has not been used to create a stack or stacks created from this template have been deleted.
Downloading a template	This API is used to download a specified template.
Querying a template	This API is used to query details about a specified template, including the template name, version, description, creation time, and update time.
Querying the input parameters of a template	This API is used to query the input parameters of a specific template.

Stack Management APIs

AOS stack management APIs include APIs for creating, querying, and deleting stacks. These APIs enable you to create and delete stacks, execute stack lifecycle; query stacks, stack lists, stack elements, stack element lists, stack input and output, stack execution records, and lists of stack execution records.

**Table 2** Stack management APIs
API	Description
Creating a stack	This API is used to create a stack. Stack inputs consist of templates and input parameters. A template defines the framework of a stack, and determines the structure of the nodes in the stack, the relationships between nodes, and the value or source of the attributes of each node. Input parameters are one of the sources of the node attribute values in the template. They are defined in the input fields of the template and are triggered by the get_input function in the template.
Deleting a stack	This API is used to delete a specific stack.
Executing a stack lifecycle	This API is used to perform lifecycle operations for a specific stack.
Querying the stack list	This API is used to query a stack list.
Querying a stack	This API is used to query details about a specified stack, including the stack name, stack description, template ID, template name, and stack status.
Querying a stack element list	This API is used to query a stack element list.
Querying a stack element	This API is used to query details about an element in a stack.
Querying a stack output	This API is used to query the output of a specified stack.
Querying a stack input	This API is used to query the input of a specific stack.
Querying an execution record of a stack	This API is used to query a stack execution record.
Querying a stack execution record list	This API is used to query the latest execution record list of a stack.