API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (ROS/2019-09-10) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Stack operations
|
API |
Title |
Description |
| CreateStack | CreateStack | Use Resource Orchestration Service (ROS) template to create a stack and deploy a group of resources. |
| DeleteStack | DeleteStack | Deletes a stack. You can specify whether to retain resources. |
| UpdateStack | UpdateStack | Updates the resource information of a created 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 or update 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 templatescratch: 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 | Update Template | Update Template |
| GetTemplate | GetTemplate | Queries the details of a template based on stacks, stack groups, change sets, or any custom template information. |
| ListTemplates | List Templates | List Templates |
| ListTemplateVersions | ListTemplateVersions | Queries the list of versions of a template. |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | Queries the valid values of the 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 that is used to create a stack by specifying template URL or body. |
| 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. |
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 | Update Stack Group | Updates an existing stack group. |
| ListStackGroups | ListStackGroups | Queries details of stack groups in a specified Alibaba Cloud region. |
| GetStackGroup | GetStackGroup | Queries the details of a stack group by its name in an Alibaba Cloud region. |
| CreateStackInstances | CreateStackInstances | Creates stack instances for one or more accounts in the specified 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. |
| ImportStacksToStackGroup | ImportStacksToStackGroup | Import stacks from multiple different accounts into 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 for stacks or templates in a specified 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 the description of a resource type or a version of that type. |
| DeregisterResourceType | DeregisterResourceType | Deletes a resource type or a specific version of a resource type. |
| 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 a resource type. |
| ListResourceTypeVersions | ListResourceTypeVersions | Queries resource type versions, including versions created by you and versions provided by 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 of an Alibaba Cloud service and information about its service-linked roles. |
| GetFeatureDetails | GetFeatureDetails | Queries the details of features that are supported by Resource Orchestration Service (ROS). |
Others
|
API |
Title |
Description |
| EnableServiceAccess | EnableServiceAccess | Enables trusted service access. |
| EnableServices | EnableServices | Enables services in a batch. |
| GetServiceAccess | GetServiceAccess | Queries a trusted service. |
| ListSummaries | ListSummaries | Queries for an overview. |