# Alibaba Cloud Realtime Compute Selling Console API

> Alibaba Cloud Realtime Compute Selling Console API on Apizie: 29 endpoints (Disables the Flink AI service, Converts a subscription instance to a hybrid billing instance, Converts a pay-as-you-go workspace to a subscription workspace, Converts a subscription instance to pay-as-you-go, …) 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-foasconsole/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Realtime Compute Selling Console (foasconsole, version 2021-10-28). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Disables the Flink AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/close-flink-ai-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |

### Converts a subscription instance to a hybrid billing instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/convert-hybrid-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceId | string | yes | The order instance ID |
| Region | string | yes | The region |
| ResourceSpec | string | yes | The maximum resource specifications available for the pay-as-you-go portion of hybrid billing (JSON-encoded) |

### Converts a pay-as-you-go workspace to a subscription workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/convert-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |
| PricingCycle | string | yes | The subscription cycle |
| Duration | integer | yes | The number of subscription cycles |
| IsAutoRenew | string | yes | Specifies whether to enable auto-renewal |
| NamespaceResourceSpecs | string | yes | The resource specifications for the namespace (JSON-encoded) |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon |
| PromotionCode | string | no | The coupon code |

### Converts a subscription instance to pay-as-you-go
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/convert-prepay-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |

### Creates a subscription or pay-as-you-go fully managed Flink workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceName | string | yes | The workspace name. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name… |
| ChargeType | string | yes | The billing method. Valid values: POST: pay-as-you-go. PRE: subscription |
| Region | string | yes | The region |
| VpcId | string | yes | The virtual private cloud (VPC) ID |
| VSwitchIds | string | yes | The list of vSwitch IDs (JSON-encoded) |
| ResourceSpec | string | no | The resource specifications. This parameter is required when ChargeType is set to PRE (JSON-encoded) |
| PricingCycle | string | no | The billing cycle of the subscription instance. Valid values: year: yearly. month: monthly. This parameter is required when ChargeType is… |
| Duration | integer | no | The subscription duration. This parameter is required when ChargeType is set to PRE |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Enabled. false: Disabled. This is the default value. This parameter does not… |
| Storage | string | yes | The storage parameters (JSON-encoded) |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon |
| PromotionCode | string | no | The coupon code |
| ResourceGroupId | string | no | The resource group ID |
| Extra | string | no | The extended field |
| ArchitectureType | string | no | The processor architecture |
| Ha | string | no | Specifies whether to use zone-disaster recovery resources |
| HaVSwitchIds | string | no | The list of vSwitch IDs in the secondary zone for zone-disaster recovery (JSON-encoded) |
| HaResourceSpec | string | no | The zone-disaster recovery resource specifications (JSON-encoded) |
| MonitorType | string | no | The type of the monitoring and alerting service. You can select ARMS or CloudMonitor |
| Tag | string | no | The list of tags. A maximum of 20 tags can be specified (JSON-encoded) |
| DefaultNamespaceResourceSpec | string | no | The default namespace resource configuration (JSON-encoded) |
| DefaultHaNamespaceResourceSpec | string | no | The default high-availability namespace resource configuration (JSON-encoded) |

### Creates a project namespace in a fully managed Flink instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/create-namespace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |
| Namespace | string | yes | The namespace name |
| ResourceSpec | string | no | The resource specifications (JSON-encoded) |
| Ha | string | no | Specifies whether to enable zone-disaster recovery high availability |

### Releases a pay-as-you-go Realtime Compute for Apache Flink workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |
| Namespace | string | yes | The namespace name |

