计费说明
通过通用计算 API,您只需少量代码即可快速操作通用计算产品。为方便您快速轻松调用云 API 来管理通用计算资源,云 API 提供了 API Explorer、命令行工具 、SDK、云 API 平台等工具。
通用计算 API 目前为1.0 版本。简明的 API 接口文档更加规范和全面,统一的参数风格和公共错误码,统一的 SDK/CLI 版本与 API 文档严格一致,给您带来简单快捷的使用体验。支持全地域就近接入让您更快连接通用计算产品。
欢迎使用通用计算通用计算平台。
通用计算通用计算平台(Argon Universal Media Computing Cloud,以下简称 通用计算)运行在公有云和私有云的混合架构当中,它提供了可以灵活便捷的弹性伸缩的媒体计算服务,可以根据业务需要来灵活定制处理流程。
用户可以使用本文档介绍的 API,并参照相应的示例,对通用计算进行相关操作:如创建任务和工作流等;支持的全部操作可参见 API 概览。
请确保在使用这些接口前,已充分了解了 通用计算 概述。
输入参数与返回参数释义¶
- Limit 和 Offset
提示
用来控制分页的参数;Limit 为单次返回的最多条目数量,Offset 为偏移量。当相应结果是列表形式时,如果数量超过了 Limit 所限定的值,那么只返回 Limit 个值。
举例来说,参数 Offset=0&Limit=20 返回第 0 到 19 项,Offset=20&Limit=20 返回第 20 到 39 项,Offset=40&Limit=20 返回第 40 到 59 项;以此类推。
通信协议¶
通用计算 API 的所有接口均可通过 HTTPS 进行通信,提供高安全性的通信通道。除此之外,还可以通过gRPC的方式进行调用。
请求方法¶
支持通用的 HTTP 请求方法,请求方法的使用遵循 RESETfull规则。请求支持的 Content-Type 类型:
- application/json(推荐)
- application/x-www-form-urlencoded
- multipart/form-data(仅部分接口支持)
字符编码¶
均使用UTF-8编码。
授权口令¶
因为大部分接口需要进行用户权限认证,需要将用户认证接口获取的登录令牌以 HTTP Header X-Auth-Token
字段的方式传入到相应的接口。示例如下
X-Auth-Token:eyJhbGciOiJIUzI1N************************************eyJ1aWQiOiJ
API 快速入门¶
这里针对几个典型的使用场景对 通用计算 API 的使用方式进行说明:
通过使用 创建任务 API,提供工作流 ID、任务的输入参数和任务配置参数等一些必要的信息,即可立刻创建一个异步计算任务。
如需对任务状态进行控制,例如中止和暂停任务,可以使用 任务控制 API 调整任务的执行状态。通过调整实例的机型来实现CPU和内存的变更。
如需删除任务,可以使用 删除任务 API。