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
| API | Title | Description |
|---|---|---|
| ListStackOperationRisks | ListStackOperationRisks | Detects stack-related operation risks and returns missing permissions and the causes of the risks. |
| CancelStackOperation | CancelStackOperation | Cancels an operation on a stack. |
| CreateStack | CreateStack | Creates a stack. |
| DeleteStack | DeleteStack | Deletes a stack. You can specify whether to retain resources. |
| UpdateStack | UpdateStack | Updates a stack. |
| SetDeletionProtection | SetDeletionProtection | You SetDeletionProtection call this operation to modify deletion protection for a stack. |
| CancelUpdateStack | CancelUpdateStack | You can call this operation to cancel the update of a stack. |
| ContinueCreateStack | ContinueCreateStack | Continues to create a stack that failed to be created. |
| GetStack | GetStack | Queries the information about a stack. |
| ListStacks | ListStacks | Queries the list of stacks. |
| ListStackEvents | ListStackEvents | Queries a stack and its resource events. |
| PreviewStack | PreviewStack | Previews 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
| API | Title | Description |
|---|---|---|
| ListStackResources | ListStackResources | Queries the resources in a specified stack. |
| GetStackResource | GetStackResource | Queries the resource in a stack. |
| SignalResource | SignalResource | You can call this operation to send signals. |
Scenario operations
| API | Title | Description |
|---|---|---|
| GenerateTemplateByScratch | GenerateTemplateByScratch | Creates a template for a scenario. |
| DeleteTemplateScratch | DeleteTemplateScratch | Deletes a scenario. |
| GetTemplateScratch | GetTemplateScratch | Queries the details about a scenario. |
| ListTemplateScratches | ListTemplateScratches | Queries the list of scenarios. |
| UpdateTemplateScratch | UpdateTemplateScratch | Updates a scenario. |
| CreateTemplateScratch | CreateTemplateScratch | Creates a scenario. |
Template operations
| API | Title | Description |
|---|---|---|
| CreateTemplate | CreateTemplate | Creates a template. |
| DeleteTemplate | DeleteTemplate | You can call this operation to delete a template. |
| UpdateTemplate | UpdateTemplate | You can call this operation to update a template. |
| SetTemplatePermission | SetTemplatePermission | You can call this operation to share or unshare a template. |
| GetTemplateEstimateCost | GetTemplateEstimateCost | Queries the estimated prices of the resources in a template. |
| GetTemplate | GetTemplate | Queries 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. |
| ListTemplates | ListTemplates | Queries the list of templates. |
| GetTemplateSummary | GetTemplateSummary | Queries the information about a new or existing template. |
| ListTemplateVersions | ListTemplateVersions | Queries the list of versions of a template. |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | Queries the values of one or more parameters in a template. |
| ValidateTemplate | ValidateTemplate | Validates a template that you want to use to create a stack. |
| GenerateTemplatePolicy | GenerateTemplatePolicy | Generates the information about a policy that is required by a template. |
Stack policy operations
| API | Title | Description |
|---|---|---|
| SetStackPolicy | SetStackPolicy | You can call this operation to configure a stack policy. |
| GetStackPolicy | GetStackPolicy | You can call this operation to query information about a stack policy. |
API operations related to change sets
| API | Title | Description |
|---|---|---|
| CreateChangeSet | CreateChangeSet | Creates a change set. |
| DeleteChangeSet | DeleteChangeSet | You can call this operation to delete a change set. |
| GetChangeSet | GetChangeSet | Queries the information of a change set. |
| ListChangeSets | ListChangeSets | You can call this operation to query the list of change sets. |
| ExecuteChangeSet | ExecuteChangeSet | You can call this operation to execute a change set. |
Stack group operations
| API | Title | Description |
|---|---|---|
| CreateStackGroup | CreateStackGroup | Creates a stack group. |
| CreateStackInstances | CreateStackInstances | Creates stacks for specified accounts in specified regions. |
| DeleteStackGroup | DeleteStackGroup | Deletes a stack group. |
| DeleteStackInstances | DeleteStackInstances | Deletes stacks for specified accounts in specified regions. |
| UpdateStackGroup | UpdateStackGroup | Updates a stack group. |
| UpdateStackInstances | UpdateStackInstances | Updates stacks for specified accounts in specified regions. |
| StopStackGroupOperation | StopStackGroupOperation | Stops a stack group operation. |
| GetStackGroup | GetStackGroup | Queries the information about a stack group. |
| ListStackGroups | ListStackGroups | Queries the list of stack groups. |
| GetStackInstance | GetStackInstance | Queries the details of a stack that is deployed in a stack group within a specified account in a specified region. |
| ListStackInstances | ListStackInstances | Queries the stacks that are deployed in a stack group. |
| GetStackGroupOperation | GetStackGroupOperation | Queries the details of an operation that you perform on a stack group. |
| ListStackGroupOperations | ListStackGroupOperations | You can call this operation to query the list of stack group operations. |
| ListStackGroupOperationResults | ListStackGroupOperationResults | Queries the results of an operation on a stack group. |
Drift detection operations
| API | Title | Description |
|---|---|---|
| UpdateStackTemplateByResources | UpdateStackTemplateByResources | Corrects a template to eliminate stack drift. |
| GetStackDriftDetectionStatus | GetStackDriftDetectionStatus | Queries the drift detection status of a stack. |
| ListStackResourceDrifts | ListStackResourceDrifts | You can call this operation to query the drift information of resources in a specified stack. |
| DetectStackDrift | DetectStackDrift | You can call this operation to detect drift on a stack. |
| DetectStackGroupDrift | DetectStackGroupDrift | You can call this operation to detect drift on a stack group. |
| DetectStackResourceDrift | DetectStackResourceDrift | You can call this operation to detect drift on individual resources in a stack. |
Tag operations
| API | Title | Description |
|---|---|---|
| ListTagResources | ListTagResources | Queries the tags that are added to one or more Resource Orchestration Service (ROS) resources. |
| ListTagKeys | ListTagKeys | Queries tag keys. |
| ListTagValues | ListTagValues | Queries one or more tag values of a specified tag key. |
| TagResources | TagResources | Creates tags and adds the tags to specified Resource Orchestration Service (ROS) resources. |
| UntagResources | UntagResources | Removes tags from the specified Resource Orchestration Service (ROS) resources. |
| MoveResourceGroup | MoveResourceGroup | Moves a resource to a specific resource group. |
| API | Title | Description |
|---|---|---|
| ListResourceTypes | ListResourceTypes | Queries the list of supported resource types. |
| GetResourceTypeTemplate | GetResourceTypeTemplate | Generates a sample template based on a resource type. |
| GetResourceType | GetResourceType | Queries the details of resource types. |
Other operations
| API | Title | Description |
|---|---|---|
| GetServiceProvisions | GetServiceProvisions | Queries the activation status and the RAM roles of an Alibaba Cloud service. |
| GetFeatureDetails | GetFeatureDetails | Queries the details of features that are supported by Resource Orchestration Service (ROS). |
| DescribeRegions | DescribeRegions | Queries the list of available regions. |