# Alibaba Cloud Iac Service API

> Alibaba Cloud Iac Service API on Apizie: 103 endpoints (Adds a shared account, Associates a drift detection configuration, Associates resources with a group, Associates parameter sets, …) 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://zieapi.vercel.app/v1/cloud:aliyun-iacservice/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-iacservice`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/iacservice
- Page: https://zieapi.vercel.app/api/cloud/aliyun-iacservice
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-iacservice/openapi.json

Alibaba Cloud OpenAPI for Iac Service (iacservice, version 2021-08-06). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a shared account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/add-shared-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| accountIds | array | no | The list of Alibaba Cloud account IDs |
| resourceId | string | no | The ID of the shared resource. If the type is Namespace, the value is the workspace name. If the type is RegistryModule, the value is / |
| resourceType | string | no | The resource type. Valid values: RegistryModule: Registry template Namespace: workspace |

### Associates a drift detection configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/associate-detect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| detectConfigId | string | yes | The ID of the drift detection configuration |
| targetId | string | yes | The ID of the association target. The value is a StackId or TaskId |
| targetType | string | yes | The type of the association target. Valid values: Task: orchestration task. Stack: resource stack |

### Associates resources with a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/associate-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| groupId | string | yes | The group ID |
| clientToken | string | no | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| projectId | string | no | The project ID |
| resourceIds | array | yes | The list of resource IDs |
| resourceType | string | no | The resource type. Valid values: SceneTestingTask: scenario-based testing task. Task: regular task. Module: template |

### Associates parameter sets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/associate-parameter-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| parameterSetIds | array | yes | The list of parameter set IDs to associate with the resource. Maximum length: 5 |
| resourceId | string | yes | The resource ID. When the resource type is ModuleVersion, the value is a concatenation of - , such as mod-34535345df123fr-v3 |
| resourceType | string | yes | The resource type. Valid values: Module: template ModuleVersion: template version Task: node Stack: resource stack |

### Cancels a resource export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/cancel-resource-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| exportTaskId | string | yes | The ID of the resource export task |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |

### Creates a drift detection configuration that supports manual or scheduled triggering.
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-detect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| alarmConfigs | array | no | List of alerting addresses |
| clientToken | string | yes | Idempotence token, format: `[0-9a-zA-Z-]{1,64}`. It is recommended to use a UUID. |
| cronExpression | string | no | Cron expression (UTC+8). Required when trigger type is `Cron`. |
| description | string | no | Description, up to 256 characters in length. |
| detectConfigName | string | yes | Detection configuration Name |
| enabled | string | no | Whether the Detection feature is Enabled. The default value is `true` |
| triggerType | string | no | Trigger type Manual: Execute manually Cron: Trigger on a schedule |

### Creates a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| autoDestroy | string | no | Specifies whether to delete the group after creation |
| autoTrigger | string | no | Specifies whether to enable the automatic trigger policy. Valid values: true: enabled. false: disabled |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The description of the group |
| forcedSetting | string | no | Specifies whether to forcibly use the group configuration |
| name | string | yes | The name of the group |
| notifyConfig | array | no | The notification configuration |
| notifyOperationTypes | array | no | The list of notification operation types |
| projectId | string | yes | The project ID |
| ramRole | string | no | The RAM role (1-128 characters). The system assumes this role to execute the template when a new job is triggered. This parameter is… |
| reportExportField | array | no | The list of export fields for the report |
| reportExportPath | string | no | The export address for the execution report. OSS addresses are supported. https:// / |
| terraformProviderVersion | string | no | The Terraform Provider version. Select a Terraform Provider version. The version configured on the task takes higher priority |
| triggerConfig | array | no | The trigger policy. This parameter cannot be empty when autoTrigger is set to true |
| triggerResourceType | array | no | The resource type for triggered execution. Valid values: Task: regular task. SceneTestingTask: scenario-based testing task |

### Creates a job and runs a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | yes | The job description. Length: 1 to 64 characters |
| subCommand | string | no | The operation command. Valid values: plan: performs a preview. This is the default value. refresh: refreshes the resource status. destroy:… |
| taskType | string | no | The task type. Valid values: Task: regular task. This is the default value. SceneTestingTask: scenario-based testing task |
| taskId | string | yes | The task ID |

### Creates a Terraform template. Multiple source methods are supported, such as OSS import, Registry import,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency parameter. We recommend that you use a UUID |
| description | string | no | The description of the template. The description can be up to 256 characters in length |
| groupInfo | object | no | The project group information to which the template belongs |
| name | string | yes | The name of the template. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name can… |
| source | string | yes | The source from which the template is created. Valid values: OSS: imports from a ZIP file stored in OSS. Registry: creates from a module… |
| sourcePath | string | no | The path of the template source. This parameter takes effect when source is set to Registry, OSS, or ExportTask. If source is set to… |
| statePath | string | no | The path of the State file that corresponds to the template. This parameter is valid only when source is set to OSS. The value is in the… |
| tags | array | no | The list of tags for the template |
| versionStrategy | string | no | The version generation strategy. Valid values: Manual: manually generates a version. This is the default value. SourcePathUpdated:… |

