List of API operations by function

更新时间:
复制 MD 格式

The following tables list the API operations available for use in Resource Orchestration Service (ROS).

Stack operations

You can define a template for resources in a stack and their dependencies and use the template to create stacks. After the stacks are created, you can query, update, or delete the stacks.

APIDescription
PreviewStackPreviews the stack to be created by using a specified template.
CreateStackCreates a stack.
ContinueCreateStackCreates another stack based on the template of the previous stack that failed.
SetDeletionProtectionConfigures deletion protection on a stack.
UpdateStackUpdates a stack.
CancelUpdateStackCancels the update of a stack.
GetStackQueries the information of a stack.
ListStacksQueries the list of stacks.
ListStackEventsQueries stacks and their resource events.
ListStackOperationRisksDetects resources that may face high risks caused by a stack deletion operation, and queries the reason for each risk.
DeleteStackDeletes a stack and all of its resources.

Resource operations

ROS allows you to manage a variety of resources. You can query resource templates by resource type or query details of resource types or resources in a specified stack to obtain the information of resources in ROS.

For more information about the resource types supported by ROS, see Resource type index.

APIDescription
GetResourceTypeTemplateQueries the template of a resource by resource type.
ListStackResourcesQueries the resource list of a specified stack.
GetStackResourceQueries information about a resource in a specified stack.
GetResourceTypeQueries the details of resource types.
ListResourceTypesQueries the list of supported resource types.
MoveResourceGroupMoves a resource to a specific resource group.

Scenario operations

ROS provides the scenario feature to facilitate resource management. You can add resources to a scenario in the console and perform operations such as replication and centralized management on the resources.

APIDescription
CreateTemplateScratchCreates a scenario.
UpdateTemplateScratchUpdates a scenario.
ListTemplateScratchesQueries the list of scenarios.
GetTemplateScratchQueries the information of a scenario.
DeleteTemplateScratchDeletes a scenario.
GenerateTemplateByScratchGenerates a scenario template.

Template operations

A template is a JSON or YAML text file that defines resources in a stack and their dependencies and can be used to create stacks. For example, you can call the CreateTemplate operation to create a template that contains the ALIYUN::ECS::VPC resource, and then call the CreateStack operation to create a stack. This way, you can create a virtual private cloud (VPC).

In addition, you can query the template ID, template content, or resource prices defined in the template. You can also share your template with other users. This way, one template can be used by multiple Alibaba Cloud accounts to allow stacks to be efficiently created.

APIDescription
GenerateTemplatePolicyGenerates policy information for a template.
CreateTemplateCreates a template.
ValidateTemplateValidates a template that you want to use to create stacks.
UpdateTemplateUpdates a template.
GetTemplateQueries the detailed information of a template, including the stacks and change sets that are associated with the template.
GetTemplateEstimateCostQueries the estimated prices of resources to be created based on a template.
GetTemplateSummaryQueries the information of a new or existing template.
GetTemplateParameterConstraintsQueries the values of template parameters.
ListTemplatesQueries the list of templates.
ListTemplateVersionsQueries one or more versions of a template.
SetTemplatePermissionShares or unshares a template.
DeleteTemplateDeletes a template.

Stack policy operations

A stack policy is a JSON or YAML text file that is used to define the update operations for a specified stack to prevent resources in the stack from being accidentally updated or deleted during the update of the stack. You can configure or query stack policies.

APIDescription
SetStackPolicyConfigures a stack policy.
GetStackPolicyQueries the information of a stack policy.

Change set operations

You can create and execute change sets to update running stacks.

APIDescription
CreateChangeSetCreates a change set.
ExecuteChangeSetExecutes a change set.
GetChangeSetQueries the information of a change set.
ListChangeSetsQueries the list of change sets.
DeleteChangeSetDeletes a change set.

Stack group operations

You can use a stack group as a unit to manage stacks in ROS. You can use templates to create stack groups. This way, you can create stacks within multiple Alibaba Cloud accounts across regions. You can also query the information of stack groups and stack group operations.

After you call the CreateStackGroup operation to create a stack group, you can call the CreateStackInstances operation to create a stack instance within a specified account in a specified region.

Note Before you call the DeleteStackGroup operation to delete a stack group, you need to call the DeleteStackInstances operation to delete all stack instances from the stack group.
APIDescription
CreateStackGroupCreates a stack group.
UpdateStackGroupUpdates a stack group.
GetStackGroupQueries the information of a stack group.
ListStackGroupsQueries the list of stack groups.
GetStackGroupOperationQueries the information of a stack group operation.
ListStackGroupOperationsQueries the list of stack group operations.
ListStackGroupOperationResultsQueries the results of an operation on a stack group.
StopStackGroupOperationStops a stack group operation.
CreateStackInstancesCreates stack instances within a specified account in a specified region.
UpdateStackInstancesUpdates stack instances within a specified account in a specified region.
GetStackInstanceQueries the detailed information about a stack instance associated with a stack group.
ListStackInstancesQueries the stack instances that are associated with a stack group.
DeleteStackInstancesDeletes stack instances within a specified account in a specified region.
DeleteStackGroupDeletes a stack group.

Drift detection operations

When you change resource configurations by using a service that is beyond the control of ROS, the related stack or stack group may experience drift. You can perform drift detection to correct drift. For example, you can call the DetectStackDrift operation to perform drift detection on a stack. If the stack has drifted, you can call the UpdateStackTemplateByResources operation to modify the stack template to eliminate stack drift.

APIDescription
DetectStackResourceDriftDetects drift on individual resources in a stack.
DetectStackDriftDetects drift on a stack.
DetectStackGroupDriftDetects drift on a stack group.
GetStackDriftDetectionStatusQueries the drift detection status of a stack.
ListStackResourceDriftsQueries the drift information of resources in a specified stack.
UpdateStackTemplateByResourcesCorrects a template to eliminate stack drift.

Tag operations

You can add tags to stacks, stack groups, or templates for classification and management purposes.

APIDescription
TagResourcesCreates and adds tags to a specified ROS resource list.
ListTagResourcesQueries tags that are added to one or more ROS resources.
ListTagKeysQueries the list of tag keys.
ListTagValuesQueries one or more values of a specified tag key.
UntagResourcesRemoves and deletes tags from a specified ROS resource list.

Other operations

When you create a stack, stack group, or stack instance, you must specify the RegionId parameter. In this case, you can call the DescribeRegions operation to query the most recent region list.

When you create or update a stack, you can call the SignalResource operation to send signals. Failure signals can cause stack creation or update to fail.

In addition, you can call the GetServiceProvisions operation to query the activation status and the RAM role information of multiple cloud services at the same time, and call the GetFeatureDetails operation to query the details of specific features supported by ROS.

APIDescription
DescribeRegionsQueries available regions.
SignalResourceSends signals.
GetServiceProvisionsQueries the activation status and the RAM roles of an Alibaba Cloud service.
GetFeatureDetailsQueries the details of a feature that is supported by ROS.