# Alibaba Cloud Resource Orchestration Service API > Alibaba Cloud Resource Orchestration Service API on Apizie: 95 endpoints (Cancels operations on a stack, Cancels the update of a stack that is being created or updated and the operation is not yet complete, Continues to create a stack after the stack fails to be created, Create AI Task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-ros/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-ros` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/ros - Page: https://apizie.tech/api/cloud/aliyun-ros - OpenAPI: https://apizie.tech/api/cloud/aliyun-ros/openapi.json Alibaba Cloud OpenAPI for Resource Orchestration Service (ros, version 2019-09-10). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Cancels operations on a stack `POST https://apizie.tech/v1/cloud:aliyun-ros/cancel-stack-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | CancelType | string | no | The method that you want to use to cancel the operations. Valid values: Quick: cancels the operations on the stack at the earliest… | | AllowedStackOperations | string | no | The operations that you want to cancel on the stack (JSON-encoded) | ### Cancels the update of a stack that is being created or updated and the operation is not yet complete `POST https://apizie.tech/v1/cloud:aliyun-ros/cancel-update-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID. Before calling this operation, you can call GetStack to query the stack status and confirm that the update operation is not… | | RegionId | string | yes | The region ID of the stack. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | CancelType | string | no | The type of the cancel operation. Valid values: Quick: Cancels the stack update as soon as possible. Safe: Cancels the stack update as… | ### Continues to create a stack after the stack fails to be created `POST https://apizie.tech/v1/cloud:aliyun-ros/continue-create-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | RamRoleName | string | no | The name of the RAM role. Resource Orchestration Service (ROS) assumes the RAM role to create the stack and uses the credentials of the… | | Mode | string | no | The mode in which ROS continues to create the stack. Valid values: Recreate (default) If you set this parameter to Recreate, ROS continues… | | TemplateBody | string | no | The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | DryRun | string | no | Specifies whether only to validate the stack in the request. Valid values: true: only validates the stack. false (default): validates and… | | TemplateId | string | no | The template ID. This parameter applies to shared and private templates. This parameter takes effect when `Mode` is set to `Recreate`.… | | TemplateVersion | string | no | The version of the template. This parameter takes effect only when TemplateId is specified | | RecreatingResources | string | no | The resources that ROS continues to create after the resources failed to be created. You can add new resources to the resources that ROS… | | Parameters | string | no | The template parameters that you want to use to override specific parameters (JSON-encoded) | | Parallelism | integer | no | The maximum number of concurrent operations that can be performed on resources. By default, this parameter is empty. You can set this… | | RecreatingOptions | string | no | The options that ROS adopts when ROS continues to create the stack (JSON-encoded) | ### Create AI Task `POST https://apizie.tech/v1/cloud:aliyun-ros/create-aitask` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TaskType | string | no | The type of AI task. Values: GenerateTemplate: AI template generation FixTemplate: AI template repair | | Prompt | string | no | The input description for the AI task. When the task type is Generate Template, this parameter specifies the functionality of the template… | | Template | string | no | When the task type is AI template repair, specify the original template that needs to be fixed or modified | | TemplateType | string | no | The type of the template to be generated or repaired. Default is ROS | ### Creates a change set for a stack so you can preview changes before execution `POST https://apizie.tech/v1/cloud:aliyun-ros/create-change-set` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | no | The stack ID. ROS compares the stack information with the submitted changes, such as a modified template or different parameter values, to… | | StackPolicyURL | string | no | The URL of the stack policy file. The URL must point to a policy on a web server (HTTP or HTTPS) or in an OSS bucket, such as… | | StackPolicyBody | string | no | The structure of the stack policy. The policy body must be 1 to 16,384 bytes in length. When ChangeSetType is set to CREATE, you can… | | StackName | string | no | The stack name. Maximum length: 255 characters. The name can contain digits, letters, hyphens (-), and underscores (_), and must start… | | UsePreviousParameters | string | no | Specifies whether to use the values of parameters that were last used. Valid values: true false (default) This parameter takes effect only… | | ChangeSetType | string | no | The type of the change set. Valid values: CREATE: creates a change set for a new stack. UPDATE (default): creates a change set for an… | | Description | string | no | The description of the change set. The description can be up to 1,024 bytes in length | | RegionId | string | yes | The region ID of the change set. Call https://help.aliyun.com/document_detail/131035.html to query available regions | | ClientToken | string | no | The client token used to ensure request idempotence. The token must be unique across requests and can be up to 64 characters in length,… | | TemplateURL | string | no | The URL of the template file. The URL must point to a template on a web server (HTTP or HTTPS) or in an OSS bucket, such as… | | StackPolicyDuringUpdateURL | string | no | The URL of the temporary overriding stack policy file. The URL must point to a policy on a web server (HTTP or HTTPS) or in an OSS bucket,… | | TemplateBody | string | no | The template body. Length: 1 to 524,288 bytes. For large templates, use HTTP POST with a body parameter to avoid URL length limits. You… | | TimeoutInMinutes | integer | no | The timeout period before the stack enters CREATE_FAILED or UPDATE_FAILED state. Required when ChangeSetType is CREATE. Optional when… | | DisableRollback | string | no | Specifies whether to disable rollback on stack creation failure. Valid values: true: disables rollback on creation failure. false… | | ChangeSetName | string | yes | The change set name. Maximum length: 255 characters. The name can contain digits, letters, hyphens (-), and underscores (_), and must… | | StackPolicyDuringUpdateBody | string | no | The temporary overriding stack policy body. Length: 1 to 16,384 bytes. To update protected resources, specify a temporary overriding… | | RamRoleName | string | no | The RAM role name. ROS assumes this role to call Alibaba Cloud service APIs and always uses it for all stack operations. If you lack the… | | ReplacementOption | string | no | Specifies whether to enable replacement update when a resource property change does not support modification updates. A replacement update… | | TemplateId | string | no | The template ID. This parameter applies to shared templates and private templates. Call… | | TemplateVersion | string | no | The version of the template. This parameter takes effect only when TemplateId is specified | | Parameters | string | no | The parameters that are defined in the template (JSON-encoded) | | NotificationURLs | string | no | The list of webhook addresses for receiving stack event notifications (JSON-encoded) | | ResourcesToImport | string | no | The list of resources to be imported (JSON-encoded) | | TemplateScratchId | string | no | The resource scenario ID, which is the resource management scenario ID. This parameter takes effect only when ChangeSetType is set to… | | Parallelism | integer | no | The maximum number of concurrent resource operations. By default, this value is empty. Once set, the value is associated with the stack… | | Tags | string | no | The tags of the change set (JSON-encoded) | | ResourceGroupId | string | no | The resource group ID. If unspecified, the stack is added to the default resource group. https://help.aliyun.com/document_detail/94475.html | | TaintResources | string | no | The list of resources to be marked as dirty (JSON-encoded) | ### Creates a diagnostic task to perform a one-click diagnosis `POST https://apizie.tech/v1/cloud:aliyun-ros/create-diagnostic` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | DiagnosticKey | string | yes | The diagnostic keyword. You can enter the ID of the stack to be diagnosed | | Product | string | no | The name of the diagnostic product | | DiagnosticType | string | no | The diagnostic type. Valid values: Stack: diagnoses a stack | | Lang | string | no | The language of the generated diagnostic report. Currently, only Chinese and English are supported | ### Creates a stack from a ROS template to deploy a group of resources `POST https://apizie.tech/v1/cloud:aliyun-ros/create-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | DisableRollback | string | no | Specifies whether to disable rollback when stack creation fails. Valid values: true: disables rollback. false (default): enables rollback | | TemplateBody | string | no | The template body. Length: 1 to 524,288 bytes. Use HTTP POST with Body parameters for large content to avoid URL length limits. You must… | | StackPolicyURL | string | no | The URL of the stack policy file. Supports HTTP, HTTPS, and OSS URLs (for example, oss\://ros/stack-policy/demo or… | | TimeoutInMinutes | integer | no | The stack creation timeout. Unit: minutes. Default value: 60. Valid values: 10 to 1440 | | StackPolicyBody | string | no | The stack policy body. Length: 1 to 16,384 bytes. You can specify only one of the following parameters: StackPolicyBody or StackPolicyURL | | StackName | string | yes | The stack name. Maximum length: 255 characters. Must start with a letter and can contain letters, digits, hyphens (-), and underscores (_) | | RegionId | string | yes | The region ID of the stack. Call https://help.aliyun.com/document_detail/131035.html to query available regions | | ClientToken | string | no | Ensures request idempotency. Must be client-generated and globally unique. Maximum length: 64 characters. Can contain letters,… | | TemplateURL | string | no | The URL of the template file. Supports HTTP, HTTPS, and OSS URLs (for example, oss\://ros/stack-policy/demo or… | | RamRoleName | string | no | The RAM role name. ROS assumes this role for all stack API calls, even when the user has direct permissions, ensuring least-privilege… | | DeletionProtection | string | no | Specifies whether to enable deletion protection on the stack. Valid values: Enabled: enables deletion protection. Disabled (default):… | | CreateOption | string | no | The post-creation behavior for the stack. Valid values: KeepStackOnCreationComplete (default): retains the stack and resources after… | | CreateOptions | string | no | The creation options for the stack (JSON-encoded) | | TemplateId | string | no | The template ID. This parameter applies to shared and private templates. You must specify only one of the following parameters:… | | TemplateVersion | string | no | The version of the template. This parameter takes effect only when you specify TemplateId | | Parameters | string | no | The parameters that are defined in the template (JSON-encoded) | | NotificationURLs | string | no | The callback URL for stack events. Valid values: HTTP POST URL. Maximum length: 1,024 bytes. EventBridge receives stack status change… | | Tags | string | no | The tags of the stack (JSON-encoded) | | ResourceGroupId | string | no | The ID of the resource group. If not specified, the stack is added to the default resource group.… | | Parallelism | integer | no | The maximum number of concurrent operations on resources. Default: empty. Accepts integers greater than or equal to 0. If greater than 0,… | | TemplateScratchId | string | no | The ID of the resource scenario. Call https://help.aliyun.com/document_detail/363050.html to query resource scenario IDs. You must specify… | | TemplateScratchRegionId | string | no | The region ID of the resource scenario. Default value: the value of RegionId. Call https://help.aliyun.com/document_detail/131035.html to… | ### Creates a stack group from an ROS template to create stacks across multiple Alibaba Cloud accounts and regions `POST https://apizie.tech/v1/cloud:aliyun-ros/create-stack-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. Call https://help.aliyun.com/document_detail/131035.html to query available regions | | StackGroupName | string | yes | The stack group name. Must be unique within a region. 1 to 255 characters. Can contain letters, digits, hyphens (-), and underscores (_).… | | Description | string | no | The stack group description. 1 to 256 characters | | TemplateBody | string | no | The template body. 1 to 524,288 bytes. For large templates, pass the body in the HTTP POST request body to avoid URL length limits.… | | TemplateURL | string | no | The URL of the template file. Supports HTTP, HTTPS, and OSS URLs. 1 to 524,288 bytes. Examples: oss\://ros/template/demo,… | | ClientToken | string | no | The client token for idempotency. Must be unique across requests. Can contain letters, digits, underscores (_), and hyphens (-), up to 64… | | AdministrationRoleName | string | no | The RAM role for the administrator account in a self-managed stack group. ROS assumes this role to perform operations. Default:… | | ExecutionRoleName | string | no | The RAM role for the execution account in a self-managed stack group. The administrator role assumes this role to perform stack… | | TemplateId | string | no | The template ID. Applies to shared and private templates. Specify exactly one of TemplateBody, TemplateURL, and TemplateId | | TemplateVersion | string | no | The template version. Defaults to the latest version. TemplateVersion takes effect only if you specify TemplateId | | Parameters | string | no | The parameters of the stack group (JSON-encoded) | | ResourceGroupId | string | no | The resource group ID. Defaults to the default resource group. https://help.aliyun.com/document_detail/94475.html | | PermissionModel | string | no | The permission model of the stack group. Valid values: SELF_MANAGED (default): Create RAM roles for the administrator and execution… | | Tags | string | no | The tags of the stack group (JSON-encoded) | | AutoDeployment | string | no | The automatic deployment settings. You must specify this parameter if PermissionModel is set to SERVICE_MANAGED (JSON-encoded) | | Capabilities | string | no | The options for the stack group. Maximum: one option (JSON-encoded) | | StackArn | string | no | The stack ARN in the format acs:ros:${RegionId}:${AccountId}:stack/${StackId}. The stack group uses the template and parameters of this… | ### Creates stack instances for one or more accounts in specified regions `POST https://apizie.tech/v1/cloud:aliyun-ros/create-stack-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length and must start with a… | | AccountIds | string | no | The list of execution account IDs for deploying stacks with self-managed permissions. You can add up to 50 execution account IDs. You must… | | RegionIds | string | yes | The list of target regions. You can add up to 20 regions (JSON-encoded) | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | OperationDescription | string | no | The description of the operation to create stacks. The description must be 1 to 256 characters in length | | OperationPreferences | string | no | The operation settings for creating stacks. The following parameters are included: {"FailureToleranceCount": N} The failure tolerance… | | TimeoutInMinutes | integer | no | The timeout period for creating stacks. Default value: 60. Unit: minutes | | DisableRollback | string | no | Specifies whether to disable rollback when stack creation fails. Valid values: true: disables rollback. No rollback is performed when… | | ParameterOverrides | string | no | The list of parameters to override (JSON-encoded) | | DeploymentTargets | string | no | The deployment targets for deploying stacks with service-managed permissions. You must specify one and only one of `AccountIds` and… | | DeploymentOptions | string | no | The list of deployment options for deploying stacks with service-managed permissions. You can specify up to one deployment option… | ### Creates a custom template `POST https://apizie.tech/v1/cloud:aliyun-ros/create-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on a web server (HTTP or HTTPS) or… | | Description | string | no | The description of the template. The description can be up to 256 characters in length | | TemplateBody | string | no | The structure of the template body. The template body must be 1 to 524,288 bytes in length. If the template body is large, specify the… | | TemplateName | string | yes | The name of the template. The name can be up to 255 characters in length. It must start with a digit, letter, or Chinese character. It can… | | ResourceGroupId | string | no | The ID of the resource group. For more information about resource groups, see https://help.aliyun.com/document_detail/94475.html | | Tags | string | no | The tags of the template (JSON-encoded) | | ValidationOptions | string | no | The validation options. By default, no options are enabled and strict validation is performed (JSON-encoded) | ### Creates templatescratch: scenario `POST https://apizie.tech/v1/cloud:aliyun-ros/create-template-scratch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the resource scenario. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region… | | TemplateScratchType | string | yes | The type of the resource scenario. Valid values: ArchitectureReplication: resource replication ArchitectureDetection: resource profiling… | | Description | string | no | The description of the resource scenario | | SourceResources | string | no | The source resources. When you set TemplateScratchType to ArchitectureDetection, you can specify SourceResources to detect the… | | SourceTag | string | no | The source tags (JSON-encoded) | | SourceResourceGroup | string | no | The source resource group (JSON-encoded) | | PreferenceParameters | string | no | Configuration parameters for resource scenario (JSON-encoded) | | LogicalIdStrategy | string | no | Logical ID generation strategy. Valid values: LongTypePrefixAndIndexSuffix: long-type prefix + index-type suffix… | | ClientToken | string | no | Ensures the idempotency of the request. This value must be generated by the client and must be globally unique. It must be no more than 64… | | ExecutionMode | string | no | The execution mode. Valid values: Async (default): asynchronous mode Sync: synchronous mode If the resource scope is large, the… | | Tags | string | no | The tags of the resource scenario (JSON-encoded) | | ResourceGroupId | string | no | The ID of the resource group to which you want to assign the snapshot policy. If you leave this parameter empty, the resource scenario is… | ### Deletes change sets `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-change-set` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the change set. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | ChangeSetId | string | yes | The ID of the change set | ### Deletes a diagnostic record `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-diagnostic` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ReportId | string | no | The report ID. You can troubleshoot issues based on the report | ### Deletes a stack, optionally retaining resources `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | RetainAllResources | string | no | Whether to retain all resources in the stack. Valid values: true false (default) | | RegionId | string | yes | The region ID of the stack. Call https://help.aliyun.com/document_detail/131035.html to query available regions | | RamRoleName | string | no | The RAM role name. ROS assumes this role to create the stack and call Alibaba Cloud service APIs. Even if you have stack operation… | | RetainResources | string | no | Resources to retain (JSON-encoded) | | DeleteOptions | string | no | Stack deletion options (JSON-encoded) | | Parallelism | integer | no | Maximum number of concurrent resource operations. Default: empty. Accepts an integer >= 0. A value greater than 0 is used as-is. A value… | ### Deletes a stack group `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-stack-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The ID of the region to which the stack group belongs. You can call the https://help.aliyun.com/document_detail/131035.html operation to… | | StackGroupName | string | yes | The name of the stack group. The name must be unique in a region. The name can be up to 255 characters in length and can contain digits,… | ### Deletes stack instances from specified accounts and regions. You can choose to retain the resources `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-stack-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. Call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent list of… | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters long. It must start with a… | | AccountIds | string | no | The IDs of the accounts from which to delete stack instances. This parameter applies only to stack groups that use self-managed… | | RegionIds | string | yes | The IDs of the regions where the stack instances are deployed. You can specify up to 20 region IDs (JSON-encoded) | | RetainStacks | string | yes | Specifies whether to retain the stacks. Valid values: true: The stacks are retained. false: The stacks are deleted | | ClientToken | string | no | A client token that is used to ensure the idempotence of the request. You can use your client to generate the token, but you must make… | | OperationDescription | string | no | The description of the operation to delete stack instances. The description can be 1 to 256 characters long | | OperationPreferences | string | no | The preferences for the operation to delete stack instances. This parameter contains the following subparameters:… | | DeploymentTargets | string | no | The deployment targets from which to delete stack instances. This parameter applies only to stack groups that use service-managed… | ### Deletes a template `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateId | string | yes | The template ID. Applies to private templates only | ### Deletes a scenario `POST https://apizie.tech/v1/cloud:aliyun-ros/delete-template-scratch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the scenario. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | TemplateScratchId | string | yes | The ID of the scenario | ### Deletes a resource type or a specific version of a resource type `POST https://apizie.tech/v1/cloud:aliyun-ros/deregister-resource-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ResourceType | string | yes | The resource type | | VersionId | string | no | The version ID. Specify this parameter to delete a specific version of the resource type | ### Queries a list of available regions `POST https://apizie.tech/v1/cloud:aliyun-ros/describe-regions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | AcceptLanguage | string | no | The language in which you want to display the results. Valid values: zh-CN (default): Chinese en-US: English ja: Japanese | ### Performs drift detection on resources in a stack to check whether the resources have drifted from the… `POST https://apizie.tech/v1/cloud:aliyun-ros/detect-stack-drift` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… | | LogicalResourceId | string | no | The logical ID of resource (JSON-encoded) | ### Performs drift detection on stack groups to check whether the stack groups have drifted from the expected… `POST https://apizie.tech/v1/cloud:aliyun-ros/detect-stack-group-drift` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… | | RegionId | string | yes | The region ID of the stack group. You can call the [DescribeRegions](~~131035#doc-api-ROS-DescribeRegions~~ "Queries the DescribeRegions… | | StackGroupName | string | yes | The name of the stack group. The name must be unique in a region. The name can be up to 255 characters in length and can contain digits,… | | OperationPreferences | string | no | The operation settings, in JSON format. The following fields are supported: FailureToleranceCount The maximum number of stack group… | ### Performs drift detection on a resource to determine whether the resource has drifted from its expected… `POST https://apizie.tech/v1/cloud:aliyun-ros/detect-stack-resource-drift` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be globally unique.… | | RegionId | string | yes | The region ID of the stack. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | LogicalResourceId | string | yes | The resource name | ### Enables trusted service access `POST https://apizie.tech/v1/cloud:aliyun-ros/enable-service-access` (byok) ### Enables services in a batch `POST https://apizie.tech/v1/cloud:aliyun-ros/enable-services` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ServiceNames | string | no | A list of services to enable (JSON-encoded) | | RegionId | string | yes | The region where the service is enabled | ### Executes change sets `POST https://apizie.tech/v1/cloud:aliyun-ros/execute-change-set` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the change set. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | ChangeSetId | string | yes | The ID of the change set | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | ### Generates a template for a resource scenario `POST https://apizie.tech/v1/cloud:aliyun-ros/generate-template-by-scratch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the resource scenario. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most… | | TemplateScratchId | string | yes | The ID of the resource scenario. For more information about how to query the IDs of resource scenarios, see… | | ProvisionRegionId | string | no | The region ID of the new node | | TemplateType | string | no | The type of the template that Resource Orchestration Service (ROS) generates. ROS can generate templates of the ROS and Terraform types.… | ### Generates the policy information required by a specified template `POST https://apizie.tech/v1/cloud:aliyun-ros/generate-template-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template located on a web server (HTTP or HTTPS) or in an OSS… | | TemplateBody | string | no | The structure of the template body. The length is 1 to 524,288 bytes. If the length is large, we recommend that you use HTTP POST with the… | | TemplateId | string | no | The template ID. Shared templates and private templates are supported. You can specify only one of the following parameters: TemplateBody,… | | TemplateVersion | string | no | The template version. This parameter takes effect only when TemplateId is specified | | OperationTypes | string | no | The operation types for which policy information is generated (JSON-encoded) | | Parameters | string | no | The input parameters. The input parameters define the parameters that must be specified when you create a stack by using this template.… | | GenerateOptions | string | no | GenerateOptions controls how the template access policy is generated. This parameter is of the list type and allows you to specify whether… | ### Queries the information about an AI task by task ID `POST https://apizie.tech/v1/cloud:aliyun-ros/get-aitask` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TaskId | string | no | The ID of the AI task | | OutputOption | string | no | Specifies whether to return the TaskOutput parameter. The TaskOutput parameter specifies the outputs of the AI task. Valid values: Enabled… | ### Queries the information of a specified change set. You can choose whether to retrieve the corresponding… `POST https://apizie.tech/v1/cloud:aliyun-ros/get-change-set` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ShowTemplate | string | no | Specifies whether to retrieve the template. Valid values: true: Retrieves the template. false (default): Does not retrieve the template | | RegionId | string | yes | The region ID of the change set. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | ChangeSetId | string | yes | The change set ID | ### Retrieves the details of a diagnostic report by specifying the diagnostic report ID `POST https://apizie.tech/v1/cloud:aliyun-ros/get-diagnostic` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ReportId | string | no | The diagnostic report ID | ### Queries the details of features that are supported by Resource Orchestration Service (ROS) `POST https://apizie.tech/v1/cloud:aliyun-ros/get-feature-details` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Feature | string | yes | The one or more features that you want to query. Valid values: Terraform: the Terraform hosting feature. ResourceCleaner: the resource… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | ### Queries the details of a resource type `POST https://apizie.tech/v1/cloud:aliyun-ros/get-resource-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ResourceType | string | yes | The resource type. For more information about the resource types supported by ROS, see https://help.aliyun.com/document_detail/127039.html | | VersionId | string | no | The version ID. To query a specific version of the resource type, specify this parameter. Otherwise, the resource type is queried. Only… | ### Generates a sample template based on a resource type `POST https://apizie.tech/v1/cloud:aliyun-ros/get-resource-type-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ResourceType | string | yes | The type of the resource. Call the https://help.aliyun.com/document_detail/133957.html operation to query supported resource types | | VersionId | string | no | The version ID. Specify this parameter to query a specific version of the resource type. If you do not specify this parameter, the default… | ### Queries the access status of a trusted service `POST https://apizie.tech/v1/cloud:aliyun-ros/get-service-access` (byok) ### Queries the activation status of an Alibaba Cloud service and information about its service-linked roles `POST https://apizie.tech/v1/cloud:aliyun-ros/get-service-provisions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region list | | TemplateBody | string | no | The structure of the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body exceeds the… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | TemplateId | string | no | The template ID. This parameter applies to shared and private templates. You can specify only one of the TemplateBody, TemplateURL,… | | TemplateVersion | string | no | The version of the template. If you do not specify this parameter, the latest version is used. This parameter takes effect only when you… | | Parameters | string | no | The parameters (JSON-encoded) | | Services | string | no | The list of Alibaba Cloud services (JSON-encoded) | ### Queries stack information `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | RegionId | string | yes | The region ID of the stack. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be globally unique.… | | OutputOption | string | no | Specifies whether to return the Outputs parameter (the list of stack Outputs). Valid values: Enabled (default): Returns the Outputs… | | ShowResourceProgress | string | no | Specifies whether to return the ResourceProgress parameter (resource processing progress). Valid values: Disabled (default): Does not… | | LogOption | string | no | The log option. Valid values: None: Does not return logs. Stack (default): Returns stack-related logs. Resource: Returns resource-related… | ### Queries the drift detection status based on the drift detection ID in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack-drift-detection-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack associated with the drift detection. You can call the https://help.aliyun.com/document_detail/131035.html… | | DriftDetectionId | string | yes | The drift detection ID. You can call the https://help.aliyun.com/document_detail/610877.html operation to obtain the drift detection ID | ### Queries the details of a stack group by name in a region `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | StackGroupName | string | no | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length, and must start with… | | StackGroupId | string | no | The ID of the stack group. You must specify only one of the StackGroupName and StackGroupId parameters | ### Queries the details of a specified stack group operation in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack-group-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | OperationId | string | yes | The operation ID. You can call the https://help.aliyun.com/document_detail/151342.html operation to obtain the operation ID | ### Queries the details of stack instances associated with a specified stack group `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack-instance` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length, and must start with… | | StackInstanceAccountId | string | yes | The ID of the execution account to which the stack belongs. In the self-managed permissions pattern, this account is an Alibaba Cloud… | | StackInstanceRegionId | string | yes | The region to which the stack belongs | | OutputOption | string | no | Specifies whether to return the Outputs parameter (the list of stack outputs). Valid values: Enabled: returns the Outputs parameter.… | ### Queries the stack policy of a specified stack `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | RegionId | string | yes | The region ID of the stack. Call https://help.aliyun.com/document_detail/131035.html to query available regions | ### Queries a resource in a stack `POST https://apizie.tech/v1/cloud:aliyun-ros/get-stack-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | ClientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be globally unique. The value can be up to 64… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | ShowResourceAttributes | string | no | Specifies whether to query resource attributes. Valid values: true: Queries resource attributes. false: Does not query resource attributes | | LogicalResourceId | string | yes | The logical ID of the resource, which is the name of the resource in the template | | ResourceAttributes | string | no | Specifies the list of resource output attributes to query. The maximum value of N is 20 (JSON-encoded) | ### Queries the details of a template by specifying a stack, a stack group, a change set, or a custom template `POST https://apizie.tech/v1/cloud:aliyun-ros/get-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | no | The ID of the stack. You must specify only one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId | | RegionId | string | no | The region ID of the stack or stack group to which the template belongs. You can call the… | | ChangeSetId | string | no | The ID of the change set. You must specify only one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId | | TemplateId | string | no | The ID of the template. Both shared and private templates are supported. For a shared template, the TemplateId is the same as the… | | TemplateVersion | string | no | The version of the template. This parameter takes effect only when TemplateId is specified. For a shared template, this parameter is… | | TemplateStage | string | no | The stage of the template. This parameter takes effect only when StackId, ChangeSetId, or StackGroupName is specified. Valid values:… | | IncludePermission | string | no | Specifies whether to query the sharing information of the template. Valid values: Enabled: queries the sharing information. Disabled: does… | | StackGroupName | string | no | The name of the stack group. You must specify only one of the following parameters: StackId, ChangeSetId, StackGroupName, and TemplateId | | IncludeTags | string | no | Specifies whether to query the tag information. Valid values: Enabled: queries the tag information. Disabled: does not query the tag… | ### Queries the estimated prices of the resources in a template `POST https://apizie.tech/v1/cloud:aliyun-ros/get-template-estimate-cost` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateURL | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | RegionId | string | yes | The ID of the template. This parameter applies to shared and private templates. You must specify only one of the following parameters:… | | TemplateBody | string | no | The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body… | | ClientToken | string | no | The name of parameter N. If you do not specify the name and value of a parameter, ROS uses the default name and value that are specified… | | TemplateId | string | no | The value of parameter N. Maximum value of N: 200. Examples: Parameters.1.ParameterValue: `DemoEip` Parameters.2.ParameterValue: `public`… | | TemplateVersion | string | no | The ID of the scenario. For more information about how to query the IDs of scenarios, see… | | Parameters | string | no | The region ID of the scenario. The default value is the same as the value of the RegionId parameter. You can call the… | | TemplateScratchId | string | no | The ID of the scenario | | TemplateScratchRegionId | string | no | The region ID of the scenario. The default value is the same as the value of the RegionId parameter. You can call the… | | StackId | string | no | The stack ID. This parameter is used to query the estimated price in a configuration change scenario. Assume that the specified stack… | ### Queries the valid values of the parameters in a template `POST https://apizie.tech/v1/cloud:aliyun-ros/get-template-parameter-constraints` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateBody | string | no | The structure of the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body exceeds the… | | RegionId | string | yes | The region ID. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region list | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | TemplateId | string | no | The ID of the template. This parameter applies to shared templates and private templates. You can specify only one of the TemplateBody,… | | TemplateVersion | string | no | The version of the template. If you do not specify this parameter, the latest version is used. TemplateVersion is valid only when… | | Parameters | string | no | The parameters that are defined in the template (JSON-encoded) | | ParametersKeyFilter | string | no | The list of parameters to be queried (JSON-encoded) | | ClientToken | string | no | A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure… | | ParametersOrder | string | no | The dependency of the parameters (JSON-encoded) | | StackId | string | no | The ID of the stack. If you specify this parameter, the parameter constraints for an upgrade or downgrade scenario are queried | ### Retrieves the details of a resource scenario `POST https://apizie.tech/v1/cloud:aliyun-ros/get-template-scratch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the resource scenario. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region… | | TemplateScratchId | string | no | The ID of the resource scenario | | ShowDataOption | string | no | The data display option. Valid values: Sources: displays only source node data. This value is applicable when TemplateScratchType is set… | ### Queries the information about a template resource by using the relevant template, stack, stack group, or… `POST https://apizie.tech/v1/cloud:aliyun-ros/get-template-summary` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | no | The stack ID. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId, ChangeSetId, and… | | TemplateBody | string | no | The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body… | | RegionId | string | no | The region ID of the stack or stack group that uses the template. You can call the https://help.aliyun.com/document_detail/131035.html… | | TemplateId | string | no | The template ID. This parameter applies to shared and private templates. You can specify only one of the following parameters:… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | ChangeSetId | string | no | The ID of the change set. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId,… | | TemplateVersion | string | no | The version of the template. This parameter takes effect when TemplateId is specified | | StackGroupName | string | no | The name of the stack group. You can specify only one of the following parameters: TemplateBody, TemplateURL, TemplateId, StackId,… | | Parameters | string | no | The parameters that are defined in the template (JSON-encoded) | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | ### Import stacks from multiple different accounts into a stack group `POST https://apizie.tech/v1/cloud:aliyun-ros/import-stacks-to-stack-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call https://help.aliyun.com/document_detail/131035.html to view the latest list of Alibaba… | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a single region. It cannot exceed 255 characters and must start with a letter… | | StackArns | string | yes | A list of ARNs for the stacks to be imported into the stack group, in the format `acs:ros:${RegionId}:${AccountId}:stack/${StackId}`. A… | | ResourceDirectoryFolderIds | string | no | A list of resource directory folder IDs for the stacks to be imported. A maximum of 10 folders can be added (JSON-encoded) | | ClientToken | string | no | Ensures the idempotence of the request. This value is generated by the client and must be globally unique. It cannot exceed 64 characters… | | OperationDescription | string | no | Description of the operation | | OperationPreferences | string | no | Operation settings for importing stacks into the stack group. Includes the following parameters: {"FailureToleranceCount": N} Failure… | ### Queries the events of an AI task `POST https://apizie.tech/v1/cloud:aliyun-ros/list-aitask-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… | | MaxResults | string | no | The maximum number of results to be returned from a single query when the NextToken parameter is used in the query. Valid values: 1 to… | | TaskId | string | no | The ID of the AI task | ### Queries a list of AI tasks `POST https://apizie.tech/v1/cloud:aliyun-ros/list-aitasks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… | | MaxResults | integer | no | The maximum number of data entries to return | | TaskType | string | no | The type of the AI task. You can filter AI tasks by task type. GenerateTemplate: The AI task is used to generate a template. FixTemplate:… | | TaskId | string | no | The ID of the AI task. You can filter AI tasks by task ID | ### Queries the details of created change sets `POST https://apizie.tech/v1/cloud:aliyun-ros/list-change-sets` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | PageSize | integer | no | The number of entries per page in paging query. The value must be an integer. Valid values: 1 to 50. Default value: 10 | | RegionId | string | yes | The region ID of the change set. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | PageNumber | integer | no | The page number of the change set list. Minimum value: 1. Default value: 1 | | ChangeSetId | string | no | The change set ID. If you do not need detailed information about the change set, you can use this parameter instead of calling the… | | Status | string | no | The status of the change set. Maximum value of N: 5. Valid values: CREATE_PENDING CREATE_IN_PROGRESS CREATE_COMPLETE CREATE_FAILED… | | ChangeSetName | string | no | The name of the change set. Maximum value of N: 5. You can use the wildcard character asterisk (*) for fuzzy match (JSON-encoded) | | ExecutionStatus | string | no | The execution status of the change set. Maximum value of N: 5. Valid values: UNAVAILABLE AVAILABLE EXECUTE_IN_PROGRESS EXECUTE_COMPLETE… | ### Retrieves the message history and temporary download URLs for the pipeline snapshot of a specified session… `POST https://apizie.tech/v1/cloud:aliyun-ros/list-chat-messages` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SessionId | string | yes | The ID of the session to query. You can only query sessions owned by the current user. You can call ListChatSessions to obtain an existing… | | MaxResults | integer | no | The compatibility field. V2 does not return message arrays by page, and the service does not consume this field | | NextToken | string | no | The compatibility field. V2 does not return message arrays by page, and the service does not consume this field | | AgentVersion | string | no | Set this parameter to V2 to route the request to the ROS Agent V2 backend | ### Queries the ROS Agent V2 sessions of the current user by paging `POST https://apizie.tech/v1/cloud:aliyun-ros/list-chat-sessions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | MaxResults | integer | no | The number of sessions to return per page. Valid values: 1 to 100. Default value: 20 | | NextToken | string | no | The pagination token returned in the previous response. Do not specify this parameter for the first request. Do not reuse the old token… | | AgentVersion | string | no | Routes the request to the ROS Agent V2 backend when the value is set to V2 | | Mode | string | no | Filters sessions by mode. Valid values: IaCCodeNormal and IaCCodePipeline | ### Queries the list of diagnostics `POST https://apizie.tech/v1/cloud:aliyun-ros/list-diagnostics` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | DiagnosticKey | string | no | The diagnostic keyword | | DiagnosticProduct | string | no | The diagnostic product | | Status | string | no | The diagnostic status | | NextToken | string | no | The token used to start the next query | | MaxResults | string | no | The maximum number of results to return per query when NextToken is used. Valid values: 1 to 100. Default value: 50 | ### Queries a list of resource registration records `POST https://apizie.tech/v1/cloud:aliyun-ros/list-resource-type-registrations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | EntityType | string | no | The entity type. Valid values: Module | | ResourceType | string | no | The resource type. The value can contain uppercase and lowercase letters, digits, colons (:), and asterisks (*). If you use an asterisk,… | | RegistrationId | string | no | The registration ID | | Status | string | no | The registration status. Valid values: IN_PROGRESS: In progress. COMPLETE: Succeeded. FAILED: Failed | | PageNumber | integer | no | The page number for paging. Minimum value: 1. Default value: 1 | | PageSize | integer | no | The number of entries per page for paging. Valid values: 1 to 50. Default value: 10 | ### Queries the list of resource type versions, including resource types created by the user and those provided… `POST https://apizie.tech/v1/cloud:aliyun-ros/list-resource-type-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ResourceType | string | yes | The resource type | ### Queries the list of supported resource types `POST https://apizie.tech/v1/cloud:aliyun-ros/list-resource-types` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | EntityType | string | no | The entity type. Valid values: All: all resource types. Resource (default): regular resource types. For more information, see… | | Provider | string | no | The resource type provider. Valid values: ROS (default): Resource Orchestration Service. Self: the user | | ResourceType | string | no | The resource type. The value can contain uppercase and lowercase letters, digits, colons (:), and asterisks (*). If an asterisk is used,… | ### Queries events of a stack and the resources in the stack `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-events` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | PageSize | integer | no | The number of entries per page in a paged query. Settings for paging. Maximum value: 50. Default value: 10 | | RegionId | string | yes | The region ID of the stack. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | PageNumber | integer | no | The page number of the event list. Minimum value: 1. Default value: 1 | | Status | string | no | The resource status (JSON-encoded) | | ResourceType | string | no | The resource type list (JSON-encoded) | | LogicalResourceId | string | no | The logical resource ID (JSON-encoded) | ### Queries the results of an operation on a stack group `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-group-operation-results` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | OperationId | string | yes | The ID of the operation. You can call the https://help.aliyun.com/document_detail/151342.html operation to query the operation ID | | PageSize | integer | no | The number of entries to return on each page. Valid values: 1 to 50. Default value: 10 | | PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 | ### Queries the details of stack group operations in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-group-operations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length, and must start with… | | PageSize | integer | no | The paging Settings for the number of entries to return on each page in a paged query. Valid values: 1 to 50. Default value: 10 | | PageNumber | integer | no | The paging Settings for the page number in a paged query. Starting value: 1. Default value: 1 | ### Queries the details of stack groups in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-groups` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | Status | string | no | The status of the stack group. If you do not specify this parameter, stack groups in all states in the region are queried. Valid values:… | | PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Valid values: 1 to 50. Default value: 10 | | PageNumber | integer | no | The paging Settings for the page number in a paged query. Minimum value: 1. Default value: 1 | | ResourceGroupId | string | no | The resource group ID. If you do not specify this parameter, stack groups in all resource groups are queried. You can obtain the resource… | | Tags | string | no | The tags of the stack group (JSON-encoded) | ### Queries the details of the stack instances associated with a specified stack group in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length, and must start with… | | StackInstanceAccountId | string | no | The ID of the execution account to which the stack belongs. In the self-managed permissions pattern, the account is an Alibaba Cloud… | | StackInstanceRegionId | string | no | The region to which the stack belongs | | PageSize | integer | no | Settings for the number of entries per page during paging in a paged query. Valid values: 1 to 50. Default value: 10 | | PageNumber | integer | no | Settings for the page number during paging in a paged query. Starting value: 1. Default value: 1 | ### Detects stack-related operation risks and returns missing permissions and the causes of the risks `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-operation-risks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | StackId | string | no | The ID of the stack | | OperationType | string | no | The type of the operation of which you want to detect risks. Valid values: DeleteStack: detects high risks that may arise in resources… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | RamRoleName | string | no | The name of the RAM role. If you specify a RAM role, ROS creates stacks based on the permissions that are granted to the RAM role and uses… | | RetainAllResources | string | no | Specifies whether to retain all resources in the stack. Valid values: true false (default) This parameter takes effect only if you set… | | RetainResources | string | no | The list of resources to retain. This parameter takes effect only if you set OperationType to DeleteStack (JSON-encoded) | | TemplateBody | string | no | The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | TemplateId | string | no | The ID of the template. This parameter applies to shared and private templates. You must specify one of TemplateBody, TemplateURL,… | | TemplateVersion | string | no | The version of the template. This parameter takes effect only if you specify TemplateId | ### Queries the resource drift details of a stack in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-resource-drifts` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | RegionId | string | yes | The region ID of the stack. You can call https://help.aliyun.com/document_detail/131035.html to query the latest list of Alibaba Cloud… | | MaxResults | integer | no | The maximum number of results to return per call when you use the NextToken parameter for pagination. Valid values: 1 to 100. Default… | | NextToken | string | no | The pagination token. Set the value to the NextToken value returned from the previous API call | | ResourceDriftStatus | string | no | The resource drift status. Valid values: DELETED: The resource differs from its expected template configuration because the resource has… | ### Queries the resources of a specified stack `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stack-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | ### Queries the list of stacks `POST https://apizie.tech/v1/cloud:aliyun-ros/list-stacks` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | PageSize | integer | no | The Settings for paging, specifying the number of entries per page in a paged query. Maximum value: 50. Default value: 10 | | ParentStackId | string | no | The ID of the parent stack | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | PageNumber | integer | no | The page number of the stack list. Starting value: 1. Default value: 1 | | ShowNestedStack | string | no | Specifies whether to list nested stacks. Valid values: true false (default) If ParentStackId is specified, the value is set to true | | StackId | string | no | The ID of the stack. If you do not need the detailed information of the stack, you can specify this parameter instead of calling the… | | Status | string | no | The status of the stack (JSON-encoded) | | StackName | string | no | The name of the stack (JSON-encoded) | | Tag | string | no | The tags of the stack (JSON-encoded) | | ResourceGroupId | string | no | The ID of the resource group. For more information about resource groups, see https://help.aliyun.com/document_detail/94475.html | | StackIds | string | no | The list of stack IDs (JSON-encoded) | | StartTime | string | no | The start time of the creation time range for the query. Specify the time in the https://help.aliyun.com/document_detail/25696.html… | | EndTime | string | no | The end time of the creation time range for the query. Specify the time in the https://help.aliyun.com/document_detail/25696.html standard… | ### Queries for an overview `POST https://apizie.tech/v1/cloud:aliyun-ros/list-summaries` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Option | string | no | Output information options | ### Queries the tag keys for stacks or templates in a specified region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-tag-keys` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The ID of the region. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the latest list of Alibaba… | | ResourceType | string | yes | The resource type. Valid values: stack: stack. stackgroup: stack group. template: template. templatescratch: resource scenario | | NextToken | string | no | The token that is used to start the next query | ### Queries the tags that are added to resources in a template or stack in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the tag. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | ResourceType | string | yes | The type of the resource. Valid values: stack: stack stackgroup: stack group template: template templatescratch: scenario | | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results | | ResourceId | string | no | The IDs of the resources (JSON-encoded) | | Tag | string | no | The tags of the resources. You can specify up to 20 tags (JSON-encoded) | ### Queries the tag values that are added to resources in a template or stack in an Alibaba Cloud region `POST https://apizie.tech/v1/cloud:aliyun-ros/list-tag-values` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the tag value. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | ResourceType | string | yes | The type of the resource. Valid values: stack: stack stackgroup: stack group template: template templatescratch: scenario | | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results | | Key | string | yes | The key of the tag | ### Queries a list of resource scenarios `POST https://apizie.tech/v1/cloud:aliyun-ros/list-template-scratches` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the resource scenario. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region… | | TemplateScratchId | string | no | The ID of the resource scenario | | TemplateScratchType | string | no | The type of the resource scenario. Valid values: ArchitectureReplication: resource replication. ArchitectureDetection: resource detection.… | | Status | string | no | The status of the resource scenario. Valid values: GENERATE_IN_PROGRESS: being generated. GENERATE_COMPLETE: generated. GENERATE_FAILED:… | | Tags | string | no | The tags of the resource scenario (JSON-encoded) | | PageSize | integer | no | The number of entries per page in a paged query. Settings for paging. Maximum value: 50. Default value: 10 | | PageNumber | integer | no | The page number of the resource scenario list. Start value: 1. Default value: 1 | | ResourceGroupId | string | no | The resource group ID | ### Queries the list of versions of a template `POST https://apizie.tech/v1/cloud:aliyun-ros/list-template-versions` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… | | MaxResults | integer | no | The maximum number of results to be returned in a single call when NextToken is used for the query. Valid values: 1 to 100. Default value:… | | TemplateId | string | yes | The template ID. This parameter applies to shared and private templates | ### Queries the list of private and shared templates `POST https://apizie.tech/v1/cloud:aliyun-ros/list-templates` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | PageNumber | integer | no | The page number of the template list. Starting value: 1. Default value: 1 | | PageSize | integer | no | The paging Settings for the number of entries per page in a paged query. Valid values: 1 to 50. Default value: 10 | | TemplateName | string | no | The name of the template. This parameter takes effect only when ShareType is set to Private. The name can be up to 255 characters in… | | ShareType | string | no | The share type of the template. Valid values: Private (default): The template is owned by the user. Shared: The template is shared by… | | Tag | string | no | The tags. You can specify up to 20 tags (JSON-encoded) | | ResourceGroupId | string | no | The ID of the resource group. For more information about resource groups, see https://help.aliyun.com/document_detail/94475.html | | IncludeTags | string | no | Specifies whether to query tag information. Valid values: Enabled: Queries tag information. Disabled (default): Does not query tag… | | Filters | string | no | The filters (JSON-encoded) | ### Moves a resource to a specific resource group `POST https://apizie.tech/v1/cloud:aliyun-ros/move-resource-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ResourceType | string | yes | The type of the resource. Valid values: stack: stack stackgroup: stack group template: template | | ResourceId | string | yes | The ID of the resource | | NewResourceGroupId | string | yes | The ID of the resource group to which you want to move the resource. For more information about resource groups, see the "Resource Group"… | | RegionId | string | yes | The region ID of the resource. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | ### Previews the information about a stack that you want to create or update based on a template. You can call… `POST https://apizie.tech/v1/cloud:aliyun-ros/preview-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | DisableRollback | string | no | Specifies whether to disable rollback for the resources when the stack fails to be created. Valid values: true false (default) | | TimeoutInMinutes | integer | no | The timeout period for creating the stack. Unit: minutes. Default value: 60 | | TemplateBody | string | no | The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. If the length of the template body… | | StackPolicyURL | string | no | The URL of the file that contains the stack policy. The URL must point to a policy that is located on an HTTP or HTTPS web server or in an… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | StackPolicyBody | string | no | The structure that contains the stack policy body. The stack policy body must be 1 to 16,384 bytes in length. You can specify only one of… | | StackName | string | no | The stack name. You can use this parameter to preview the stack that you want to create. The name can be up to 255 characters in length,… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | TemplateId | string | no | The template ID. This parameter applies to shared and private templates. You must and can specify only one of the following parameters:… | | TemplateVersion | string | no | The version of the template. This parameter takes effect only when TemplateId is specified | | Parameters | string | no | The parameters of the stack (JSON-encoded) | | Parallelism | integer | no | The maximum number of concurrent operations that can be performed on resources. This parameter takes effect only for Terraform stacks. By… | | TemplateScratchId | string | no | The scenario ID. For more information about how to query the scenario ID, see https://help.aliyun.com/document_detail/363050.html. You… | | TemplateScratchRegionId | string | no | The region ID of the scenario. The default value is the same as the value of RegionId. You can call the… | | StackId | string | no | The stack ID. You can use this parameter to preview a stack that you want to update. You must and can specify only one of StackName and… | | EnablePreConfig | string | no | Specifies whether to query the parameters that you want to use in compliance precheck. Valid values: true false (default) | | TaintResources | string | no | The resources marked as tainted (JSON-encoded) | | UsePreviousParameters | string | no | Specifies whether to use the values of parameters that were last used. Valid values: true: The parameters that were last used are reused.… | ### Creates a new resource type, or creates a new version for an existing resource type `POST https://apizie.tech/v1/cloud:aliyun-ros/register-resource-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | EntityType | string | yes | The entity type. Set the value to Module | | ResourceType | string | yes | The resource type | | TemplateBody | string | no | The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. The template body is used as the… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | Description | string | no | The description of the resource type. The description can be up to 512 characters in length | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | ### Modifies the deletion protection setting for a stack `POST https://apizie.tech/v1/cloud:aliyun-ros/set-deletion-protection` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack. The delete protection attribute of a nested stack is determined by the root stack and remains unchanged from the root… | | DeletionProtection | string | yes | Indicates whether stack deletion protection is enabled. Valid values: Enabled: enables the stack deletion protection. Disabled (default):… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | ### Modifies the description of a resource type or a version of that type `POST https://apizie.tech/v1/cloud:aliyun-ros/set-resource-type` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ResourceType | string | yes | The resource type | | VersionId | string | no | The version ID. Specify this parameter to modify a specific version of the resource type. Otherwise, the description of the resource type… | | DefaultVersionId | string | no | The ID of the default version. Specify this parameter to set the default version for the resource type. You can specify either VersionId… | | Description | string | no | The description of the resource type or a version of the resource type. The description can be up to 512 characters in length | ### Configures a stack policy for a stack `POST https://apizie.tech/v1/cloud:aliyun-ros/set-stack-policy` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | StackPolicyBody | string | no | The structure that contains the stack policy body. The stack policy body must be 1 to 16,384 bytes in length. You can specify one of the… | | StackPolicyURL | string | no | The URL for the file that contains the stack policy. The URL must point to a template located in an HTTP or HTTPS web server or an Alibaba… | ### Shares or unshares a template `POST https://apizie.tech/v1/cloud:aliyun-ros/set-template-permission` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | ShareOption | string | yes | The sharing option. Valid values: ShareToAccounts: shares the template with other Alibaba Cloud accounts. CancelSharing: unshares the… | | VersionOption | string | no | The version option for the shared template. This parameter takes effect only if you set ShareOption to ShareToAccounts. Valid values:… | | TemplateVersion | string | no | The version of the shared template. This parameter takes effect only if you set ShareOption to ShareToAccounts and set VersionOption to… | | TemplateId | string | yes | The ID of the template | | AccountIds | string | yes | The Alibaba Cloud accounts with or from which you want to share or unshare the template. Valid values of N: 1, 2, 3, 4, and 5. This… | ### Sends a signal to a resource in a stack `POST https://apizie.tech/v1/cloud:aliyun-ros/signal-resource` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | Status | string | yes | The status of the signal. Failure signals can cause stack creation or update to fail. If all signals are warnings, the stack cannot be… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | UniqueId | string | yes | The unique ID of the signal. The ID must be 1 to 64 characters in length. If multiple signals are sent to a single resource, each signal… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… | | LogicalResourceId | string | yes | The logical ID of the resource as defined in the template | ### Streams agent events through Server-Sent Events (SSE) to create a new session or resume an existing session `POST https://apizie.tech/v1/cloud:aliyun-ros/start-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | Query | string | no | The user input. It cannot be empty or contain only whitespace characters | | SessionId | string | no | Omit this parameter to create a new session, or pass it to resume an existing session for the current user | | EnablePartialMessage | string | no | A compatibility field. V2 always returns an event stream through SSE. The current service does not consume this field | | Mode | string | no | V2 supports only IaCCodeNormal or IaCCodePipeline. The default mode for new sessions is IaCCodeNormal. You cannot switch the mode for an… | | Attachments | string | no | An array of image attachments. Up to five attachments are supported. Only the image type is currently supported (JSON-encoded) | | AgentVersion | string | no | Set this parameter to V2 to route the request to the ROS Agent V2 backend | | EnableThinking | string | no | Specifies whether to output thinking content. Default value: true. You can reset this parameter in each request during the same session | | RegionId | string | no | The region for this resource operation | | ClientReferenceId | string | no | A client-defined session identifier. It is used only for the client to identify its own sessions. The server does not provide capabilities… | ### Stops the running task in a specified ROS Agent V2 session `POST https://apizie.tech/v1/cloud:aliyun-ros/stop-chat` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | SessionId | string | no | The ID of the session to stop. The operation verifies that the session belongs to the current user | | AgentVersion | string | no | The agent version. Set this parameter to V2 to route the request to the ROS Agent V2 backend | ### Stops an ongoing stack group operation `POST https://apizie.tech/v1/cloud:aliyun-ros/stop-stack-group-operation` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack. You can call https://help.aliyun.com/document_detail/131035.html to query the latest Alibaba Cloud regions | | OperationId | string | yes | The operation ID. You can stop only ongoing stack group operations. You can call https://help.aliyun.com/document_detail/151342.html to… | ### Creates and adds tags to resources `POST https://apizie.tech/v1/cloud:aliyun-ros/tag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the tag. You can call https://help.aliyun.com/document_detail/131035.html to query the most recent region list | | ResourceType | string | yes | The resource type. Valid values: stack stackgroup template templatescratch: resource scenario | | ResourceId | string | yes | The resource IDs (JSON-encoded) | | Tag | string | yes | The tags of the resources. You can specify up to 20 tags (JSON-encoded) | ### Removes tags from resources and then deletes the tags `POST https://apizie.tech/v1/cloud:aliyun-ros/untag-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the tag. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | ResourceType | string | yes | The type of the resource. Valid values: stack: stack stackgroup: stack group template: template templatescratch: scenario | | All | string | no | Specifies whether to remove all tags from the resource. This parameter takes effect when TagKey is not specified in the request. Valid… | | ResourceId | string | yes | The IDs of the resource. If you set ResourceType to stackgroup, you must set ResourceId to the name of the stack group (JSON-encoded) | | TagKey | string | no | The tag keys of the resource. You can specify up to 20 tag keys (JSON-encoded) | ### Updates the resource information of a created stack `POST https://apizie.tech/v1/cloud:aliyun-ros/update-stack` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The stack ID | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. This parameter value is generated by the client and must be… | | StackPolicyDuringUpdateBody | string | no | The structure of the temporary overriding stack policy body. The value must be 1 to 16,384 bytes in length. To update protected resources,… | | TimeoutInMinutes | integer | no | The timeout period for updating the stack. Default value: 60. Unit: minutes | | TemplateBody | string | no | The structure of the template body. The value must be 1 to 524,288 bytes in length. If the length is large, we recommend that you use the… | | StackPolicyURL | string | no | The URL of the file that contains the stack policy. The URL must point to a policy located on a web server (HTTP or HTTPS) or in an… | | StackPolicyDuringUpdateURL | string | no | The URL of the file that contains the stack policy for the update. The URL must point to a policy located on a web server (HTTP or HTTPS)… | | StackPolicyBody | string | no | The structure of the stack policy body. The value must be 1 to 16,384 bytes in length. You can specify only one of the following… | | UsePreviousParameters | string | no | Specifies whether to use the previously specified values for parameters that are not passed in the current request. Valid values: true:… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | DisableRollback | string | no | [Deprecated] This parameter has no effect | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template located on an HTTP web server (HTTP or HTTPS) or in… | | RamRoleName | string | no | The name of the RAM role. Resource Orchestration Service (ROS) assumes the role to create the stack and uses the credentials of the role… | | ReplacementOption | string | no | Specifies whether to use replacement update. If a resource property does not support modification update, you can use replacement update… | | TemplateId | string | no | The template ID. Both shared templates and private templates are supported. You must and can only specify one of the following parameters:… | | TemplateVersion | string | no | The template version. This parameter takes effect only when TemplateId is specified | | Parameters | string | no | The parameters (JSON-encoded) | | Tags | string | no | The tags of the stack (JSON-encoded) | | Parallelism | integer | no | The maximum number of concurrent resources. Default value: empty. You can enter an integer greater than or equal to zero. If you set this… | | ResourceGroupId | string | no | The resource group ID | | DryRun | string | no | Specifies whether to perform only a validation. Valid values: true: Only validation is performed without actually updating the stack.… | | DryRunOptions | string | no | The list of validation options. Maximum length of the list: 1. This parameter takes effect only when DryRun is set to true (JSON-encoded) | | TaintResources | string | no | The list of resources to be marked as tainted (JSON-encoded) | ### Updates an existing stack group `POST https://apizie.tech/v1/cloud:aliyun-ros/update-stack-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length, and must start with… | | Description | string | no | The description of the stack group. The description must be 1 to 256 characters in length | | AccountIds | string | no | The list of execution account IDs used to deploy stacks in the self-managed permissions mode. You can add up to 50 execution account IDs… | | RegionIds | string | no | The list of target regions where stacks are deployed. You can add up to 20 regions (JSON-encoded) | | TemplateBody | string | no | The structure of the template body. The template body must be 1 to 524,288 bytes in length. If the template body is large, use the HTTP… | | TemplateURL | string | no | The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | OperationDescription | string | no | The description of the stack group update operation | | OperationPreferences | string | no | The operation settings for updating the stack group. This parameter includes the following fields: {"FailureToleranceCount": N} The number… | | AdministrationRoleName | string | no | The name of the Resource Access Management (RAM) administrator role that is assumed by ROS when you create a stack group with self-managed… | | ExecutionRoleName | string | no | The name of the RAM execution role that is assumed by the administrator role (AliyunROSStackGroupAdministrationRole) when you create a… | | TemplateId | string | no | The ID of the template. Shared templates and private templates are supported. You must specify only one of the following parameters:… | | TemplateVersion | string | no | The version of the template. If you do not specify this parameter, the latest version is used by default. TemplateVersion takes effect… | | Parameters | string | no | The list of parameters for the stack group (JSON-encoded) | | PermissionModel | string | no | The authorization pattern. Valid values: SELF_MANAGED (default): the self-managed permissions pattern. If you use this pattern, you must… | | AutoDeployment | string | no | The auto-deployment settings. This parameter is required only when PermissionModel is set to SERVICE_MANAGED (JSON-encoded) | | DeploymentTargets | string | no | The deployment targets for updating stacks in the service-managed permissions mode (JSON-encoded) | | Capabilities | string | no | The list of options for the stack group. Maximum length: 1 (JSON-encoded) | | DeploymentOptions | string | no | The list of deployment options for updating the stack group in the service-managed permissions mode. You can specify up to 1 deployment… | ### Updates stack instances for one or more accounts in specified regions `POST https://apizie.tech/v1/cloud:aliyun-ros/update-stack-instances` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the stack group. Call https://help.aliyun.com/document_detail/131035.html to get the latest list of Alibaba Cloud regions | | StackGroupName | string | yes | The name of the stack group. The name must be unique within a region. The name can be up to 255 characters in length and must start with a… | | AccountIds | string | no | The IDs of the destination accounts for which you want to deploy stacks with self-managed permissions. You can specify up to 30 account… | | RegionIds | string | yes | The list of regions where you want to perform the operation. You can specify up to 20 regions (JSON-encoded) | | ClientToken | string | no | A client token that is used to ensure the idempotence of the request. The client token is generated by the client and must be globally… | | OperationDescription | string | no | The description of the update operation. The description must be 1 to 256 characters in length | | OperationPreferences | string | no | The operation settings for updating the stacks. This includes the following parameters: {"FailureToleranceCount": N} The number of… | | TimeoutInMinutes | integer | no | The timeout period for the update operation. Default value: 60. Unit: minutes | | ParameterOverrides | string | no | The list of parameters to overwrite (JSON-encoded) | | DeploymentTargets | string | no | The deployment targets for the stacks that are deployed in service-managed mode. This parameter is required when you update stacks in… | ### Eliminates stack drifts by performing drift detection `POST https://apizie.tech/v1/cloud:aliyun-ros/update-stack-template-by-resources` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | StackId | string | yes | The ID of the stack | | DryRun | string | no | Specifies whether to only preview the corrected template in this request. Default value: false. Valid values: true: returns the content of… | | RegionId | string | yes | The region ID of the stack. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent region… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… | | TemplateFormat | string | no | The format of the returned template. Default value: JSON. Valid values: JSON YAML | | LogicalResourceId | string | no | The logical ID of resource (JSON-encoded) | ### Update Template `POST https://apizie.tech/v1/cloud:aliyun-ros/update-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateURL | string | no | The location of the file containing the template body. The URL must point to a template located on a web server (HTTP or HTTPS) or in an… | | TemplateName | string | no | The name of the template. The length should not exceed 255 characters (utf-8 encoding), and it must start with a number, letter, or… | | Description | string | no | The description of the template. The maximum length is 256 characters | | TemplateBody | string | no | The structure of the template body. The length should be between 1 and 524,288 bytes. If the content is long, it is recommended to use… | | TemplateId | string | yes | The template ID. Supports both shared and private templates | | ValidationOptions | string | no | Validation options. By default, no options are enabled, and strict validation is performed (JSON-encoded) | | RotateStrategy | string | no | Template version rotation strategy. Values: None (default): No rotation. An error occurs when the version limit is reached.… | | IsDraft | string | no | Whether to update the Draft (draft) version. Values: false (default): If template content is provided, a new version is created, and the… | ### Updates a scenario `POST https://apizie.tech/v1/cloud:aliyun-ros/update-template-scratch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | RegionId | string | yes | The region ID of the scenario. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most recent… | | TemplateScratchId | string | yes | The ID of the resource scenario. The valid values of the ParameterKey and ParameterValue request parameters vary based on the IDs of… | | Description | string | no | The description of the scenario | | SourceResources | string | no | The source resources. You must specify only one of the following parameters: SourceResources, SourceTag, and SourceResourceGroup… | | SourceTag | string | no | The source tag. You must specify only one of the following parameters: SourceResources, SourceTag, and SourceResourceGroup (JSON-encoded) | | SourceResourceGroup | string | no | The source resource group. You must specify only one of the following parameters: SourceResources, SourceTag, and SourceResourceGroup… | | PreferenceParameters | string | no | The preference parameters of the resource scenario (JSON-encoded) | | LogicalIdStrategy | string | no | The policy based on which the logical ID is generated. Valid values: LongTypePrefixAndIndexSuffix: long-type prefix + index-type suffix… | | ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… | | ExecutionMode | string | no | The execution mode. Valid values: Async (default) Sync If you have a wide scope of resources, Sync takes longer. If you set ExecutionMode… | | ResourceGroupId | string | no | The ID of the resource group | ### Validates a template that is used to create a stack by specifying template URL or body `POST https://apizie.tech/v1/cloud:aliyun-ros/validate-template` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | TemplateURL | string | no | The location of the file that contains the template body. The URL must point to a template that is located on an HTTP web server or in an… | | RegionId | string | no | The region ID of the stack template. You can call the https://help.aliyun.com/document_detail/131035.html operation to query the most… | | TemplateBody | string | no | The structure of the template body. The template body can be 1 to 524,288 bytes in length. If the template body is long, use a POST… | | ClientToken | string | no | A client token that is used to ensure the idempotence of the request. The client generates the value, which must be unique. The token can… | | ValidationOption | string | no | Specifies whether to enable additional validation for the template. Valid values: None (default): No additional validation is enabled.… | | UpdateInfoOptions | string | no | The list of options for the update information. The list can contain up to two options (JSON-encoded) | ### version `POST https://apizie.tech/v1/cloud:aliyun-ros/version` (byok) ## Example ``` curl "https://apizie.tech/v1/cloud:aliyun-ros/cancel-stack-operation" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Resource Orchestration Service API? Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-ros/cancel-stack-operation with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Resource Orchestration Service API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Resource Orchestration Service itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Resource Orchestration Service API? Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ros. ### What is the status of the Alibaba Cloud Resource Orchestration Service API? Needs your own provider key (bring your own key)