API标准及多语言预置SDK
本产品（foasconsole/2021-10-28）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
工作空间
|
API |
标题 |
API概述 |
| ModifyInstanceSpec | 修改工作空间资源 | 调用本API可对工作空间进行扩容或缩容操作。 |
| ModifyElasticResourceSpec | 修改混合计费实例按量上限 | 对混合计费的实例，可修改按量部分最大可使用的上限资源。 |
| ConvertHybridInstance | 开通混合计费 | 调用本API可将现在包年包月的实例变更为混合计费的实例。 |
| QueryConvertPrepayInstancePrice | 查询包年包月转按量付费价格 | 调用本API可以查看您的Flink实例从包年包月模式转为按量付费模式后，预计退款的金额，转为按量付费后将按小时计量您的使用情况并产生账单。 |
| 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概述 |
| ModifyNamespaceSpecV2 | 修改项目空间的资源配置 | 修改按量和包年包月、混合计费工作空间下项目空间的资源配置。 |
| DescribeNamespaces | 查看项目空间详情 | 您可以调用DescribeNamespaces查询某实例下的项目空间信息。 |
| ModifyPrepayNamespaceSpec | 修改项目空间资源 | 修改包年包月实例下项目空间的规格。 |
| DeleteNamespace | 删除项目空间 | 删除项目空间。 |
| CreateNamespace | 创建项目空间 | 在flink全托管实例中下创建项目空间。 |
资源标签
|
API |
标题 |
API概述 |
| ListTagResources | 查看Flink全托管工作空间标签列表 | 您可以调用ListTagResources查询资源标签。您可以通过标签的value查询key值，或者通过key值查询value，也可以获取您在flink全托管工作空间上使用的所有标签信息。 |
| TagResources | 创建资源标签 | 您可以调用本API创建资源标签。 |
| UntagResources | 删除资源标签 | 您可以调用UntagResources删除资源标签。 |
其他
|
API |
标题 |
API概述 |
| ConvertPrepayInstance | 包年包月转按量付费 | 调用本API可将您包年包月的实例转化为按量付费。 |
| ModifyInstanceVswitch | 修改实例的交换机 | 修改Flink工作空间可使用的虚拟交换机。 |
该文章对您有帮助吗？