### Publishes a new version for a specified template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-module-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| moduleId | string | yes | The template ID |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The version description. The description can be up to 256 characters in length |
| name | string | yes | The template version name. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name can… |

### Adds a new parameter set. You can set the name, description, and parameter list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-parameter-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The description of the parameter set. Maximum length: 1,024 characters |
| name | string | yes | The name of the parameter set. Maximum length: 128 characters |
| parameters | array | no | The list of parameters |

### Creates a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The project description. Length: 0 to 1024 characters |
| name | string | yes | The project name. Length: 1 to 128 characters |

### Creates a Registry template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-registry-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| acl | string | no | The access permission. Valid values: private: private |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The description of the Registry template |
| moduleName | string | yes | The name of the Registry template. The name must meet the following requirements: The name must be 3 to 63 characters in length. The name… |
| namespaceName | string | yes | The workspace name |
| provider | string | no | The provider type. Valid values: alicloud: Alibaba Cloud |
| type | string | no | The template type. Valid values: self: custom template |

### Creates a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-registry-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| acl | string | no | The access permission. Valid values: private: private access |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The workspace description |
| maintainer | string | no | The administrator name |
| namespaceName | string | yes | The workspace name. The name must meet the following requirements: The name must be 3 to 63 characters in length. The name can contain… |

### Creates a resource export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-resource-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The description of the resource export task |
| exportToModule | object | no | Saves the exported template as a module. If this parameter is not specified, the template is automatically saved in the Registry |
| includeRules | array | no | The list of inclusion rules used when exporting resources |
| name | string | yes | The name of the resource export task. The name must meet the following requirements: The name must be 3 to 63 characters in length. The… |
| ramRole | string | no | The RAM role (1 to 128 characters). The system assumes this role to execute the template when a new job is triggered. This parameter is… |
| terraformProviderVersion | string | no | The Terraform provider version. Call ListTerraformProviderVersions to view the list of supported versions. Default value: the latest version |
| terraformVersion | string | no | The Terraform version. Call ListAvailableTerraformVersions to view the list of supported versions. Default value: 1.5.7 |
| triggerStrategy | string | no | The trigger strategy. Valid values: Auto: triggered when rules are modified or the trigger strategy is changed to Auto. Manual: manually… |
| variables | array | no | The list of variables. Exported resource parameters are set as variables |

### Creates a stack and triggers a deployment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency token. The format is [0-9a-zA-Z-]{1,64}. A UUID is recommended |
| description | string | no | The description of the stack. The description cannot exceed 256 characters in length |
| name | string | no | The name of the stack. The name must be 2 to 128 characters in length, and can contain letters, digits, Chinese characters, hyphens (-),… |
| parameterSetIds | array | no | The associated parameter sets |
| ramRole | string | no | Specifies the Resource Access Management (RAM) role to authorize for the task. This role is used to automatically resume the execution of… |
| source | string | yes | The creation source. Valid values: OSS: a template from Object Storage Service (OSS). IAC_SERVICE_MODULE: a template created in the… |
| sourcePath | string | no | The path of the source. The value cannot exceed 1,000 characters in length. If the source is OSS, the value is in the oss:: format. The… |
| workingDirectory | string | no | The working directory where the configuration file is located. If the file is in the root directory, enter /. Examples: config/ or / |

### Creates a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| autoApply | string | no | Specifies whether to automatically execute the task. Default value: false. true: After the preview is complete (terraform plan), the… |
| autoDestroy | string | no | Specifies whether to automatically destroy resources after creation. Default value: false. true: After the execution is complete… |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The task description |
| groupInfo | object | no | The project group information |
| initModuleState | string | no | Specifies whether to use a state file. Default value: false. This parameter applies to templates that originate from resource export. Only… |
| moduleId | string | yes | The template ID |
| moduleVersion | string | yes | The template version |
| name | string | yes | The task name. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name can contain… |
| parameterSetIds | array | no | The collection of associated parameter set IDs |
| protectionStrategy | array | no | The list of resource protection strategies |
| ramRole | string | no | The RAM role. The system assumes this role to execute the template when a new job is triggered. This parameter is required when the job… |
| skipPropertyValidation | string | no | Specifies whether to skip enumeration value validation. Default value: false |
| skipRegionValidation | string | no | Specifies whether to skip region validation. Valid values: true (skip) and false (do not skip) |
| tags | array | no | The list of tags for the task |
| taskBackend | object | no | The task configuration. After this parameter is configured, runtime log information is saved to the specified OSS bucket |
| terraformProviderVersion | string | no | The Terraform Provider version. You can call the ListTerraformProviderVersions operation to obtain the list of supported versions |
| terraformVersion | string | no | The Terraform version. You can call the ListAvailableTerraformVersions operation to obtain the list of supported versions. Default value:… |
| triggerStrategy | string | no | The job trigger method. Valid values: Manual: Manual trigger (default). NewVersion: Triggered when a new template version is published.… |

