{"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-alikafkastreaming/check-sql-content":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_check_sql_content","summary":"Validates a specified Flink SQL statement","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName","SqlContent"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID"},"JobName":{"type":"string","description":"The compute job name"},"SqlContent":{"type":"string","description":"The Flink SQL statement to be validated"}}}}}},"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-alikafkastreaming/create-compute-instance":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_create_compute_instance","summary":"Creates a compute instance. This operation only completes the purchase phase. After the instance is created,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","PaidType"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"PaidType":{"type":"integer","description":"The billing method. Only 5 (pay-as-you-go) is supported"},"ResourceGroupId":{"type":"string","description":"The resource group 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-alikafkastreaming/create-compute-job":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_create_compute_job","summary":"Creates a Flink SQL job on a running compute instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName","CuLimit","CuReserved"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID"},"JobName":{"type":"string","description":"The compute job name"},"CuLimit":{"type":"number","description":"The CU limit for the job"},"CuReserved":{"type":"number","description":"The reserved CUs for the job. The reserved CUs must not exceed the CU limit"},"Remark":{"type":"string","description":"The job remarks"}}}}}},"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-alikafkastreaming/delete-compute-instance":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_delete_compute_instance","summary":"Deletes a compute instance that is in the pending deployment, stopped, or released state","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute 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-alikafkastreaming/delete-compute-job":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_delete_compute_job","summary":"Deletes a specified compute job. A successful request indicates that the deletion request has been accepted","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The ID of the compute instance, excluding the region name"},"JobName":{"type":"string","description":"The name of the compute job"}}}}}},"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-alikafkastreaming/get-compute-instance":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_get_compute_instance","summary":"Queries the details of a specified compute instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute 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-alikafkastreaming/get-compute-job":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_get_compute_job","summary":"Queries the details of a compute job in AlikafkaStreaming by specifying parameters in a parameter query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The ID of the compute instance"},"JobName":{"type":"string","description":"The name of the compute job"}}}}}},"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-alikafkastreaming/list-compute-instances-in-page":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_list_compute_instances_in_page","summary":"This topic describes how to call ListComputeInstances to perform a paging query of compute instances under…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceIds":{"type":"string","description":"The IDs of the compute instances (JSON-encoded)"},"CurrentPage":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group"}}}}}},"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-alikafkastreaming/list-compute-jobs":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_list_compute_jobs","summary":"Queries information about all jobs under a specified compute instance by using paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID"},"Search":{"type":"string","description":"The keyword used to search for jobs by name or remark"},"SortField":{"type":"string","enum":["createTime","cuReserved","cuLimit","cuUsed","status","jobName"],"description":"The sort field. Valid values: `createTime`, `cuReserved`, `cuLimit`, `cuUsed`, `status`, and `jobName`"},"SortDirection":{"type":"string","enum":["ASC","DESC"],"description":"The sort direction. The value is not case-sensitive. Valid values: `ASC` and `DESC`"},"NextToken":{"type":"string","description":"The pagination token. Do not specify this parameter in the first request. For subsequent requests, specify the `NextToken` value returned…"},"MaxResults":{"type":"integer","description":"The maximum number of jobs to return in the current request. Default value: 10. Maximum value: 1000. If you set this parameter to 0, the…"}}}}}},"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-alikafkastreaming/reopen-compute-instance":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_reopen_compute_instance","summary":"Reactivates a stopped pay-as-you-go compute instance. A successful response indicates that the reactivation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The ID of the compute instance"}}}}}},"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-alikafkastreaming/start-compute-instance":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_start_compute_instance","summary":"Configures the network and initiates the deployment for a compute instance in the pending deployment state","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","VpcId","VSwitchIds"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The ID of the instance"},"VpcId":{"type":"string","description":"The ID of the VPC where the instance is deployed"},"VSwitchIds":{"type":"string","description":"The list of vSwitch IDs (JSON-encoded)"},"InstanceName":{"type":"string","description":"The name of the compute instance"}}}}}},"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-alikafkastreaming/start-compute-job":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_start_compute_job","summary":"Starts, resumes, or tests a compute job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID"},"JobName":{"type":"string","description":"The name of the compute job"},"RecoveryMode":{"type":"string","description":"The recovery mode, such as savepoint or stateless"},"DraftSql":{"type":"string","description":"The Flink SQL draft, which must be a self-contained and complete DDL and DML statement"},"CuLimit":{"type":"number","description":"The maximum number of CUs for the job. You can enter an integer or a decimal"},"CuReserved":{"type":"number","description":"The number of reserved CUs for the job. You can enter an integer or a decimal. The number of reserved CUs cannot exceed the maximum number…"}}}}}},"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-alikafkastreaming/stop-compute-instance":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_stop_compute_instance","summary":"Stops a running pay-as-you-go compute instance. A successful response indicates that the stop request has…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The ID of the compute instance"}}}}}},"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-alikafkastreaming/stop-compute-job":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_stop_compute_job","summary":"Stops a compute job in the specified region and instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID, excluding the region name"},"JobName":{"type":"string","description":"The name of the compute job"}}}}}},"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-alikafkastreaming/update-compute-instance-name":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_update_compute_instance_name","summary":"Updates the name of a compute instance. The instance must be in the deployment preparation or running state","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","InstanceName"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The ID of the compute instance"},"InstanceName":{"type":"string","description":"The name of the compute instance"}}}}}},"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-alikafkastreaming/update-compute-job":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_update_compute_job","summary":"Modifies the remarks of a specified compute job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID"},"JobName":{"type":"string","description":"The name of the compute job"},"Remark":{"type":"string","description":"The job remarks"}}}}}},"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-alikafkastreaming/update-compute-job-cu":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_update_compute_job_cu","summary":"Modifies the CU limit and reserved CUs for a specified computing job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName","CuLimit","CuReserved"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The computing instance ID"},"JobName":{"type":"string","description":"The name of the computing job"},"CuLimit":{"type":"number","description":"The CU limit for the job"},"CuReserved":{"type":"number","description":"The reserved CUs for the job. The reserved CUs must not exceed the CU limit"}}}}}},"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-alikafkastreaming/update-compute-job-draft-sql":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_update_compute_job_draft_sql","summary":"Updates the Flink SQL draft saved for a specified compute job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RegionId","InstanceId","JobName","DraftSql"],"properties":{"RegionId":{"type":"string","description":"The region ID"},"InstanceId":{"type":"string","description":"The compute instance ID"},"JobName":{"type":"string","description":"The name of the compute job"},"DraftSql":{"type":"string","description":"The Flink SQL draft"}}}}}},"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-alikafkastreaming/version":{"post":{"operationId":"cloud_aliyun_alikafkastreaming_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"}}}}}}}