API standards and multilingual preset SDKs
The OpenAPI of this product (ROS/2019-09-10) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
AI task operations
|
API |
Title |
Description |
| CreateAITask | Create AI Task | Create AI Task |
| GetAITask | GetAITask | Queries the information about an AI task by task ID. |
| ListAITasks | ListAITasks | Queries a list of AI tasks. |
| ListAITaskEvents | ListAITaskEvents | Queries the events of an AI task. |
Stack operations
|
API |
Title |
Description |
| CreateStack | CreateStack | Creates a stack from a ROS template to deploy a group of resources. |
| DeleteStack | DeleteStack | Deletes a stack, optionally retaining resources. |
| UpdateStack | Update a stack | Updates the resource information of a created stack. |
| ContinueCreateStack | ContinueCreateStack | Continues to create a stack after the stack fails to be created. |
| ListStacks | Query stack list | Queries the 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. |
| ListStackEvents | Query events of a stack and its resources | Queries events of a stack and the resources in 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 | Query resources in a stack | Queries the resources in a specified stack. |
| GetStackResource | Query a resource in a stack | Query a resource in a specific stack. |
Resource scenario operations
|
API |
Title |
Description |
| CreateTemplateScratch | CreateTemplateScratch | Creates templatescratch: scenario. |
| DeleteTemplateScratch | DeleteTemplateScratch | Deletes a scenario. |
| UpdateTemplateScratch | UpdateTemplateScratch | Updates a scenario. |
| ListTemplateScratches | Query resource scenarios | Queries a list of resource scenarios. |
| GetTemplateScratch | Get resource scenario details | Retrieves the details of a resource scenario. |
| GenerateTemplateByScratch | GenerateTemplateByScratch | Generates a template for a resource scenario. |
Template operations
|
API |
Title |
Description |
| 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 | Generate policy information required by a template | Generates the policy information required by a specified template. |
Stack policy operations
|
API |
Title |
Description |
| SetStackPolicy | SetStackPolicy | Configures a stack policy for a stack. |
| GetStackPolicy | GetStackPolicy | Queries the stack policy of a specified stack. |
Change set operations
|
API |
Title |
Description |
| CreateChangeSet | CreateChangeSet | Creates a change set for a stack so you can preview changes before execution. |
| DeleteChangeSet | DeleteChangeSet | Deletes change sets. |
| GetChangeSet | GetChangeSet | Returns details for a specified change set, optionally including the details of its associated template. |
| ListChangeSets | Query change sets | Queries the details of created change sets. |
| ExecuteChangeSet | ExecuteChangeSet | Executes change sets. |
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. |
| DeleteStackGroup | DeleteStackGroup | Deletes a stack group. |
| 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. |
| DeleteStackInstances | DeleteStackInstances | Deletes stack instances from specified accounts and regions. You can choose to retain the resources. |
| UpdateStackInstances | UpdateStackInstances | Updates stack instances for one or more accounts in specified 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. |
Diagnostic 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 type 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 | Query supported resource types | Queries the list of supported resource types. |
| GetResourceTypeTemplate | GetResourceTypeTemplate | Generates a sample template based on a resource type. |
| GetResourceType | Query details of a resource type | Queries the details of a resource type. |
| ListResourceTypeVersions | Query resource type versions | Queries the list of resource type versions, including resource types created by the user and those provided by Resource Orchestration Service (ROS). |
| ListResourceTypeRegistrations | Query resource registration records | Queries a list of resource registration records. |
Other operations
|
API |
Title |
Description |
| 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 the access status of a trusted service. |
| ListSummaries | ListSummaries | Queries for an overview. |
| CreateTemplate | CreateTemplate | Creates a custom template. |
| DeleteTemplate | DeleteTemplate | Deletes a template. |
| DescribeRegions | DescribeRegions | Queries a list of available regions. |
| GetStack | Query stack information | Queries stack information. |
| GetTemplate | GetTemplate | Queries the details of a template based on stacks, stack groups, change sets, or any custom template information. |
| ListTagKeys | ListTagKeys | Queries the tag keys for stacks or templates in a specified region. |
| 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. |
| ListTemplates | List Templates | Queries a list of private and shared templates. |
| MoveResourceGroup | MoveResourceGroup | Moves a resource to a specific resource group. |
| SetDeletionProtection | SetDeletionProtection | Modifies the deletion protection setting for a stack. |
| TagResources | TagResources | Creates and adds tags to resources. |
| UntagResources | UntagResources | Removes tags from resources and then deletes the tags. |
| UpdateTemplate | Update Template | Update Template |