### Creates a task from a resource import result
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/create-task-from-resource-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The client token that is used to ensure the idempotence of the request. The token must be 1 to 64 characters in length and can contain… |
| exportTaskId | string | yes | The ID of the resource export task |
| exportVersion | string | yes | The resource export version |
| taskName | string | yes | The name of the task |

### Deletes a bias detection configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-detect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| detectConfigId | string | yes | The ID of the bias detection configuration |

### Deletes a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| groupId | string | yes | The group ID |

### Deletes a specified template and all its versions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| moduleId | string | yes | The template ID |

### Deletes a specified parameter set by parameter set ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-parameter-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| parameterSetId | string | yes | The ID of the parameter set |

### Deletes a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| projectId | string | yes | The project ID |

### Deletes a Registry template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-registry-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The workspace name |
| moduleName | string | yes | The template name |

### Deletes a Registry template version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-registry-module-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The workspace name |
| moduleName | string | yes | The template name |
| version | string | yes | The version number |

### Deletes a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-registry-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The name of the workspace |

### Deletes a resource export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-resource-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| exportTaskId | string | yes | The ID of the resource export task |

### Deletes a stack
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| stackId | string | yes | The stack ID. This is the unique identifier generated after the stack is created |
| cleanResources | string | no | Specifies whether to synchronously clean up resources managed by the stack. By default, resources are not cleaned up |

### Deletes a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/delete-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| taskId | string | yes | The task ID |
| resourceRetentionPolicy | string | no | The data retention policy for resources. If this parameter is not specified, it indicates that the deletion is not confirmed. If the node… |

### Initiates a state file consistency check
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/detect-terraform-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| identifier | string | yes | The task identifier. For a Stack task, the format is : . For a Task task, the format is |
| type | string | yes | The task type. Valid values: Stack Task |

### Dissociates a drift detection configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/dissociate-detect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| detectConfigId | string | no | The ID of the drift detection configuration |
| targetId | string | yes | The ID of the association target. The value is a StackId or TaskId |
| targetType | string | yes | The type of the association target. Valid values: Task: orchestration task. Stack: resource stack |

### Dissociates a resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/dissociate-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| projectId | string | yes | The project ID |
| groupId | string | yes | The group ID |
| clientToken | string | no | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| resourceIds | array | yes | The list of resource IDs |
| resourceType | string | no | The resource type. Valid values: Module: template. SceneTestingTask: scenario-based testing task. Task: regular task |

### Dissociates a parameter set from other resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/dissociate-parameter-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| parameterSetIds | array | yes | The list of parameter set IDs to be associated with the resource. Maximum length: 5 |
| resourceId | string | yes | The resource ID. If the resource type is ModuleVersion, the value is a combination of - , such as mod-34535345df123fr-v3 |
| resourceType | string | yes | The resource type. Valid values: Module: template ModuleVersion: template version Task: node Stack: resource stack |

### Executes a Module officially provided by Alibaba Cloud Terraform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/execute-registry-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The workspace to which the Module belongs. The workspaces for official registry modules are alibaba, alibabacloud-automation, aliyun, and… |
| moduleName | string | yes | The template name. You can call ListExplorerRegistryModules to query available modules |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| parameters | object | no | The set of parameters used by the template |

### Runs a resource export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/execute-resource-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| exportTaskId | string | yes | The resource export ID |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |

### Executes TerraformApply
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/execute-terraform-apply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| code | string | no | The Terraform code to execute. If the execution content has not changed, you can specify only stateId |
| stateId | string | no | The state file ID. If this parameter is specified, the Apply command continues execution based on the existing state file |

### Executes Terraform Destroy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/execute-terraform-destroy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| stateId | string | yes | The state file ID |

### Executes a Terraform plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/execute-terraform-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| code | string | no | The Terraform code to execute. If the execution content has not changed, you can specify only stateId |
| stateId | string | no | The ID of the state file. If this parameter is specified, the Plan command continues to run based on the existing state file |

### Generates Terraform HCL template code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/generate-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| generateSource | string | no | The generation source. Valid values: Resource: Generates a Terraform HCL template based on resource properties. VariableToCode: Generates… |
| parameters | object | no | The collection of parameters, passed in key:value format, such as {"vpc_name":"vpc-test"} |
| regionId | string | no | The region ID |
| syntax | string | no | The syntax. Valid values: hcl (default) |
| template | string | no | The existing Terraform HCL template content |
| terraformProviderVersion | string | no | The Terraform provider version |
| terraformResourceType | string | no | The Terraform resource type |

### Retrieve drift detection configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-detect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| detectConfigId | string | yes | Drift detection configuration ID |

### Retrieves the encryption configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-encryption-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |

### Retrieves the result of a Terraform run
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-execute-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| stateId | string | yes | The state file ID |

