All Products
Document Center

Resource Orchestration Service:List of operations by function

Last Updated:May 24, 2023
This product(ROS/2019-09-10) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Stack operations

ListStackOperationRisksListStackOperationRisksDetects stack-related operation risks and returns missing permissions and the causes of the risks.
CancelStackOperationCancelStackOperationCancels an operation on a stack.
CreateStackCreateStackCreates a stack.
DeleteStackDeleteStackDeletes a stack. You can specify whether to retain resources.
UpdateStackUpdateStackUpdates a stack.
SetDeletionProtectionSetDeletionProtectionYou SetDeletionProtection call this operation to modify deletion protection for a stack.
CancelUpdateStackCancelUpdateStackYou can call this operation to cancel the update of a stack.
ContinueCreateStackContinueCreateStackContinues to create a stack that failed to be created.
GetStackGetStackQueries the information about a stack.
ListStacksListStacksQueries the list of stacks.
ListStackEventsListStackEventsQueries a stack and its resource events.
PreviewStackPreviewStackPreviews the information about a stack that you want to create based on a specified template. You can use this operation to verify the resources in the template.

Resource operations

ListStackResourcesListStackResourcesQueries the resources in a specified stack.
GetStackResourceGetStackResourceQueries the resource in a stack.
SignalResourceSignalResourceYou can call this operation to send signals.

Scenario operations

GenerateTemplateByScratchGenerateTemplateByScratchCreates a template for a scenario.
DeleteTemplateScratchDeleteTemplateScratchDeletes a scenario.
GetTemplateScratchGetTemplateScratchQueries the details about a scenario.
ListTemplateScratchesListTemplateScratchesQueries the list of scenarios.
UpdateTemplateScratchUpdateTemplateScratchUpdates a scenario.
CreateTemplateScratchCreateTemplateScratchCreates a scenario.

Template operations

CreateTemplateCreateTemplateCreates a template.
DeleteTemplateDeleteTemplateYou can call this operation to delete a template.
UpdateTemplateUpdateTemplateYou can call this operation to update a template.
SetTemplatePermissionSetTemplatePermissionYou can call this operation to share or unshare a template.
GetTemplateEstimateCostGetTemplateEstimateCostQueries the estimated prices of the resources in a template.
GetTemplateGetTemplateQueries the details of a template. For example, you can call the operation to query the stack, stack group, and change set defined in a custom template.
ListTemplatesListTemplatesQueries the list of templates.
GetTemplateSummaryGetTemplateSummaryQueries the information about a new or existing template.
ListTemplateVersionsListTemplateVersionsQueries the list of versions of a template.
GetTemplateParameterConstraintsGetTemplateParameterConstraintsQueries the values of one or more parameters in a template.
ValidateTemplateValidateTemplateValidates a template that you want to use to create a stack.
GenerateTemplatePolicyGenerateTemplatePolicyGenerates the information about a policy that is required by a template.

Stack policy operations

SetStackPolicySetStackPolicyYou can call this operation to configure a stack policy.
GetStackPolicyGetStackPolicyYou can call this operation to query information about a stack policy.

API operations related to change sets

CreateChangeSetCreateChangeSetCreates a change set.
DeleteChangeSetDeleteChangeSetYou can call this operation to delete a change set.
GetChangeSetGetChangeSetQueries the information of a change set.
ListChangeSetsListChangeSetsYou can call this operation to query the list of change sets.
ExecuteChangeSetExecuteChangeSetYou can call this operation to execute a change set.

Stack group operations

CreateStackGroupCreateStackGroupCreates a stack group.
CreateStackInstancesCreateStackInstancesCreates stacks for specified accounts in specified regions.
DeleteStackGroupDeleteStackGroupDeletes a stack group.
DeleteStackInstancesDeleteStackInstancesDeletes stacks for specified accounts in specified regions.
UpdateStackGroupUpdateStackGroupUpdates a stack group.
UpdateStackInstancesUpdateStackInstancesUpdates stacks for specified accounts in specified regions.
StopStackGroupOperationStopStackGroupOperationStops a stack group operation.
GetStackGroupGetStackGroupQueries the information about a stack group.
ListStackGroupsListStackGroupsQueries the list of stack groups.
GetStackInstanceGetStackInstanceQueries the details of a stack that is deployed in a stack group within a specified account in a specified region.
ListStackInstancesListStackInstancesQueries the stacks that are deployed in a stack group.
GetStackGroupOperationGetStackGroupOperationQueries the details of an operation that you perform on a stack group.
ListStackGroupOperationsListStackGroupOperationsYou can call this operation to query the list of stack group operations.
ListStackGroupOperationResultsListStackGroupOperationResultsQueries the results of an operation on a stack group.

Drift detection operations

UpdateStackTemplateByResourcesUpdateStackTemplateByResourcesCorrects a template to eliminate stack drift.
GetStackDriftDetectionStatusGetStackDriftDetectionStatusQueries the drift detection status of a stack.
ListStackResourceDriftsListStackResourceDriftsYou can call this operation to query the drift information of resources in a specified stack.
DetectStackDriftDetectStackDriftYou can call this operation to detect drift on a stack.
DetectStackGroupDriftDetectStackGroupDriftYou can call this operation to detect drift on a stack group.
DetectStackResourceDriftDetectStackResourceDriftYou can call this operation to detect drift on individual resources in a stack.

Tag operations

ListTagResourcesListTagResourcesQueries the tags that are added to one or more Resource Orchestration Service (ROS) resources.
ListTagKeysListTagKeysQueries tag keys.
ListTagValuesListTagValuesQueries one or more tag values of a specified tag key.
TagResourcesTagResourcesCreates tags and adds the tags to specified Resource Orchestration Service (ROS) resources.
UntagResourcesUntagResourcesRemoves tags from the specified Resource Orchestration Service (ROS) resources.
MoveResourceGroupMoveResourceGroupMoves a resource to a specific resource group.

ListResourceTypesListResourceTypesQueries the list of supported resource types.
GetResourceTypeTemplateGetResourceTypeTemplateGenerates a sample template based on a resource type.
GetResourceTypeGetResourceTypeQueries the details of resource types.

Other operations

GetServiceProvisionsGetServiceProvisionsQueries the activation status and the RAM roles of an Alibaba Cloud service.
GetFeatureDetailsGetFeatureDetailsQueries the details of features that are supported by Resource Orchestration Service (ROS).
DescribeRegionsDescribeRegionsQueries the list of available regions.