API 流量治理
编辑限流配置 sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。请求参数 名称 类型 是否必填 示例 描述 api_id STRING 是 NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSr*API 标识 limit_config LimitConfigVO 否-限流配置 ...
使用限制
每个账号下，每个Region默认最多创建5个未绑定域名的API分组，如果在此Region中有绑定域名的API分组，则未绑定域名的API分组总数上限为20个；支持通过 提交工单 申请增加API分组数量限制。公网二级域名限制 直接使用API分组的公网二级域名...
管理数据模型
绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
Android 常见问题
自定义 JSAPI 时，handleEvent 和 interceptEvent 有什么区别？解答：如果监听容器自己处理的事件，需要将自定义 JSAPI 添加到 handleEvent 里，并返回 true。返回 true，表示事件将停止传递；返回 false，表示事件将继续传递给其他插件。...
产品简介
开发者可以使用统一的 API 动词、通用输入资源和参数来构建独特的 API 代码库。API名称 API描述 ListProducts 查看产品列表 ListResourceTypes 查看资源元数据 CreateResource 创建资源 UpdateResource 更新资源 GetResources 查询资源 ...
调用API商品
在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...
如何找到已购买的API
您可以在管理控制台寻找您都已经购买的API。打开 云市场，在右上角点击【买家中心】-【[进入管理控制台]】(https://market.console.aliyun.com/imageconsole/index.htm "进入管理控制台")在左侧菜单，点击【API】即可，如图：
产品简介
通过API网关强大的适配和集成能力，可以将各种业务系统的API实现统一管理和统一调用：支持异构网络环境：无论您的业务系统部署在阿里云、本地数据中心、或其他云，API网关均可以统一管理；支持对接多种系统实现方式：您的业务系统基于ECS、...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
产品架构
Mosng 网关根据内存中的 API 信息校验应用的请求信息（验签、解密、RPC 信息校验）。如果信息校验失败，则直接返回错误信息给应用。如果信息校验通过，则根据配置的协议（HTTP/SOFARPC/SOFAREST）将应用的请求转发到后端业务服务器。
产品简介
API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...
RemoveSignatureApis-解除API与后端签名密钥的绑定
接口说明 此功能面向开放 API 的用户 即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...
如何使您的API支持HTTPS？
首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。
CORS 配置
请求参数 名称 类型 是否必填 示例 描述 api_id_list ARRAY[STRING]否-绑定的 API ID 列表 cors_id STRING 否 cors_id1 CORS 标识 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 ...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
概述
协议转换 API 网关不仅是一个简单的反向代理服务，同时还提供协议转换的能力，支持使用 A 协议调用 B 协议的接口。协议转换与使用的编程语言无关，但是仅 Java 语言支持使用高级功能，比如服务端签名校验、数据加解密等，其他语言目前只能...
BatchAbolishApis-批量下线API
批量下线已经发布到环境的API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
产品在控制台的管理都有什么？如何管理？
若您提供 API，您可以在控制台创建、管理、发布您的 API，还可以对您的 API 进行授权管理、流量控制等操作。
新功能发布记录
每次允许导入的API上限个数为100 全部 导入标准OAS定义 第三方鉴权插件支持获取请求的Path信息 支持将请求侧的Path作为参数传递给鉴权服务 全部 第三方鉴权插件 新增API的操作历史日志 API网关记录了API所有相关操作日志，包括：创建、编辑...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
共享实例
共享实例的所有云资源包括ECS/SLB/Redis等...总的公网最大入访带宽是5120M 最大公网出访带宽(bps)最大公网出访带宽就是实例页出口地址 IP的总和，一个IP是200M SLA 99.9%（2023年10月30号之前新建的API）99.0%（2023年10月30号之后新建的API）
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
服务接入点
华北1（青岛）cn-qingdao apigateway.cn-qingdao.aliyuncs.com apigateway-vpc.cn-qingdao.aliyuncs.com 华北2（北京）cn-beijing apigateway.cn-beijing.aliyuncs.com apigateway-vpc.cn-beijing.aliyuncs.com 华北3（张家口）...
API网关-事件总线服务关联角色
应用场景 用户在创建事件总线类型的后端服务时，API网关会提示用户创建事件总线服务关联角色，在后续操作中，用户在API网关创建后端为事件总线的API并调用，API网关在上传事件到用户的事件总线时需要使用服务关联角色...
常见问题
本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取？CreateResource和...根据对应的API文档中的requestPath说明和产品code、资源code进行拼接。若自行拼接麻烦，可前往 在线调试API门户 查看对应的requestPath。
ApiGateway服务关联角色
本文为您介绍ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）的应用场景以及如何删除服务关联角色。背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问...
DescribeTrafficControlsByApi-查询API绑定的流控策略
请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询的 Api 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
DescribeSignaturesByApi-查询API绑定的后端签名密钥
请求参数 名称 类型 必填 描述 示例值 GroupId string 是 指定要查询的 API 所属分组 0009db9c828549768a200320714b8930 ApiId string 是 指定要查询的 API 编号 3b81fd160f5645e097cc8855d75a1cf6 StageName string 是 指定要查询的环境。...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：...
DeleteApi-删除 API 定义
删除指定的API定义。接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...
DescribePurchasedApis-获取购买的 API 列表
获取在云市场购买的 API 列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
SetIpControlApis-绑定IP访问控制与API关系
接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...
管理参数映射
绑定的 API：列出了绑定了该映射规则的所有 API 及其基本信息，包括 API 名称，API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情：...
HTTP 转 SOFARPC 入门
安全认证：选择 密钥认证，表示订阅应用访问授权的 API 时需要使用密钥进行身份认证。请求参数：可选，详见 API 属性说明>请求参数。响应参数：可选，详见 API 属性说明>响应参数。单击 下一步，进入后端配置页面，您需要选择 后端配置类型...
绑定/解绑授权对象
只有获得授权的订阅方应用可以调用 API。在 API 详情页的 授权对象 标签页下，您可以绑定授权对象、解除绑定以及限制应用访问 API 的次数。绑定授权对象 进入 API 发布>API 管理 页面，找到待授权的 API，单击进入其详情页。在 授权对象 ...
- 产品推荐
- 这些文档可能帮助您