### Queries a group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| groupId | string | yes | The group ID |

### Retrieves job information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| taskId | string | yes | The task ID |
| jobId | string | yes | The job ID |
| taskType | string | no | The task type. Valid values: Task: Regular task (default). SceneTestingTask: Scenario-based testing task. Stack: Resource stack |

### Queries the details of a specified template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| moduleId | string | yes | The template ID |

### Queries the details of a specific version of a specified template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-module-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| moduleId | string | yes | The template ID |
| moduleVersion | string | yes | The template version |

### Retrieves the details of a parameter set by parameter set ID
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-parameter-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| parameterSetId | string | yes | The parameter set ID |

### Queries a project
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| projectId | string | yes | The project ID |

### Retrieves the Terraform provider resource document
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-provider-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| providerVersion | string | no | The Terraform provider version |
| terraformResourceType | string | yes | The Terraform resource type |

### Queries a Registry module
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-registry-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The workspace name |
| moduleName | string | yes | The module name |

### Queries a Registry template version
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-registry-module-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The workspace name |
| moduleName | string | yes | The template name |
| version | string | yes | The version number |

### Queries a workspace
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-registry-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The name of the workspace |

### Queries the details of a resource export task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-resource-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| exportTaskId | string | yes | The ID of the resource export task |
| exportVersion | string | no | The export version |

### Retrieves resource type information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-resource-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| resourceType | string | yes | The resource code used to retrieve detailed information about a specified resource type |
| terraformProviderVersion | string | no | The Terraform provider version. If this parameter is left empty, the latest version is used by default |
| filterReadOnly | string | no | Specifies whether to filter read-only properties |
| acceptLanguage | string | no | The language of the response. Valid values: zh-CN: Chinese. en-US: English. Default value: zh-CN |

### Queries a stack
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| stackId | string | yes | The unique identifier of the stack, which is generated after the stack is created |

### Queries the deployments of a stack
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-stack-deployments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| stackId | string | yes | The unique identifier of the stack |
| deploymentName | string | no | The name of the deployment |
| pageNumber | integer | no | The page number. Pages start from 1 |
| pageSize | integer | no | The number of entries to return on each page. Default value: 20. Minimum value: 1. Maximum value: 200 |
| status | string | no | The deployment status. Valid values: / Name / Description / /------/------/ / Pending / The initial status after the deployment is… |
| configVersion | string | no | The configuration version, such as v1. The initial value is v1. The version number increments each time the stack is updated or refreshed… |
| deploymentNo | string | no | The deployment number. The deployment number of each stack starts from 1 and increments each time a deployment is successfully triggered |

### Retrieves the stack trigger results
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-stack-execution-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| triggerId | string | yes | The unique ID of the trigger. You can obtain this ID by calling the TriggerStackExecution operation |

### Retrieves the details of a task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| taskId | string | yes | The task ID |

### Retrieves the detection result of a state file
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/get-terraform-state-detection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| detectionId | string | yes | The ID of the detection task |

### List drift detection associations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-detect-config-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| targetType | string | no | Type of the association target Task: orchestration Job Stack: resource stack |
| targetId | string | no | Target ID to associate. StackId or TaskId |
| detectConfigId | string | no | Drift detection configuration ID |

### List drift detection configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-detect-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| detectConfigName | string | no | Name of the drift detection configuration (fuzzy match). |
| maxResults | integer | no | Maximum number of records to retrieve in a single request. Valid range: 1–200. Default value: 100. |
| nextToken | string | no | Query credential (Token). Set this parameter to the NextToken value returned by the previous API call. |

