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 (78410016550) 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 |
|---|---|---|
| CreateStack | CreateStack | Creates a stack that contains a collection of resources by using a Resource Orchestration Service (ROS) template. |
| DeleteStack | DeleteStack | Deletes a stack. You can specify whether to retain resources. |
| UpdateStack | UpdateStack | Updates a stack. |
| ContinueCreateStack | ContinueCreateStack | Continues to create a stack after the stack fails to be created. |
| GetStack | GetStack | Queries the information about a stack in Resource Orchestration Service (ROS). |
| ListStacks | ListStacks | Queries a list of stacks. |
| CancelUpdateStack | CancelUpdateStack | Cancels an update operation on a stack. You can call this operation to cancel an update operation on a stack when the stack is being updated or created. |
| CancelStackOperation | CancelStackOperation | Cancels operations on a stack. |
| SetDeletionProtection | SetDeletionProtection | Modifies the deletion protection setting for a stack. |
| ListStackEvents | ListStackEvents | Queries a stack and the resource events of the stack. |
| ListStackOperationRisks | ListStackOperationRisks | Detects stack-related operation risks and returns missing permissions and the causes of the risks. |
| PreviewStack | PreviewStack | Previews the information about a stack that you want to create based on a template. You can call this operation to verify whether the template resources are valid. |
Resource operations
| API | Title | Description |
|---|---|---|
| ListStackResources | ListStackResources | This topic provides an example on how to query the resources in a specified stack. In this example, the resources in the stack whose ID is \`4a6c9851-3b0f-4f5f-b4ca-a14bf691\*\*\*\*\` in the China (Hangzhou) region are queried. |
| GetStackResource | GetStackResource | For more information about common request parameters, see \[Common parameters]\(~~131957~~). |
| MoveResourceGroup | MoveResourceGroup | Moves a resource to a specific resource group. |
Scenario operations
| API | Title | Description |
|---|---|---|
| CreateTemplateScratch | CreateTemplateScratch | Creates a resource scenario. |
| DeleteTemplateScratch | DeleteTemplateScratch | Deletes a scenario. |
| UpdateTemplateScratch | UpdateTemplateScratch | Updates a scenario. |
| ListTemplateScratches | ListTemplateScratches | Queries scenarios. |
| GetTemplateScratch | GetTemplateScratch | Queries the details of a resource scenario. |
| GenerateTemplateByScratch | GenerateTemplateByScratch | Generates a template for a resource scenario. |
Template operations
| API | Title | Description |
|---|---|---|
| CreateTemplate | CreateTemplate | Creates a custom template. |
| DeleteTemplate | DeleteTemplate | Deletes a template. |
| UpdateTemplate | UpdateTemplate | Updates a template by specifying the template URL or template details. |
| GetTemplate | GetTemplate | Queries the details of a template based on stacks, stack groups, change sets, or any custom template information. |
| ListTemplates | ListTemplates | Queries a list of private or shared templates. |
| ListTemplateVersions | ListTemplateVersions | Queries the list of versions of a template. |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | Queries the values of one or more parameters in a template. |
| SetTemplatePermission | SetTemplatePermission | Shares or unshares a template. |
| GetTemplateEstimateCost | GetTemplateEstimateCost | Queries the estimated prices of the resources in a template. |
| GetTemplateSummary | GetTemplateSummary | Queries the information about a template resource by using the relevant template, stack, stack group, or change set. |
| ValidateTemplate | ValidateTemplate | Validates a template by using a template URL or template body. The template is used 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 | Configures a stack policy for a stack. |
| GetStackPolicy | GetStackPolicy | Queries the information about a stack policy in an Alibaba Cloud region. |
API operations related to change sets
| API | Title | Description |
|---|---|---|
| CreateChangeSet | CreateChangeSet | Creates a change set for a stack. You can view proposed changes before you execute the change set. |
| DeleteChangeSet | DeleteChangeSet | Deletes change sets. |
| GetChangeSet | GetChangeSet | Queries change sets. You can determine whether to query the templates of change sets. |
| ListChangeSets | ListChangeSets | Queries change sets. |
| ExecuteChangeSet | ExecuteChangeSet | Executes change sets. |
Stack group operations
| API | Title | Description |
|---|---|---|
| CreateStackGroup | CreateStackGroup | Creates stack groups based on Resource Orchestration Service (ROS) templates. Stack groups allow you to create stacks within multiple Alibaba Cloud accounts across regions. |
| DeleteStackGroup | DeleteStackGroup | Deletes a stack group. |
| UpdateStackGroup | UpdateStackGroup | The region ID of the stack group. You can call the \[DescribeRegions]\(~~131035~~) operation to query the latest list of Alibaba Cloud regions. |
| ListStackGroups | ListStackGroups | Queries a list of stack groups in an Alibaba Cloud region. |
| GetStackGroup | GetStackGroup | In this example, the information about a stack group named \\`MyStackGroup\\` is queried. The stack group is granted self-managed permissions and created in the China (Hangzhou) region. |
| CreateStackInstances | CreateStackInstances | Creates stack instances in the specified accounts and regions. |
| DeleteStackInstances | DeleteStackInstances | Deletes stack instances in the specified accounts and regions. You can retain specific resources based on your business requirements when you call this operation. |
| UpdateStackInstances | UpdateStackInstances | Updates stack instances in the specified accounts and regions. |
| GetStackInstance | GetStackInstance | Queries the information about a stack instance that is associated with a stack group. |
| StopStackGroupOperation | StopStackGroupOperation | Stops an ongoing operation in a stack group. |
| ListStackInstances | ListStackInstances | Queries the list of stack instances that are associated with a stack group in an Alibaba Cloud region. |
| GetStackGroupOperation | GetStackGroupOperation | Queries the information about a stack group operation in an Alibaba Cloud region. |
| ListStackGroupOperations | ListStackGroupOperations | Queries the information about stack group operations in an Alibaba Cloud region. |
| ListStackGroupOperationResults | ListStackGroupOperationResults | Queries the results of an operation on a stack group. |
Drift detection operations
| API | Title | Description |
|---|---|---|
| UpdateStackTemplateByResources | UpdateStackTemplateByResources | Eliminates stack drifts by performing drift detection. |
| GetStackDriftDetectionStatus | GetStackDriftDetectionStatus | Queries the drift detection status of a stack. |
| ListStackResourceDrifts | ListStackResourceDrifts | The query token. Set this parameter to the NextToken value returned in the last API call. |
| DetectStackDrift | DetectStackDrift | Performs drift detection on resources in a stack to check whether the resources have drifted from the expected template configurations. |
| DetectStackGroupDrift | DetectStackGroupDrift | Performs drift detection on stack groups to check whether the stack groups have drifted from the expected template configurations. |
| DetectStackResourceDrift | DetectStackResourceDrift | Performs drift detection on resources in a stack to determine whether the resources have drifted from the expected configurations. |
Tag operations
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Creates and adds tags to resources. |
| ListTagResources | ListTagResources | Queries the tags that are added to resources in a template or stack in an Alibaba Cloud region. |
| ListTagKeys | ListTagKeys | Queries the tag keys that are added to resources in a template or stack in an Alibaba Cloud region. |
| ListTagValues | ListTagValues | Queries the tag values that are added to resources in a template or stack in an Alibaba Cloud region. |
| UntagResources | UntagResources | Removes tags from resources and then deletes the tags. |
Diagnostics operations
| API | Title | Description |
|---|---|---|
| CreateDiagnostic | CreateDiagnostic | Creates a dignosis task. |
| GetDiagnostic | GetDiagnostic | Obtains the diagnosis details based on a specified diagnostic report ID. |
| ListDiagnostics | ListDiagnostics | Queries a diagnostic report. |
| DeleteDiagnostic | DeleteDiagnostic | Deletes a diagnostic record. |
Resource types operations
| API | Title | Description |
|---|---|---|
| RegisterResourceType | RegisterResourceType | Creates a new resource type, or creates a new version for an existing resource type. |
| SetResourceType | SetResourceType | Modifies a resource type or a version of a resource type. |
| DeregisterResourceType | DeregisterResourceType | Deletes a resource type or a version of a resource type. |
| ListResourceTypes | ListResourceTypes | This topic provides an example on how to query the list of resource types supported by Resource Orchestration Service (ROS). |
| GetResourceTypeTemplate | GetResourceTypeTemplate | Generates a sample template based on a resource type. |
| GetResourceType | GetResourceType | This topic provides an example on how to query the details of \`ALIYUN::ROS::WaitConditionHandle\`. |
| ListResourceTypeVersions | ListResourceTypeVersions | Queries the versions of resource types, including the resource types created by you and provided by Resource Orchestration Service (ROS). |
| ListResourceTypeRegistrations | ListResourceTypeRegistrations | Queries the registration records of a resource. |
Other operations
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Queries a list of available regions. |
| SignalResource | SignalResource | Sends a signal to a resource in a stack. |
| 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). |