API标准及多语言预置SDK
本产品（APIG/2024-03-27）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
API管理
|
API |
标题 |
API概述 |
| ExportHttpApi | 导出HTTP API | 导出指定的HTTP API。 |
| ImportHttpApi | 导入HTTP API | 导入HTTP API，支持将OpenAPI 2.0和 OpenAPI 3.0.x版本的定义文件导入为REST类型的API。 |
| DeployHttpApi | 发布API | 发布HTTP API。包括Rest API 和HTTP API里的路由。 |
| CreateHttpApi | 创建HTTP API | 创建一个HTTP类型的API。 |
| UpdateHttpApi | 更新HTTP API | 更新HTTP API。 |
| GetHttpApi | 获取HTTP API | 读取HTTP API信息。 |
| ListHttpApis | 获取HTTP API列表 | 获取HTTP API列表。 |
| UndeployHttpApi | 下线API | 取消部署HttpApi。 |
| DeleteHttpApi | 删除HTTP API | 删除指定的HTTP API。 |
接口管理
|
API |
标题 |
API概述 |
| CreateHttpApiOperation | 创建接口 | 为HTTP API创建接口。 |
| GetHttpApiOperation | 获取接口信息 | 获取接口信息。 |
| UpdateHttpApiOperation | 更新接口 | 更新接口。 |
| ListHttpApiOperations | 获取接口列表 | 获取接口列表。 |
| DeleteHttpApiOperation | 删除接口 | 删除指定的接口。 |
路由管理
|
API |
标题 |
API概述 |
| CreateHttpApiRoute | 创建HTTP API路由 | 创建HttpApi的路由。 |
| UpdateHttpApiRoute | 更新路由 | 更新HttpApi的路由。 |
| GetHttpApiRoute | 查询路由详情 | 获取HttpApi的路由详情。 |
| DeleteHttpApiRoute | 删除路由 | 删除HttpApi的路由。 |
| ListHttpApiRoutes | 查询路由列表 | 查询HTTP API的路由列表。 |
服务管理
|
API |
标题 |
API概述 |
| CreateServiceVersion | 创建服务版本 | 创建服务版本 |
| UpdateServiceVersion | 更新服务版本 | 更新服务版本 |
| DeleteServiceVersion | 删除服务版本 | 删除服务版本。 |
网关管理
|
API |
标题 |
API概述 |
| CreateGateway | 创建网关 | 创建云原生网关。 |
| UpdateGatewayName | 修改网关名称 | 修改网关名称。 |
| UpdateGatewayFeature | 更新网关特性参数 | 更新网关特性参数。 |
| UpgradeGateway | 升级网关 | 升级网关版本。 |
| GetGateway | 查询网关详情 | 获取网关的所属VPC，所属交换机, 网关入口等基本信息。 |
| ListGateways | 查询网关列表 | 查询网关列表。 |
| AddGatewaySecurityGroupRule | 添加网关安全组规则 | 授权网关访问服务的安全组。 |
| DeleteGateway | 删除网关 | 删除网关。 |
| DeleteGatewaySecurityGroupRule | 删除网关安全组规则 | 删除网关安全组规则。 |
| ListZones | 获取可用区 | 获取云原生API网关region下的可用区。 |
| RestartGateway | 重启网关 | 重启网关。 |
| ListGatewayFeatures | 查询网关特性参数配置列表 | 查询网关特性参数配置列表。 |
消费者组管理
|
API |
标题 |
API概述 |
| CreateConsumerGroup | 创建消费者组 | 创建消费者组 |
| GetConsumerGroup | 查询消费者组 | 查询消费者组 |
| ListConsumerGroups | 查询消费者组列表 | 查询消费者组列表 |
| ListConsumerGroupConsumers | 查询消费者组成员列表 | 查询消费者组成员列表 |
| UpdateConsumerGroup | 更新消费者组 | 更新消费者组 |
| DeleteConsumerGroup | 删除消费者组 | 删除消费者组 |
| BatchAddConsumerGroupConsumers | 批量添加消费者组成员 | 批量添加消费者组成员 |
| BatchRemoveConsumerGroupConsumers | 批量移除消费者组成员 | 批量移除消费者组成员 |
消费者管理
|
API |
标题 |
API概述 |
| RemoveConsumerAuthorizationRule | 删除消费者授权规则 | 删除消费者授权规则。 |
| QueryConsumerAuthorizationRules | 查询消费者授权规则列表 | 查询消费者授权规则列表。 |
| CreateConsumerAuthorizationRules | 创建消费者授权规则 | 创建消费者授权规则。 |
| BatchDeleteConsumerAuthorizationRule | 批量解除消费者授权规则 | 批量解除消费者授权规则。 |
| DeleteConsumer | 删除消费者 | 删除消费者。 |
| ListConsumers | 获取消费者列表 | 获取消费者列表。 |
| DeleteConsumerAuthorizationRule | 删除消费者授权规则 | 删除消费者授权规则。 |
| CreateConsumer | 创建消费者 | 创建消费者。 |
| UpdateConsumer | 更新消费者 | 更新消费者。 |
| GetConsumer | 获取消费者 | 获取消费者。 |
| CreateConsumerAuthorizationRule | 创建消费者授权规则 | 创建消费者授权规则。 |
| UpdateConsumerAuthorizationRule | 更新消费者授权规则 | 更新消费者授权规则。 |
| GetConsumerAuthorizationRule | 获取消费者授权规则 | 获取消费者授权规则。 |
策略管理
|
API |
标题 |
API概述 |
| ListPolicyClasses | 获取策略模板 | 获取策略模板。 |
| UpdatePolicy | 更新策略 | 更新策略。 |
| CreatePolicyAttachment | 创建策略挂载 | 创建策略资源挂载。 |
| GetPolicyAttachment | 查询策略挂载 | 查询策略资源挂载。 |
| DeletePolicyAttachment | 删除策略挂载 | 删除策略资源挂载。 |
插件管理
|
API |
标题 |
API概述 |
| ListPlugins | 获取插件列表 | 获取插件列表。 |
| CreatePluginAttachment | 挂载插件 | 挂载插件。 |
| GetPluginAttachment | 查询插件挂载 | 查询插件挂载。 |
| ListPluginAttachments | 获取插件挂载列表 | 获取插件挂载列表。 |
| UpdatePluginAttachment | 更新插件挂载 | 更新插件挂载。 |
| DeletePluginAttachment | 删除插件挂载 | 删除插件挂载。 |
| InstallPlugin | 安装插件 | 安装插件。 |
| UninstallPlugin | 卸载插件 | 卸载插件。 |
域名管理
|
API |
标题 |
API概述 |
| ListSslCerts | 获取证书列表 | 获取证书列表。 |
| GetDomain | 查询域名 | 查询域名。 |
| CreateDomain | 创建域名 | 创建域名。 |
| ListDomains | 查询域名列表 | 查询域名列表。 |
| DeleteDomain | 删除域名 | 删除域名。 |
| UpdateDomain | 更新域名 | 更新域名。 |
监控管理
|
API |
标题 |
API概述 |
| GetTraceConfig | 获取trace配置 | 获取链路追踪配置。 |
| GetDashboard | 获取监控大盘 | 获取监控日志大盘接口。 |
资源管理
|
API |
标题 |
API概述 |
| GetResourceOverview | 获取资源概览 | 获取资源概览信息。 |
历史接口
|
API |
标题 |
API概述 |
| 环境管理 | 环境管理 | |
| GetEnvironment | 查询环境 | 查询环境。 |
| CreateAndAttachPolicy | 创建并附加策略 | 创建并附加策略。 |
| UpdateAndAttachPolicy | 更新并挂载策略 | 更新并挂载策略。 |
其他
|
API |
标题 |
API概述 |
| ListPluginClasses | 获取插件列表 | 获取插件。 |
| ListConsumerAuthorizationRules | 获取消费者授权规则列表 | 获取消费者授权规则列表。 |
| ListSecretReferences | 列出密钥引用 | 列出密钥引用。 |
| UpdateSecret | 更新密钥 | 更新密钥。 |
| GetSecret | 获取密钥 | 获取密钥。 |
| AddGatewayQuotaRule | 新增消费者配额规则 | 新增网关配额限流规则。 |
| ChangeResourceGroup | 资源转组 | 资源转组。 |
| CreateEnvironment | 创建环境 | 创建环境。 |
| CreatePluginClass | 创建自定义插件类 | 创建自定义插件类。 |
| CreatePolicy | 创建策略 | 创建策略。 |
| CreateSecret | 生成密钥 | 生成密钥。 |
| CreateService | 创建服务 | 创建服务。 |
| CreateSource | 创建来源 | 创建来源。 |
| DeleteEnvironment | 删除环境 | 删除环境。 |
| DeleteGatewayQuotaRule | 删除消费者配额规则 | 删除网关某条配额限流规则。 |
| DeletePolicy | 删除策略 | 删除策略。 |
| DeleteSecret | 删除密钥值 | 删除密钥值。 |
| DeleteService | 删除服务 | 删除服务。 |
| DeleteSource | 删除来源 | 删除服务来源。 |
| DescribeRegions | 查询APIG的Region列表 | 查询当前账号可见的云原生API网关开服地域 |
| GetGatewayQuotaRule | 查询消费者配额规则详情 | 查询网关配额限流规则详情。 |
| GetGatewayQuotaRuleSubjectUsage | 获取配额规则下某个消费者用量详情 | 查询网关配额限流规则主体用量详情，包括已用配额、总配额、是否超限、用量详情及消费记录等。 |
| GetPluginClass | 获取自定义插件类 | 获取自定义插件类。 |
| GetPolicy | 获取策略 | 获取策略。 |
| GetSecretValue | 获取密钥值 | 获取密钥值。 |
| GetService | 获取服务详情 | Get Service Details。 |
| GetSource | 获取服务来源详情 | 获取服务来源详情。 |
| ListConsumerQuotaRules | 查询消费者上已配置的配额规则列表 | 查询某个消费者上已配置的配额规则列表。 |
| ListEnvironments | 查询环境列表 | 查询环境列表。 |
| ListExternalServices | 获取外部服务 | 获取网关的外部服务信息。 |
| ListGatewayQuotaRules | 查询消费者配额规则列表 | 查询网关上绑定的消费者配额规则列表。 |
| ListPolicies | 查询策略列表 | 查询策略列表。 |
| ListSecrets | 列出密钥 | 列出密钥。 |
| ListServices | 查询服务列表 | 获取服务列表。 |
| ListTagResources | 获取资源标签列表 | 获取资源标签列表。 |
| ResetGatewayQuotaRule | 重置消费者配额规则 | 重置网关上某条配额限流规则。 |
| TagResources | 资源打标 | 打标签接口。 |
| UntagResources | 去除资源标签 | 去除资源标签。 |
| UpdateEnvironment | 更新环境 | 更新环境。 |
| UpdateGatewayQuotaRule | 编辑消费者配额规则 | 编辑网关上某条配额限流规则。 |
| UpdateGatewayQuotaRuleStatus | 启/停用消费者配额规则 | 启/停用网关某个配额限流规则 |
| UpdateService | 更新服务 | 更新服务。支持更新服务健康检查配置， DNS 域名和固定地址的地址配置信息。 |
该文章对您有帮助吗？