### Retrieves the list of official Terraform Module examples
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-explorer-registry-module-examples` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | no | The name of the workspace to which the module belongs |
| moduleName | string | no | The name of the module |
| moduleVersion | string | no | The version of the module |
| exampleName | string | no | The example name of the module |
| keyword | string | no | The search keyword. Supports fuzzy match based on the module name or module example name |
| maxResults | integer | no | The maximum number of entries per page. Valid values: 0 to 200. Default value: 100 |
| nextToken | string | no | The pagination token for the next page of results. If the total number of entries exceeds the maxResults limit, the data is truncated. You… |

### Lists the version information of official Terraform modules provided by Alibaba Cloud
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-explorer-registry-module-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | no | The name of the workspace to which the module belongs |
| moduleName | string | no | The name of the module |
| moduleVersion | string | no | The version of the module |
| keyword | string | no | The search keyword. Fuzzy match is supported based on the module name |
| maxResults | integer | no | The maximum number of entries per page. Valid values: 0 to 200. Default value: 100 |
| nextToken | string | no | The pagination token for the next page of results. If the total number of entries exceeds the maxResults limit, the data is truncated. You… |

### Lists information about official Terraform modules provided by Alibaba Cloud
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-explorer-registry-modules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The search keyword for the module name. Fuzzy matching is performed based on `moduleName` |
| maxResults | integer | no | The maximum number of entries per page. Valid values: 0 to 200. Default value: 100 |
| nextToken | string | no | The pagination token for the next page of results. If the total number of entries exceeds the maxResults limit, the data is truncated. You… |
| sort | string | no | The sort order of the returned results. Valid values: Normal (default): returns results in normal order. Top: returns results sorted by… |
| moduleName | string | no | The name of the module. Note: The module name is not necessarily the same as the product name or resource name |

### Queries the list of groups
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| pageSize | string | no | The number of results to return per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | string | no | The page number. Default value: 1 |
| projectId | string | no | The project ID |
| keyword | string | no | The search keyword. Name-based search is supported |
| tag | string | no | The list of tags (JSON-encoded) |

### Queries a list of jobs
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| taskId | string | yes | The task ID |
| status | string | no | The job status. Valid values: Pending: The initial status after the job is created. PlanQueued: After the job is created, if no workflow… |
| pageSize | integer | no | The number of results returned per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | integer | no | The page number. Default value: 1 |
| taskType | string | no | The task type. Valid values: Task: Regular task (default). SceneTestingTask: Scenario-based testing task |
| jobType | string | no | The job type |

### Retrieves a list of template versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-module-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| moduleId | string | yes | The template ID |
| keyword | string | no | The search keyword. Fuzzy match on version names is supported |
| pageSize | integer | no | The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | integer | no | The page number. Default value: 1 |

### Retrieves the list of templates under the current user, with support for pagination and conditional filtering
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-modules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The search keyword. Supports fuzzy match on template names |
| pageSize | integer | no | The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | integer | no | The page number. Default value: 1 |
| projectId | string | no | The project ID |
| groupId | string | no | The group ID |
| tag | string | no | The list of template tags (JSON-encoded) |
| moduleName | string | no | The template name |

### Lists the parameter sets associated with a resource
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-parameter-set-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| resourceType | string | yes | The type of the resource. Valid values: Module ModuleVersion Task SceneTestingTask Stack |
| resourceId | string | yes | The ID of the resource. For ModuleVersion, concatenate - |

### Queries and retrieves a paginated list of parameter sets with keyword search support
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-parameter-sets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The keyword for exact match search. The search is case-insensitive |
| pageSize | integer | no | The number of results returned per page. Default value: 20. Minimum value: 1. Maximum value: 200 |
| pageNumber | integer | no | The page number. Default value: 1 |
| kmsKeyId | string | no | The key ID |

### Queries the list of all products
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-products` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| nextToken | string | no | The pagination token |
| terraformProviderVersion | string | no | The Terraform Provider version. If this parameter is left empty, the latest version is used by default |
| maxResults | integer | no | The maximum number of results per page. Valid values: 0 to 200. Default value: 100 |
| keyword | string | no | The keyword for searching products. Fuzzy match is supported |
| supportTerraformer | string | no | Specifies whether Terraformer is supported |
| status | string | no | The status. Valid values: Available Deprecated |
| sort | string | no | The sort order. Valid values: Normal: default sorting (default value) Top: sorted by popularity |

### Queries the list of projects
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| pageSize | string | no | The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | string | no | The page number. Default value: 1 |
| tag | string | no | The list of tags (JSON-encoded) |
| keyword | string | no | The search keyword. Name-based search is supported |

### Queries the list of Registry template versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-registry-module-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | yes | The workspace name |
| moduleName | string | yes | The Registry template name |
| maxResults | integer | no | The number of entries per page in a paged query. Maximum value: 100. Default value: 20 |
| nextToken | string | no | The pagination token. Set this parameter to the NextToken value returned in the previous API call |

### Queries the list of Registry modules
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-registry-modules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| namespaceName | string | no | The workspace name |
| type | string | no | The workspace type. Valid values: system: public module self: custom module shared: shared module community: community module By default,… |
| keyword | string | no | The search keyword. Fuzzy match on module names is supported |
| maxResults | integer | no | The number of entries per page in a paged query. Maximum value: 100. Default value: 20 |
| nextToken | string | no | The pagination token. Set this parameter to the value of NextToken returned in the previous API call |
| status | string | no | The filter condition for Registry module status |

### Queries the list of workspaces
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-registry-namespaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The search keyword. Fuzzy search by workspace name is supported |
| type | string | no | The workspace type. Valid values: system: public workspace self: custom workspace shared: shared workspace community: community workspace… |
| maxResults | integer | no | The number of entries per page in a paged query. Maximum value: 100. Default value: 20 |
| nextToken | string | no | The query token. Set this parameter to the NextToken value returned in the previous API call |

### Retrieves the versions of a resource export task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-resource-export-task-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The search keyword. Fuzzy search is supported for export version names |
| exportTaskId | string | yes | The ID of the resource export task |
| pageSize | integer | no | The number of results to return per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | integer | no | The page number. Default value: 1 |
| status | string | no | The export status. Valid values: Queue: Queued. Pending: Ready to run. Success: Succeeded. Errored: Failed. Canceled: Canceled |
| exportVersion | string | no | The export version number |

