{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-foasconsole/close-flink-ai-service":{"post":{"operationId":"cloud_aliyun_foasconsole_close_flink_ai_service","summary":"Disables the Flink AI service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"Region":{"type":"string","description":"The region ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/convert-hybrid-instance":{"post":{"operationId":"cloud_aliyun_foasconsole_convert_hybrid_instance","summary":"Converts a subscription instance to a hybrid billing instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","Region","ResourceSpec"],"properties":{"InstanceId":{"type":"string","description":"The order instance ID"},"Region":{"type":"string","description":"The region"},"ResourceSpec":{"type":"string","description":"The maximum resource specifications available for the pay-as-you-go portion of hybrid billing (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/convert-instance":{"post":{"operationId":"cloud_aliyun_foasconsole_convert_instance","summary":"Converts a pay-as-you-go workspace to a subscription workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","PricingCycle","Duration","IsAutoRenew","NamespaceResourceSpecs"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"},"PricingCycle":{"type":"string","description":"The subscription cycle"},"Duration":{"type":"integer","description":"The number of subscription cycles"},"IsAutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal"},"NamespaceResourceSpecs":{"type":"string","description":"The resource specifications for the namespace (JSON-encoded)"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon"},"PromotionCode":{"type":"string","description":"The coupon code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/convert-prepay-instance":{"post":{"operationId":"cloud_aliyun_foasconsole_convert_prepay_instance","summary":"Converts a subscription instance to pay-as-you-go","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/create-instance":{"post":{"operationId":"cloud_aliyun_foasconsole_create_instance","summary":"Creates a subscription or pay-as-you-go fully managed Flink workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceName","ChargeType","Region","VpcId","VSwitchIds","Storage"],"properties":{"InstanceName":{"type":"string","description":"The workspace name. The name must start with a lowercase letter and can contain lowercase letters, digits, and hyphens (-). The name…"},"ChargeType":{"type":"string","enum":["PRE","POST"],"description":"The billing method. Valid values: POST: pay-as-you-go. PRE: subscription"},"Region":{"type":"string","description":"The region"},"VpcId":{"type":"string","description":"The virtual private cloud (VPC) ID"},"VSwitchIds":{"type":"string","description":"The list of vSwitch IDs (JSON-encoded)"},"ResourceSpec":{"type":"string","description":"The resource specifications. This parameter is required when ChargeType is set to PRE (JSON-encoded)"},"PricingCycle":{"type":"string","enum":["Year","Month","Day","Hour"],"description":"The billing cycle of the subscription instance. Valid values: year: yearly. month: monthly. This parameter is required when ChargeType is…"},"Duration":{"type":"integer","description":"The subscription duration. This parameter is required when ChargeType is set to PRE"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal. Valid values: true: Enabled. false: Disabled. This is the default value. This parameter does not…"},"Storage":{"type":"string","description":"The storage parameters (JSON-encoded)"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon"},"PromotionCode":{"type":"string","description":"The coupon code"},"ResourceGroupId":{"type":"string","description":"The resource group ID"},"Extra":{"type":"string","description":"The extended field"},"ArchitectureType":{"type":"string","description":"The processor architecture"},"Ha":{"type":"string","description":"Specifies whether to use zone-disaster recovery resources"},"HaVSwitchIds":{"type":"string","description":"The list of vSwitch IDs in the secondary zone for zone-disaster recovery (JSON-encoded)"},"HaResourceSpec":{"type":"string","description":"The zone-disaster recovery resource specifications (JSON-encoded)"},"MonitorType":{"type":"string","description":"The type of the monitoring and alerting service. You can select ARMS or CloudMonitor"},"Tag":{"type":"string","description":"The list of tags. A maximum of 20 tags can be specified (JSON-encoded)"},"DefaultNamespaceResourceSpec":{"type":"string","description":"The default namespace resource configuration (JSON-encoded)"},"DefaultHaNamespaceResourceSpec":{"type":"string","description":"The default high-availability namespace resource configuration (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/create-namespace":{"post":{"operationId":"cloud_aliyun_foasconsole_create_namespace","summary":"Creates a project namespace in a fully managed Flink instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","Namespace"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"},"Namespace":{"type":"string","description":"The namespace name"},"ResourceSpec":{"type":"string","description":"The resource specifications (JSON-encoded)"},"Ha":{"type":"string","description":"Specifies whether to enable zone-disaster recovery high availability"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/delete-instance":{"post":{"operationId":"cloud_aliyun_foasconsole_delete_instance","summary":"Releases a pay-as-you-go Realtime Compute for Apache Flink workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/delete-namespace":{"post":{"operationId":"cloud_aliyun_foasconsole_delete_namespace","summary":"Deletes a project workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","Namespace"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"},"Namespace":{"type":"string","description":"The namespace name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/describe-instances":{"post":{"operationId":"cloud_aliyun_foasconsole_describe_instances","summary":"Queries the details of one or more fully managed Flink workspaces","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"PageIndex":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of rows per page for paging queries. The maximum value is 100. Default value: 10"},"InstanceId":{"type":"string","description":"The order instance ID"},"Region":{"type":"string","description":"The region ID"},"ChargeType":{"type":"string","enum":["PRE","POST"],"description":"The billing method. Valid values: PRE: subscription POST: pay-as-you-go"},"Elastic":{"type":"string","description":"Specifies whether hybrid billing is used"},"Tags":{"type":"string","description":"The tags of the instance (JSON-encoded)"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group to which the instance belongs"},"ArchitectureType":{"type":"string","description":"The processor architecture. Valid values: X86 and ARM"},"InstanceName":{"type":"string","description":"The instance name"},"NamespaceName":{"type":"string","description":"The namespace name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/describe-namespaces":{"post":{"operationId":"cloud_aliyun_foasconsole_describe_namespaces","summary":"Queries the namespace information of an instance by calling DescribeNamespaces","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"},"Namespace":{"type":"string","description":"The namespace name"},"Tags":{"type":"string","description":"The list of tags (JSON-encoded)"},"PageIndex":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"Ha":{"type":"string","description":"Specifies whether zone-disaster recovery is enabled"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/describe-supported-regions":{"post":{"operationId":"cloud_aliyun_foasconsole_describe_supported_regions","summary":"Retrieves information about regions that support purchases of fully managed Flink","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/describe-supported-zones":{"post":{"operationId":"cloud_aliyun_foasconsole_describe_supported_zones","summary":"Retrieves information about zones that are available for purchase","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Region":{"type":"string","description":"The region ID"},"ArchitectureType":{"type":"string","description":"The processor architecture"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/get-flink-ai-service":{"post":{"operationId":"cloud_aliyun_foasconsole_get_flink_ai_service","summary":"Retrieves the status of the Flink AI service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"Region":{"type":"string","description":"The region ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/get-flink-ai-service-free-quota":{"post":{"operationId":"cloud_aliyun_foasconsole_get_flink_ai_service_free_quota","summary":"Retrieves the free quota usage of Flink AI services","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"Region":{"type":"string","description":"The region ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/list-tag-resources":{"post":{"operationId":"cloud_aliyun_foasconsole_list_tag_resources","summary":"Queries resource tags. You can query tag keys by tag values, query tag values by tag keys, or retrieve all…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceType"],"properties":{"NextToken":{"type":"string","description":"The token for the next query"},"RegionId":{"type":"string","description":"The region ID"},"ResourceType":{"type":"string","description":"The resource type. Set the value to vvpinstance"},"ResourceId":{"type":"string","description":"The order instance IDs (JSON-encoded)"},"Tag":{"type":"string","description":"The tag list. A maximum of 20 items are supported (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/modify-ai-service-protection":{"post":{"operationId":"cloud_aliyun_foasconsole_modify_ai_service_protection","summary":"Updates the shutdown protection for the Flink AI service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","DeletionProtection"],"properties":{"Region":{"type":"string","description":"The region ID. It must match the region where the API endpoint is deployed. Currently, only cn-beijing is supported"},"DeletionProtection":{"type":"string","description":"Specifies whether to enable manual shutdown protection"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/modify-elastic-resource-spec":{"post":{"operationId":"cloud_aliyun_foasconsole_modify_elastic_resource_spec","summary":"Modifies the maximum pay-as-you-go resource limit for a hybrid billing instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","ResourceSpec"],"properties":{"Region":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The order instance ID"},"ResourceSpec":{"type":"string","description":"The maximum pay-as-you-go resource specifications (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/modify-instance-spec":{"post":{"operationId":"cloud_aliyun_foasconsole_modify_instance_spec","summary":"Scales up or scales down the resources of a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","ResourceSpec"],"properties":{"Region":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The order instance ID"},"ResourceSpec":{"type":"string","description":"The resource specifications (JSON-encoded)"},"Ha":{"type":"string","description":"Specifies whether the workspace has zone-disaster recovery resources"},"HaVSwitchIds":{"type":"string","description":"The vSwitch group in the secondary zone for zone-disaster recovery (JSON-encoded)"},"HaResourceSpec":{"type":"string","description":"The zone-disaster recovery resource specifications (JSON-encoded)"},"UsePromotionCode":{"type":"string","description":"The UsePromotionCode"},"PromotionCode":{"type":"string","description":"The PromotionCode"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/modify-namespace-spec-v2":{"post":{"operationId":"cloud_aliyun_foasconsole_modify_namespace_spec_v2","summary":"Modifies the resource configurations of a project namespace in a pay-as-you-go, subscription, or hybrid…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","Namespace","Ha"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"},"Namespace":{"type":"string","description":"The project namespace name"},"GuaranteedResourceSpec":{"type":"string","description":"The size of subscription resources allocated to the project namespace (JSON-encoded)"},"ElasticResourceSpec":{"type":"string","description":"The upper limit of pay-as-you-go resources allocated to the project namespace (JSON-encoded)"},"Ha":{"type":"string","description":"Specifies whether the project namespace uses zone-disaster recovery"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/open-flink-ai-service":{"post":{"operationId":"cloud_aliyun_foasconsole_open_flink_ai_service","summary":"Activates the Flink AI service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region"],"properties":{"Region":{"type":"string","description":"The region ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/query-convert-instance-price":{"post":{"operationId":"cloud_aliyun_foasconsole_query_convert_instance_price","summary":"Queries the price for converting a pay-as-you-go instance to a subscription instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","PricingCycle","Duration","IsAutoRenew","NamespaceResourceSpecs"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The instance ID of the order"},"PricingCycle":{"type":"string","description":"The subscription cycle. Valid values: Year and Month"},"Duration":{"type":"integer","description":"The number of subscription cycles"},"IsAutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal"},"NamespaceResourceSpecs":{"type":"string","description":"The resource specifications of the project namespace (JSON-encoded)"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true (use a coupon) and false (do not use a coupon)"},"PromotionCode":{"type":"string","description":"The coupon code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/query-convert-prepay-instance-price":{"post":{"operationId":"cloud_aliyun_foasconsole_query_convert_prepay_instance_price","summary":"Queries the estimated refund amount after your Flink instance is switched from subscription to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId"],"properties":{"Region":{"type":"string","description":"The region"},"InstanceId":{"type":"string","description":"The order instance ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/query-create-instance-price":{"post":{"operationId":"cloud_aliyun_foasconsole_query_create_instance_price","summary":"Retrieves the pricing for purchasing a workspace under the current account","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChargeType","Region"],"properties":{"InstanceName":{"type":"string","description":"The name of the workspace"},"ChargeType":{"type":"string","enum":["PRE","POST"],"description":"The billing method. Valid values: POST: pay-as-you-go PRE: subscription"},"Region":{"type":"string","description":"The region"},"VpcId":{"type":"string","description":"The VPC ID"},"VSwitchIds":{"type":"string","description":"The vSwitch IDs (JSON-encoded)"},"ResourceSpec":{"type":"string","description":"The resource specifications (JSON-encoded)"},"PricingCycle":{"type":"string","enum":["Year","Month","Day","Hour"],"description":"The billing cycle. Subscription instances support only yearly (Year) and monthly (Month) billing. For pay-as-you-go instances, select…"},"Duration":{"type":"integer","description":"The number of billing cycles. If ChargeType is set to PRE, the Duration parameter is required"},"AutoRenew":{"type":"string","description":"Specifies whether to enable auto-renewal. Valid values: true: Enables auto-renewal. false: Disables auto-renewal (default). This parameter…"},"Storage":{"type":"string","description":"The storage information (JSON-encoded)"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true: Uses a coupon. false: Does not use a coupon"},"PromotionCode":{"type":"string","description":"The coupon code"},"Extra":{"type":"string","description":"The extended reserved field"},"ArchitectureType":{"type":"string","description":"The processor architecture"},"Ha":{"type":"string","description":"Specifies whether to select multi-zone high-availability resources"},"HaResourceSpec":{"type":"string","description":"The description of multi-zone high-availability resources (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/query-modify-instance-price":{"post":{"operationId":"cloud_aliyun_foasconsole_query_modify_instance_price","summary":"Queries the price for upgrading or downgrading an instance specification","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","ResourceSpec"],"properties":{"Region":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The order instance ID"},"ResourceSpec":{"type":"string","description":"The resource specifications (JSON-encoded)"},"Ha":{"type":"string","description":"Specifies whether to use zone-disaster recovery resources"},"HaVSwitchIds":{"type":"string","description":"The vSwitch group for the secondary zone in zone-disaster recovery (JSON-encoded)"},"HaResourceSpec":{"type":"string","description":"The resource description for zone-disaster recovery (JSON-encoded)"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon"},"PromotionCode":{"type":"string","description":"The coupon code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/query-renew-instance-price":{"post":{"operationId":"cloud_aliyun_foasconsole_query_renew_instance_price","summary":"Queries the renewal price for a subscription workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","Duration","PricingCycle"],"properties":{"Region":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The instance ID"},"Duration":{"type":"integer","description":"The number of subscription cycles"},"PricingCycle":{"type":"string","enum":["Year","Month","Day","Hour"],"description":"The subscription cycle. Valid values: Month: month Year: year Hour: hour Day: day"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true: Use a coupon. false: Do not use a coupon"},"PromotionCode":{"type":"string","description":"The coupon code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/renew-instance":{"post":{"operationId":"cloud_aliyun_foasconsole_renew_instance","summary":"Renews a subscription Flink fully managed workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Region","InstanceId","Duration","PricingCycle"],"properties":{"Region":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The instance ID"},"Duration":{"type":"integer","description":"The number of subscription cycles"},"PricingCycle":{"type":"string","enum":["Year","Month","Day","Hour"],"description":"The subscription cycle. Valid values: Month: month Year: year Hour: hour Day: day"},"UsePromotionCode":{"type":"string","description":"Specifies whether to use a coupon. Valid values: true: yes. false: no"},"PromotionCode":{"type":"string","description":"The coupon code"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/tag-resources":{"post":{"operationId":"cloud_aliyun_foasconsole_tag_resources","summary":"Call this API to add tags to resources","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceType","ResourceId","Tag"],"properties":{"RegionId":{"type":"string","description":"Region"},"ResourceType":{"type":"string","description":"Resource type. Set this parameter to vvpinstance"},"ResourceId":{"type":"string","description":"List of order instance IDs (JSON-encoded)"},"Tag":{"type":"string","description":"List of tags. You can specify up to 20 tags (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/untag-resources":{"post":{"operationId":"cloud_aliyun_foasconsole_untag_resources","summary":"Deletes resource tags","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","ResourceType","ResourceId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"ResourceType":{"type":"string","description":"The resource type. Set this parameter to vvpinstance"},"All":{"type":"string","description":"Specifies whether to delete all resource tags. This parameter is valid only when TagKey is empty. Default value: false"},"ResourceId":{"type":"string","description":"The list of order instance IDs (JSON-encoded)"},"TagKey":{"type":"string","description":"The list of tag keys. Maximum: 20 subkeys (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-foasconsole/version":{"post":{"operationId":"cloud_aliyun_foasconsole_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}