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. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Stack operations
|
API |
Title |
Description |
| CreateStack | CreateStack | Creates a stack from a ROS template to deploy a group of resources. |
| UpdateStack | UpdateStack | Updates the resources in a stack. |
| 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. |
Scenario operations
|
API |
Title |
Description |
| CreateTemplateScratch | CreateTemplateScratch | Creates templatescratch: scenario. |
Template operations
|
API |
Title |
Description |
| CreateTemplate | CreateTemplate | Creates a custom template. |
| ListTemplates | List Templates | Queries a list of private and shared templates. |
| GetTemplateParameterConstraints | GetTemplateParameterConstraints | Queries the valid values of the parameters in a template. |
| ValidateTemplate | ValidateTemplate | Validates a template that is used to create a stack by specifying template URL or body. |
Stack group operations
|
API |
Title |
Description |
| CreateStackGroup | CreateStackGroup | Creates a stack group from an ROS template to create stacks across multiple Alibaba Cloud accounts and regions. |
| UpdateStackGroup | Update Stack Group | Updates an existing stack group. |
| ListStackGroups | ListStackGroups | Queries stack groups in a 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. |
Tag operations
|
API |
Title |
Description |
| TagResources | TagResources | Creates and adds tags to resources. |
| ListTagKeys | ListTagKeys | Queries the tag keys for stacks or templates in a specified region. |
Resource types operations
|
API |
Title |
Description |
| 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 a resource type, including its attributes, properties, and supported features. |
| ListResourceTypeVersions | ListResourceTypeVersions | Queries resource type versions, including versions created by you and versions provided by ROS. |
Other operations
|
API |
Title |
Description |
| 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 |
| CancelStackOperation | CancelStackOperation | Cancels operations on a stack. |
| 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. |
| ContinueCreateStack | ContinueCreateStack | Continues to create a stack after the stack fails to be created. |
| CreateAITask | Create AI Task | Create AI Task |
| CreateDiagnostic | CreateDiagnostic | Creates a dignosis task. |
| DeleteChangeSet | DeleteChangeSet | Deletes change sets. |
| DeleteDiagnostic | DeleteDiagnostic | Deletes a diagnostic record. |
| DeleteStack | DeleteStack | Deletes a stack, optionally retaining resources. |
| DeleteStackGroup | DeleteStackGroup | Deletes a stack group. |
| DeleteStackInstances | DeleteStackInstances | Deletes stack instances from specified accounts and regions. You can choose to retain the resources. |
| DeleteTemplate | DeleteTemplate | Deletes a template. |
| DeleteTemplateScratch | DeleteTemplateScratch | Deletes a scenario. |
| DescribeRegions | DescribeRegions | Queries a list of available regions. |
| 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. |
| EnableServiceAccess | EnableServiceAccess | Enables trusted service access. |
| EnableServices | EnableServices | Enables services in a batch. |
| ExecuteChangeSet | ExecuteChangeSet | Executes change sets. |
| GenerateTemplateByScratch | GenerateTemplateByScratch | Generates a template for a resource scenario. |
| GenerateTemplatePolicy | GenerateTemplatePolicy | Generate policy information using a template. |
| GetAITask | GetAITask | Queries the information about an AI task by task ID. |
| GetDiagnostic | GetDiagnostic | Obtains the diagnosis details based on a specified diagnostic report ID. |
| GetServiceAccess | GetServiceAccess | Queries the access status of a trusted service. |
| GetStack | GetStack | Query stack information. |
| GetStackDriftDetectionStatus | GetStackDriftDetectionStatus | Queries the drift detection status of a stack. |
| GetStackGroupOperation | GetStackGroupOperation | Queries the information about a stack group operation in an Alibaba Cloud region. |
| GetStackInstance | GetStackInstance | Queries the information about a stack instance that is associated with a stack group. |
| GetStackPolicy | GetStackPolicy | Queries the stack policy of a specified stack. |
| GetStackResource | GetStackResource | For more information about common request parameters, see \\[Common parameters]\\(~~131957~~). |
| GetTemplate | GetTemplate | Queries the details of a template based on stacks, stack groups, change sets, or any custom template information. |
| GetTemplateEstimateCost | GetTemplateEstimateCost | Queries the estimated prices of the resources in a template. |
| GetTemplateScratch | GetTemplateScratch | Queries the details of a resource scenario. |
| GetTemplateSummary | GetTemplateSummary | Queries the information about a template resource by using the relevant template, stack, stack group, or change set. |
| ImportStacksToStackGroup | ImportStacksToStackGroup | Import stacks from multiple different accounts into a stack group. |
| ListAITaskEvents | ListAITaskEvents | Queries the events of an AI task. |
| ListAITasks | ListAITasks | Queries a list of AI tasks. |
| ListDiagnostics | ListDiagnostics | Queries a diagnostic report. |
| ListResourceTypeRegistrations | ListResourceTypeRegistrations | Queries the registration records of a resource. |
| ListStackEvents | ListStackEvents | Queries a stack and the resource events of the stack. |
| ListStackGroupOperationResults | ListStackGroupOperationResults | Queries the results of an operation on a stack group. |
| ListStackGroupOperations | ListStackGroupOperations | Queries the information about stack group operations in an Alibaba Cloud region. |
| ListStackInstances | ListStackInstances | Queries the list of stack instances that are associated with a stack group in an Alibaba Cloud region. |
| ListStackOperationRisks | ListStackOperationRisks | Detects stack-related operation risks and returns missing permissions and the causes of the risks. |
| ListStackResourceDrifts | ListStackResourceDrifts | The query token. Set this parameter to the NextToken value returned in the last API call. |
| ListStackResources | ListStackResources | Queries the resources in a stack. In this example, the resources in the stack whose ID is \\`4a6c9851-3b0f-4f5f-b4ca-a14bf691\\*\\*\\*\\*\\` in the China (Hangzhou) region are queried. |
| ListStacks | ListStacks | Queries a list of stacks. |
| ListSummaries | ListSummaries | Queries for an overview. |
| ListTagResources | ListTagResources | Queries the tags 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. |
| ListTemplateScratches | ListTemplateScratches | Queries scenarios. |
| ListTemplateVersions | ListTemplateVersions | Queries the list of versions of a template. |
| MoveResourceGroup | MoveResourceGroup | Moves a resource to a specific resource group. |
| RegisterResourceType | RegisterResourceType | Creates a new resource type, or creates a new version for an existing resource type. |
| SetDeletionProtection | SetDeletionProtection | Modifies the deletion protection setting for a stack. |
| SetStackPolicy | SetStackPolicy | Configures a stack policy for a stack. |
| SetTemplatePermission | SetTemplatePermission | Shares or unshares a template. |
| SignalResource | SignalResource | Sends a signal to a resource in a stack. |
| StopStackGroupOperation | StopStackGroupOperation | Stops an ongoing operation in a stack group. |
| UntagResources | UntagResources | Removes tags from resources and then deletes the tags. |
| UpdateStackInstances | UpdateStackInstances | Updates stack instances for one or more accounts in specified regions. |
| UpdateStackTemplateByResources | UpdateStackTemplateByResources | Eliminates stack drifts by performing drift detection. |
| UpdateTemplate | Update Template | Update Template |
| UpdateTemplateScratch | UpdateTemplateScratch | Updates a scenario. |
该文章对您有帮助吗？