### Queries the list of resource export tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-resource-export-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The search keyword. Fuzzy search by task name is supported |
| exportTaskId | string | no | The ID of the resource export task |
| pageSize | integer | no | The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | integer | no | The page number. Default value: 1 |

### Queries a list of resource types by filter conditions with pagination support
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-resource-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| product | string | no | The product code. Fuzzy match is supported |
| terraformProviderVersion | string | no | The Terraform Provider version. If this parameter is left empty, the latest version is used by default |
| subcategory | string | no | The product subcategory in Terraform |
| nextToken | string | no | The pagination token |
| status | string | no | The status list for filtering. Valid values: Available Deprecated |
| maxResults | integer | no | The maximum number of entries per page. Valid values: 0 to 200. Default value: 100 |
| keyword | string | no | The keyword for searching resource code or name. Fuzzy match is supported |
| supportTerraformer | string | no | Specifies whether Terraformer is supported |
| terraformResourceTypes | string | no | The list of Terraform resources (JSON-encoded) |
| sort | string | no | The order in which resource types are returned. Valid values: Normal (default): returned in normal order. Top: returned in order of… |
| acceptLanguage | string | no | The language of the response. Valid values: zh-CN: Chinese. en-US: English. Default value: zh-CN |

### Retrieves the resources of a node
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| sourceType | string | yes | The type of the resource source. Valid values: ExportTaskId: resource export ID TaskId: Module execution task ID StatePath: the OSS path… |
| sourceValue | string | yes | The specific value of the resource source. If sourceType is set to ExportTaskId, the format is ExportTaskId:Version. If sourceType is set… |
| specType | string | yes | The specification that resource properties follow in the response. Valid values: CloudSpec, Terraform. Default value: CloudSpec |
| pageSize | integer | no | The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 200 |
| pageNumber | integer | no | The page number. Default value: 1 |

### Queries the list of stack configurations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-stack-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| nextToken | string | no | The pagination token that marks the position from which to start reading. Leave empty to start from the beginning |
| maxResults | integer | no | The maximum number of records to read in this request. Default value: 20. Maximum value: 200 |
| status | string | no | The status of the stack configuration. / Name / Description / /------/------/ / Creating / Being created. / / Created / Created. / /… |
| stackId | string | yes | The stack ID. The unique identifier generated after the stack is created |
| version | string | no | The version number of the stack configuration, such as v1. The initial value is v1. The version number increments each time the stack is… |

### Queries the list of stacks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-stacks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The keyword used to perform a fuzzy search by stack name |
| status | string | no | The stack status. / Name / Description / /------/------/ / Creating / Being created. / / Created / Created. / / Waiting / Waiting for… |
| pageSize | integer | no | The number of results returned per page. Default value: 20. Minimum value: 1. Maximum value: 200 |
| pageNumber | integer | no | The page number. Default value: 1 |
| nextToken | string | no | The pagination token. This parameter is empty if no more pages are available |
| maxResults | integer | no | The maximum number of results to return. Default value: 100. Maximum value: 200 |
| kmsKeyId | string | no | The key ID |

### Retrieves a list of tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The keyword used to perform a fuzzy search by task ID or task name |
| taskId | string | no | The task ID |
| moduleId | string | no | The template ID |
| pageSize | integer | no | The number of results returned per page. Default value: 20. Minimum value: 1. Maximum value: 100 |
| pageNumber | integer | no | The page number. Default value: 1 |
| projectId | string | no | The project ID |
| groupId | string | no | The group ID |
| status | string | no | The job status. Valid values: Planning: The job is in the Plan execution phase. Planned: The job has completed the Plan execution.… |
| tag | string | no | The list of task tags (JSON-encoded) |
| kmsKeyId | string | no | The key ID |

### Retrieves the list of Terraform provider versions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/list-terraform-provider-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| keyword | string | no | The keyword for searching versions. Fuzzy match is supported |
| nextToken | string | no | The pagination token for the next page. A value of null indicates that no more pages are available |
| maxResults | integer | no | The maximum number of records to retrieve in a single request |
| usage | string | no | The usage. Set to Explorer to retrieve meta information |

### Supports resource import and removal for state files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/manage-terraform-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| action | string | yes | The action to perform on the state file. Supports import and removal. Valid values: Import StateRemove |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| identifier | string | yes | The task identifier. For Stack tasks, the format is : . For Task tasks, the format is |
| importResourceId | string | no | The actual resource ID of the Terraform resource |
| resourceIdentifier | string | yes | The resource identifier in the Terraform template. For Stack tasks, the format is : . For Task tasks, the format is |
| type | string | yes | The task type. Valid values: Stack Task |

### After a job is created, you can perform the Cancel operation to stop the job while it is running. After a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/operate-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| taskId | string | yes | The task ID |
| jobId | string | yes | The job ID |
| operationType | string | yes | The operation type. Valid values: execute: continues the Apply operation after the Plan is complete. abolish: abandons a job that has… |
| comment | string | yes | The description. The length is 0 to 128 characters |
| taskType | string | no | The task type. Valid values: Task: regular task (default). SceneTestingTask: scenario-based testing task |