### Queries the details of one or more fully managed Flink workspaces
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| PageIndex | integer | no | The current page number |
| PageSize | integer | no | The number of rows per page for paging queries. The maximum value is 100. Default value: 10 |
| InstanceId | string | no | The order instance ID |
| Region | string | yes | The region ID |
| ChargeType | string | no | The billing method. Valid values: PRE: subscription POST: pay-as-you-go |
| Elastic | string | no | Specifies whether hybrid billing is used |
| Tags | string | no | The tags of the instance (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| ArchitectureType | string | no | The processor architecture. Valid values: X86 and ARM |
| InstanceName | string | no | The instance name |
| NamespaceName | string | no | The namespace name |

### Queries the namespace information of an instance by calling DescribeNamespaces
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/describe-namespaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |
| Namespace | string | no | The namespace name |
| Tags | string | no | The list of tags (JSON-encoded) |
| PageIndex | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| Ha | string | no | Specifies whether zone-disaster recovery is enabled |

### Retrieves information about regions that support purchases of fully managed Flink
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/describe-supported-regions` (byok)

### Retrieves information about zones that are available for purchase
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/describe-supported-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | no | The region ID |
| ArchitectureType | string | no | The processor architecture |

### Retrieves the status of the Flink AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/get-flink-ai-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |

### Retrieves the free quota usage of Flink AI services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/get-flink-ai-service-free-quota` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |

### Queries resource tags. You can query tag keys by tag values, query tag values by tag keys, or retrieve all…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NextToken | string | no | The token for the next query |
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type. Set the value to vvpinstance |
| ResourceId | string | no | The order instance IDs (JSON-encoded) |
| Tag | string | no | The tag list. A maximum of 20 items are supported (JSON-encoded) |

### Updates the shutdown protection for the Flink AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/modify-ai-service-protection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID. It must match the region where the API endpoint is deployed. Currently, only cn-beijing is supported |
| DeletionProtection | string | yes | Specifies whether to enable manual shutdown protection |

### Modifies the maximum pay-as-you-go resource limit for a hybrid billing instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/modify-elastic-resource-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |
| InstanceId | string | yes | The order instance ID |
| ResourceSpec | string | yes | The maximum pay-as-you-go resource specifications (JSON-encoded) |

### Scales up or scales down the resources of a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/modify-instance-spec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |
| InstanceId | string | yes | The order instance ID |
| ResourceSpec | string | yes | The resource specifications (JSON-encoded) |
| Ha | string | no | Specifies whether the workspace has zone-disaster recovery resources |
| HaVSwitchIds | string | no | The vSwitch group in the secondary zone for zone-disaster recovery (JSON-encoded) |
| HaResourceSpec | string | no | The zone-disaster recovery resource specifications (JSON-encoded) |
| UsePromotionCode | string | no | The UsePromotionCode |
| PromotionCode | string | no | The PromotionCode |

### Modifies the resource configurations of a project namespace in a pay-as-you-go, subscription, or hybrid…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/modify-namespace-spec-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |
| Namespace | string | yes | The project namespace name |
| GuaranteedResourceSpec | string | no | The size of subscription resources allocated to the project namespace (JSON-encoded) |
| ElasticResourceSpec | string | no | The upper limit of pay-as-you-go resources allocated to the project namespace (JSON-encoded) |
| Ha | string | yes | Specifies whether the project namespace uses zone-disaster recovery |

### Activates the Flink AI service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/open-flink-ai-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |

### Queries the price for converting a pay-as-you-go instance to a subscription instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/query-convert-instance-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The instance ID of the order |
| PricingCycle | string | yes | The subscription cycle. Valid values: Year and Month |
| Duration | integer | yes | The number of subscription cycles |
| IsAutoRenew | string | yes | Specifies whether to enable auto-renewal |
| NamespaceResourceSpecs | string | yes | The resource specifications of the project namespace (JSON-encoded) |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true (use a coupon) and false (do not use a coupon) |
| PromotionCode | string | no | The coupon code |

### Queries the estimated refund amount after your Flink instance is switched from subscription to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/query-convert-prepay-instance-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region |
| InstanceId | string | yes | The order instance ID |

### Retrieves the pricing for purchasing a workspace under the current account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/query-create-instance-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| InstanceName | string | no | The name of the workspace |
| ChargeType | string | yes | The billing method. Valid values: POST: pay-as-you-go PRE: subscription |
| Region | string | yes | The region |
| VpcId | string | no | The VPC ID |
| VSwitchIds | string | no | The vSwitch IDs (JSON-encoded) |
| ResourceSpec | string | no | The resource specifications (JSON-encoded) |
| PricingCycle | string | no | The billing cycle. Subscription instances support only yearly (Year) and monthly (Month) billing. For pay-as-you-go instances, select… |
| Duration | integer | no | The number of billing cycles. If ChargeType is set to PRE, the Duration parameter is required |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Enables auto-renewal. false: Disables auto-renewal (default). This parameter… |
| Storage | string | no | The storage information (JSON-encoded) |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true: Uses a coupon. false: Does not use a coupon |
| PromotionCode | string | no | The coupon code |
| Extra | string | no | The extended reserved field |
| ArchitectureType | string | no | The processor architecture |
| Ha | string | no | Specifies whether to select multi-zone high-availability resources |
| HaResourceSpec | string | no | The description of multi-zone high-availability resources (JSON-encoded) |

### Queries the price for upgrading or downgrading an instance specification
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/query-modify-instance-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |
| InstanceId | string | yes | The order instance ID |
| ResourceSpec | string | yes | The resource specifications (JSON-encoded) |
| Ha | string | no | Specifies whether to use zone-disaster recovery resources |
| HaVSwitchIds | string | no | The vSwitch group for the secondary zone in zone-disaster recovery (JSON-encoded) |
| HaResourceSpec | string | no | The resource description for zone-disaster recovery (JSON-encoded) |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon |
| PromotionCode | string | no | The coupon code |

### Queries the renewal price for a subscription workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/query-renew-instance-price` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Duration | integer | yes | The number of subscription cycles |
| PricingCycle | string | yes | The subscription cycle. Valid values: Month: month Year: year Hour: hour Day: day |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon |
| PromotionCode | string | no | The coupon code |

### Renews a subscription Flink fully managed workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/renew-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Region | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Duration | integer | yes | The number of subscription cycles |
| PricingCycle | string | yes | The subscription cycle. Valid values: Month: month Year: year Hour: hour Day: day |
| UsePromotionCode | string | no | Specifies whether to use a coupon. Valid values: true: yes. false: no |
| PromotionCode | string | no | The coupon code |

### Call this API to add tags to resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | Region |
| ResourceType | string | yes | Resource type. Set this parameter to vvpinstance |
| ResourceId | string | yes | List of order instance IDs (JSON-encoded) |
| Tag | string | yes | List of tags. You can specify up to 20 tags (JSON-encoded) |

### Deletes resource tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RegionId | string | yes | The region ID |
| ResourceType | string | yes | The resource type. Set this parameter to vvpinstance |
| All | string | no | Specifies whether to delete all resource tags. This parameter is valid only when TagKey is empty. Default value: false |
| ResourceId | string | yes | The list of order instance IDs (JSON-encoded) |
| TagKey | string | no | The list of tag keys. Maximum: 20 subkeys (JSON-encoded) |

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

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/close-flink-ai-service" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Realtime Compute Selling Console API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-foasconsole/close-flink-ai-service with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Realtime Compute Selling Console API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Realtime Compute Selling Console itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Realtime Compute Selling Console 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-foasconsole.

### What is the status of the Alibaba Cloud Realtime Compute Selling Console API?
Needs your own provider key (bring your own key)