基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
SDK下载及使用指南
若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务（包括在 API 市场购买的 API 服务）注意这里的 API 服务是指在 API 市场购买的，或者您在 API 网关接入开放的，或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...
开放平台概览
DataWorks开放平台提供开放API（OpenAPI）、开放事件（OpenEvent）、扩展程序（Extensions）的能力，可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维，及时响应应用系统对接DataWorks的业务状态...
搭建无服务器应用之手机号归属地查询
调试成功就可以开放API地址了。第一步：在云市场申请服务 登录 云市场。搜索查找应用 手机号码归属地查询。开通该服务，并获取到服务的AppCode。第二步：设置函数计算 创建一个服务。在函数控制台上创建一个服务，填写名称和备注。具体操作...
应用 API 开放
开放 API 可在【API 开放】标签中为指定应用开启/关闭接口调用。启用后，将在【通用配置】标签中获取到的 client_id、client_secret 提供给应用开发者，在正确设定权限后，即可调用接口。接口权限 管理员可为指定应用分配其调用的接口权限...
如何关闭公网访问
操作步骤如下：登录API网关控制台，在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组，单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到 关闭公网访问 按钮，单击确定后即可关闭公网访问。...
HTTP自动跳转HTTPS
您可以通过配置自动跳转功能，将客户端HTTP请求方式强制重定向为HTTPS请求。前提条件 分组已绑定域名并已成功配置HTTPS证书，操作可参考 使用HTTPS并用域名访问。分组内的所有API定义的请求协议都已勾选HTTPS...操作步骤 登录 API网关控制台。...
API网关监控
4.2 左侧栏选择 开放API —— API列表。点击想要查看监控的API，进入API详情页。4.3 在左侧栏选择 监控信息，可以根据环境（线上、测试、预发）查看该API近一周的监控数据。监控指标包括：请求次数（成功、异常）流量（上行、下行）后端...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
DescribeRegions-查询支持的区域
接口说明 查询支持的区域列表 此功能面向开放 API 和调用 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透...
DeleteAllTrafficSpecialControl-删除所有特殊流控
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...
名词解释
独立域名 开放API服务，需要为分组绑定独立域名。客户通过访问该独立域名调用API。签名密钥 API服务方可以创建签名密钥并绑定到API上，网关到服务方后端的请求就会带上签名信息，用于后端的安全验证。流量控制策略 用于API服务方对API、...
API网关-事件总线服务关联角色
操作步骤如下：进入 API网关控制台，在左侧导航栏选择 开放API-后端服务；在搜索框，通过后端服务类型 EventBridge 搜索后端服务，在右侧操作列点击 删除；进入 RAM控制台，点击左侧菜单 RAM 角色管理，找到角色 AliyunServiceRoleForApi...
RemoveTrafficControlApis-解除API与流控策略的绑定
接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DeleteTrafficSpecialControl-删除特殊流控
接口说明 此功能面向开放 API 的用户 接口需要用到的入参可以调用其他接口获取 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无...
RemoveIpControlApis-解除API与IP访问控制的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
产品优势
API网关提供了API认证、参数清洗、全链路签名、CA证书、访问控制、流量控制、内网访问等多种安全机制，并且可以与WAF、DDoS高防IP、IDaaS等结合使用，形成全链路API安全保障方案。丰富的集成能力 与阿里云的计算产品、大数据产品、AI产品、...
SetIpControlApis-绑定IP访问控制与API关系
接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...
RemoveSignatureApis-解除API与后端签名密钥的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
DeleteApi-删除 API 定义
接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
DeployApi-发布 API
接口说明 此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，...
AbolishApi-下线 API
接口说明 此功能面向开放 API 的用户，和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
AttachPlugin-绑定插件到API上
接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态的 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
API 流量治理
本文列出了 API 流量治理相关的所有 OpenAPI 及其请求参数、返回参数。编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6...
DescribeApps-查询应用列表
接口说明 此功能面向开放 API 的用户 API 开放者可通过 AppId 或者阿里云登录账号查询 app 信息，进而操作授权 每个用户在每个 Region 每天调用次数上限为 200 次 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
DeletePlugin-删除插件
接口说明 此接口面向开放 API 的用户。必须先解除 API 和插件的绑定关系，否则删除报错。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下...
DescribeTrafficControlsByApi-查询API绑定的流控策略
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...
SetTrafficControlApis-添加指定流控策略与API的绑定
接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系，支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...
DescribeSignaturesByApi-查询API绑定的后端签名密钥
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
WAF接入配置
2 前提条件 开通Web应用防火墙 在API网关上已经发布了API 3 操作步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。绑定成功后如下图所示：重要 由于后续步骤中还需配置WAF，建议当前阶段绑定域名时使用TXT解析。...
DDoS防护接入配置
什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称DDoS）将多台计算机联合起来作为攻击平台，通过远程连接，利用恶意程序对一个或多个目标发起DDoS攻击，消耗目标服务器性能或网络带宽，从而造成服务器无法正常地提供服务。...
SetVpcAccess-添加 VPC 授权
接口说明 此功能面向开放 API 的用户。授权 API 网关允许访问您的 VPC 实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...
ModifyPlugin-修改插件
接口说明 此接口面向开放 API 的用户。插件不允许重名。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM...
API网关-微服务集成服务关联角色
操作步骤如下：进入 API网关控制台，在左侧导航栏选择 开放API-后端服务；在搜索框，通过后端服务类型 EDAS 搜索后端服务，在右侧操作列点击 删除；进入 RAM控制台，点击左侧菜单 身份管理，找到角色 AliyunServiceRoleForApi...
CreateTrafficControl-创建流控策略
接口说明 此功能面向开放 API 的用户 策略创建后，未绑定 API 前是无意义的，绑定 API 后，对绑定的 API 即时生效 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
ModifySignature-修改后端签名密钥
接口说明 此功能面向开放 API 的用户 用于修改某个已存在的签名密钥的名称、Key 和 Secret 需要注意，修改立即生效，若该密钥已经绑定 API，后端做验证时请及时调整为针对新签名字符串的验证 该接口调用的 QPS 限制为：单用户 QPS 不超过 ...
DescribeApisByIpControl-查询IP访问控制绑定的API
接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
- 产品推荐
- 这些文档可能帮助您