文档

API概览

更新时间:
本产品(实时计算售卖控制台/2021-10-28)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

工作空间

API标题API概述
ModifyPrepayInstanceSpec修改工作空间计算资源修改包年包月的flink全托管实例计算资源的规格大小,调整后规格小于当前使用规格将进行缩容操作,调整后规格大于当前使用规格将进行扩容操作。
QueryConvertInstancePrice查询按量付费转包年包月价格您可以通过本API来查询按量付费实例转包年包月价格。
QueryCreateInstancePrice查询工作空间价格获取本账号购买工作空间的价格。
QueryModifyInstancePrice查询变配价格您可以查询实例升降配时的价格。
QueryRenewInstancePrice查询工作空间续费价格您可以查询续费一个包年包月工作空间的价格。
DescribeSupportedZones获取Flink全托管支持的可用区您可以获取支持购买的可用区信息。
DescribeSupportedRegions获取Flink全托管支持购买的地域您可以获取支持购买的地域信息。
CreateInstance创建flink全托管工作空间创建一个包年包月或者按量付费flink全托管工作空间。
RenewInstance续费flink全托管工作空间续费一个包年包月flink全托管工作空间。
DescribeInstances查看已购买Flink全托管工作空间查询一个或多个flink全托管工作空间的详细信息。
DeleteInstance释放按量付费Flink全托管工作空间释放按量付费的flink全托管工作空间。
ConvertInstance按量付费转包年包月您可以将按量付费的工作空间转换为包年包月的工作空间。

项目空间

API标题API概述
DescribeNamespaces查看项目空间详情您可以调用DescribeNamespaces查询某实例下的项目空间信息。
ModifyPrepayNamespaceSpec修改项目空间资源修改包年包月实例下项目空间的规格。
DeleteNamespace删除项目空间删除项目空间。
CreateNamespace创建项目空间在flink全托管实例中下创建项目空间。

资源标签

API标题API概述
ListTagResources查看Flink全托管工作空间标签列表您可以调用ListTagResources查询资源标签。您可以通过标签的value查询key值,或者通过key值查询value,也可以获取您在flink全托管工作空间上使用的所有标签信息。
TagResources创建资源标签您可以调用本API创建资源标签。
TagResources创建资源标签您可以调用本API创建资源标签。
UntagResources删除资源标签您可以调用UntagResources删除资源标签。