### Publishes a Registry template version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/publish-registry-module-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| moduleName | string | yes | The template name |
| namespaceName | string | yes | The workspace name |
| version | string | yes | The version number. The value must conform to the semantic version (http://semver.org/) specification, such as 1.0.1. The initial version… |

### Removes shared accounts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/remove-shared-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| resourceId | string | yes | The ID of the resource to be unshared. If the type is Namespace, the value is the workspace name. If the type is RegistryModule, the value… |
| resourceType | string | yes | The resource type. Valid values: RegistryModule: Registry template. Namespace: Workspace |
| accountIds | string | yes | The list of Alibaba Cloud account IDs (JSON-encoded) |

### Sets the encryption configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/set-encryption-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | no | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| kmsKeyId | string | no | The ID of the KMS key used for encryption |
| kmsRegionId | string | no | The region ID of the KMS key |

### Triggers the execution of a stack
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/trigger-stack-execution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| action | string | yes | The execution action. Valid values: terraform plan terraform apply state detect [_single.params.body.props.action.enum.terraform… |
| changedFolders | array | yes | The collection of changed files. You can specify only the directory of the changed files |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| codePackagePath | string | yes | The stack code path. Currently, only stacks created by using infrastructure as code (IaC) templates are supported. Parameter format:… |
| codeVersionId | string | no | The code version that triggers the stack |
| sourceTriggerId | string | no | The trigger ID of the source plan. This parameter can be specified only for terraform apply. This parameter is required when confirming a… |

### Updates the drift detection configuration information for the specified ID.
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-detect-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| alarmConfigs | array | no | Alert address list |
| clientToken | string | no | Idempotent token, format: [0-9a-zA-Z-]{1,64}. We recommend using a UUID. |
| cronExpression | string | no | Cron expression (UTC+8). Required when the trigger type is Cron. |
| description | string | no | Description |
| detectConfigName | string | no | Drift detection name |
| enabled | string | no | Whether the detection feature is enabled. The default value is true. |
| triggerType | string | no | Trigger type Manual: Execute manually Cron: Trigger periodically |
| detectConfigId | string | yes | Drift detection configuration ID |

### Updates an Explorer template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-explorer-module-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | no | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The template description. Length: 0 to 255 characters |
| name | string | no | The template name. Length: 1 to 128 characters. The name must be unique |
| explorerModuleId | string | yes | The Explorer template ID |

### Modifies a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| autoDestroy | string | no | Specifies whether to automatically delete the group |
| autoTrigger | string | no | Specifies whether to enable the automatic trigger policy. Valid values: - true: enabled. - false: disabled |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The group description |
| forcedSetting | string | no | Specifies whether to forcibly use the group configuration |
| name | string | no | The group name |
| notifyConfig | array | no | The notification configuration |
| notifyOperationTypes | array | no | The list of notification operation types |
| ramRole | string | no | The RAM role (1-128 characters). The system assumes this role to execute the template when a new job is triggered. This parameter is… |
| reportExportField | array | no | The list of export fields for the report |
| reportExportPath | string | no | The export path for the execution report. OSS paths are supported |
| terraformProviderVersion | string | no | The Terraform Provider version. Select a Terraform Provider version. Nodes in the group execute plans based on the specified Terraform… |
| triggerConfig | array | no | The trigger policy. This parameter cannot be empty when autoTrigger is set to true |
| triggerResourceType | array | no | The resource type that triggers execution. Valid values: Task: regular node. SceneTestingTask: scenario-based testing node |
| groupId | string | yes | The group ID |

### Updates the name, description, tags, and other information of a specified template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-module-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The template description. The description can be up to 256 characters in length |
| groupInfo | object | no | The project group information |
| name | string | no | The template name. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name can contain… |
| sourcePath | string | no | The path of the template source. If the source is Registry, set this parameter to / : . Example: terraform-alicloud-modules/rds:1.0.0. If… |
| statePath | string | no | The path of the state file that corresponds to the template. Currently, only OSS paths are supported. Set this parameter to oss::… |
| tags | array | no | The tags of the template |
| versionStrategy | string | no | The version generation strategy. Valid values: Manual: manually generate versions. This is the default value. SourcePathUpdated: a new… |
| moduleId | string | yes | The template ID |

### Updates the attributes of a specified parameter set, such as the name and description
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-parameter-set-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| description | string | no | The description of the parameter set. Maximum length: 1024 characters |
| name | string | yes | The name of the parameter set. Maximum length: 128 characters |
| parameters | array | no | The parameter list |
| parameterSetId | string | yes | The parameter set ID |

### Updates project information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The project description. Length: 0 to 1024 characters |
| name | string | no | The project name. Length: 1 to 128 characters |
| projectId | string | yes | The project ID |

### Updates a Registry template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-registry-module-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| acl | string | no | The access permission. Valid values: private: private |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The description of the Registry template |
| namespaceName | string | yes | The workspace name |
| moduleName | string | yes | The Registry template name |

### Modifies a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-registry-namespace-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| acl | string | no | The access permission. Valid values: private: private access |
| clientToken | string | yes | The idempotence token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The description of the workspace |
| namespaceName | string | yes | The name of the workspace. The name must meet the following requirements: The name must be 3 to 63 characters in length. The name can… |

### Modifies a resource export task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-resource-export-task-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The description of the task |
| exportToModule | object | no | Saves the exported template as a module. If this parameter is not set, the template is automatically saved in the registry |
| includeRules | array | no | The list of include rules used when exporting resources |
| name | string | no | The name of the resource export task. The name must meet the following requirements: The name must be 2 to 128 characters in length. The… |
| ramRole | string | no | The RAM role |
| terraformProviderVersion | string | no | The Terraform provider version. Call ListTerraformProviderVersions to view the supported versions. Default value: the latest version |
| terraformVersion | string | no | The Terraform version. Call ListAvailableTerraformVersions to view the supported versions. Default value: 1.5.7 |
| triggerStrategy | string | no | The trigger strategy. Valid values: Auto: triggered automatically when rules are modified or the trigger strategy is changed to Auto.… |
| variables | array | no | The list of variables. Sets exported resource parameters as variables |
| exportTaskId | string | yes | The ID of the resource export task |

### Modifies a stack. When the configuration changes, a stack deployment is triggered
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | no | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| description | string | no | The description of the stack |
| name | string | no | The name of the stack. The name must be 2 to 128 characters in length and can contain letters, digits, Chinese characters, hyphens (-),… |
| ramRole | string | no | The RAM role granted to the task. This role is used to automatically continue the execution of scheduled tasks during automatic triggering… |
| sourcePath | string | no | The path of the configuration source. The value can be up to 1,000 characters in length. If the source is OSS, set this parameter to oss::… |
| workingDirectory | string | no | The working directory where the configuration files are located. Enter / if the files are in the root directory. Example: config/ or / |
| stackId | string | yes | The stack ID. This is the unique identifier generated after the stack is created |

### Updates the attributes of a node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/update-task-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| taskId | string | yes | The node ID |
| autoApply | string | no | Specifies whether to automatically execute the node. Default value: false. true: After the preview is complete (terraform plan), the… |
| autoDestroy | string | no | Specifies whether to automatically destroy resources after creation. Default value: false. true: After the execution is complete… |
| clientToken | string | yes | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. Use a UUID |
| description | string | no | The description |
| groupInfo | object | no | The project group information |
| initModuleState | string | no | Specifies whether to use a state file. Default value: false. This parameter applies to templates that originate from resource export. Only… |
| moduleVersion | string | no | The template version |
| name | string | no | The node name. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name can contain… |
| protectionStrategy | array | no | The list of resource protection strategies |
| ramRole | string | no | The RAM role. The system assumes this role to execute the template when a new job is triggered. This parameter is required when the job… |
| skipPropertyValidation | string | no | Specifies whether to skip enumeration value validation. Default value: false |
| skipRegionValidation | string | no | Specifies whether to skip region validation. Valid values: true indicates skipping, false indicates not skipping |
| tags | array | no | The list of tags for the node |
| terraformProviderVersion | string | no | The Terraform Provider version. Use the ListTerraformProviderVersions API to query the list of supported versions |
| terraformVersion | string | no | The Terraform version. Use the ListAvailableTerraformVersions API to obtain the list of supported versions. Default value: 1.5.7 |
| triggerStrategy | string | no | The job trigger method. Manual: manual trigger (default). NewVersion: triggered when a new template version is published.… |

### Uploads a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/upload-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| resourceType | string | yes | The type of the resource. Valid values: Module RegistryModule |
| url | string | no | The local zip file to upload. The file size cannot exceed 10 MB |
| namespaceName | string | no | The workspace name. This parameter is valid and required when resourceType is set to RegistryModule |
| moduleName | string | no | The name of the module. This parameter is valid and required when resourceType is set to RegistryModule |
| moduleId | string | no | The module ID. This parameter is valid and required when resourceType is set to Module |
| code | object | no | The template content |

### Performs a dry run on a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/validate-module` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |
| clientToken | string | no | The idempotency token. Format: [0-9a-zA-Z-]{1,64}. We recommend that you use a UUID |
| code | string | no | The template text that is directly passed in when source is set to Upload |
| codeMap | object | no | Specifies multiple configuration files to pass in |
| source | string | no | The template source. Valid values: Upload: text upload |
| sourcePath | string | no | The source path |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://iac.cn-zhangjiakou.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/add-shared-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Iac Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-iacservice/add-shared-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Iac 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 Iac Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Iac Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-iacservice.

### What is the status of the Alibaba Cloud Iac Service API?
Needs your own provider key (bring your own key)