API Overview
CS provides self-developed APIs. You can call the CS APIs listed in the following table to perform related functions.
| Type | API | Description |
|---|---|---|
| APIs related to job management | Registers with the cloud platform to use CS. | |
| Grants CS the permission to access OBS buckets for saving job checkpoints and run logs. | ||
| Collects summary statistics on users' jobs and prices. | ||
| Queries the current release version of CS | ||
| Uses the POST method to submit a stream SQL job in JSON format. | ||
| Updates a SQL job. | ||
| Creates user-defined jobs, which currently support the JAR format and run in exclusive clusters. | ||
| Updates a user-defined job. | ||
| Runs a specified job. | ||
| Runs specified jobs in batches. | ||
| Queries the list of jobs. | ||
| Queries details about a specified job. | ||
| Queries the execution plan of a specified job. | ||
| Queries the audit logs of a specified job. | ||
| Queries job monitoring information. You can query monitoring information about multiple jobs at the same time. | ||
| Queries the APIG address of a job. | ||
| Stops a specified job. | ||
| Stops specified jobs in batches. | ||
| Deletes a specified job. | ||
| Deletes specified jobs in batches. | ||
| APIs related to job template management | Adds a custom template. | |
| Updates a specified template. | ||
| Deletes a specified template. | ||
| Queries the list of job templates. Currently, only custom templates can be queried. | ||
| APIs related to cluster management | Creates an exclusive cluster. | |
| Queries information about exclusive clusters. | ||
| Deletes an exclusive cluster. | ||
| Queries the cluster list of a tenant. | ||
| Updates an exclusive cluster. | ||
| Terminates an exclusive cluster. | ||
| Restarts an exclusive cluster. | ||
| Queries the list of jobs running in an exclusive cluster. | ||
| Adds an IP-domain mapping for a specified cluster. | ||
| Updates a specified IP-domain mapping. | ||
| Queries information about the IP-domain mapping in a specified cluster. | ||
| Deletes the IP-domain mapping. | ||
| Adds an IP-domain mapping for a specified cluster through file uploading. The hosts_file parameter is involved in this API, and the parameter must be in the "form-data" format. | ||
| Obtains user quota information about a tenant. | ||
| Queries quota information about a specified user. | ||
| Updates quota information about a specified user. | ||
| Creates a VPC peering connection used to connect to other VPCs. | ||
| Queries the list of VPC peering connections. | ||
| Queries a specified VPC peering connection. | ||
| Deletes a specified VPC peering connection. | ||
| Accepts a VPC peering connection request. | ||
| Creates a route to the local end of a VPC peering connection. | ||
| Creates a route to the peer end of a VPC peering connection. | ||
| Queries the list of routes of a VPC peering connection. | ||
| Deletes a specific route. |
Last Article: Concepts
Next Article: Calling APIs
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.