ImportSwagger-通过 Swagger 创建 API
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
功能总览
网关主要功能模块如下：API 全生命周期管理 快速构建多种协议类型的 API 支持按需导入导出 API 多版本管理满足企业迭代需求 统一接入 支持多种方式创建路由规则 通过参数映射实现多部门参数统一规范 支持创建多种参数类型的外部授权 API ...
常见问题
本文为您介绍云控制API的常见问题。问题概览 产品code和资源code哪里获取？CreateResource和...根据对应的API文档中的requestPath说明和产品code、资源code进行拼接。若自行拼接麻烦，可前往 在线调试API门户 查看对应的requestPath。
新功能发布记录
每次允许导入的API上限个数为100 全部 导入标准OAS定义 第三方鉴权插件支持获取请求的Path信息 支持将请求侧的Path作为参数传递给鉴权服务 全部 第三方鉴权插件 新增API的操作历史日志 API网关记录了API所有相关操作日志，包括：创建、编辑...
RemoveTrafficControlApis-解除API与流控策略的绑定
接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系，支持 API 批量，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DryRunSwagger-预检查swagger
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
DescribeAuthorizedApis-查询已授权的API列表
查询指定 APP 已授权的API列表，即指定 APP 的API列表。接口说明 此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...
DescribeApiHistories-查询API历史发布的版本列表
接口说明 此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录 调用该接口能获取 API 历史版本号数据，用于其他接口的调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...
授权API
在API发布后，您可以将API授权给他人，或获取他人已授权的API，以实现数据共享。本文为您介绍如何对API进行授权及不同场景下API的授权方案。前提条件 仅支持对已发布的API进行下线、授权和变更协议等操作，详情请参见 发布API。进入API管理...
修改VPC授权信息，并且更新关联的API的元信息
修改VPC授权信息并更新关联的API元信息。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
使用 RAM 管理 API
第三部分：Resource（操作对象列表）Resource 通常指操作对象，API 网关中的 API 分组、流控策略、应用都被称为 Resource，书写格式：acs:<service-name>:<region>:<account-id>:其中：acs：Alibaba Cloud Service 的首字母缩写，表示阿里...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
WAF接入配置
本文主要介绍如何配置WAF，对API网关上发布的API进行增强安全防护。1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP ...
管理 API 渠道
对应内容同步推送接口中的 apiChannelId 字段。API 名称：API 的名称。内容形式：指定客户端展示的内容为图文还是视频。完成 API 配置后，单击 确定。新增的 API 将出现在 API 列表中。查询 API 渠道 支持输入 API 标识或 API 名称查询 API...
管理参数映射
绑定的 API：列出了绑定了该映射规则的所有 API 及其基本信息，包括 API 名称，API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情：...
SetAppsAuthorities-给多个APP添加API访问权限
接口说明 此功能面向 API 调用者和 API 使用者 API 提供者可以授权自己的 API 给任意应用（app）调用 API 使用者可以将已购买的 API 授权给自己的应用（app）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
SetIpControlApis-绑定IP访问控制与API关系
接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作，最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...
DescribeHistoryApis-查询API发布版本定义列表
RELEASE：线上 TEST：测试 RELEASE ApiId string 否 指定要查询的 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称（模糊匹配）getPersonInfo PageSize string 否 分页参数：每页显示条数。10 PageNumber string 否...
DescribePurchasedApis-获取购买的 API 列表
获取在云市场购买的 API 列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
DeleteApi-删除 API 定义
删除指定的API定义。接口说明 此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该...
HTTP 转 SOFARPC 入门
安全认证：选择 密钥认证，表示订阅应用访问授权的 API 时需要使用密钥进行身份认证。请求参数：可选，详见 API 属性说明>请求参数。响应参数：可选，详见 API 属性说明>响应参数。单击 下一步，进入后端配置页面，您需要选择 后端配置类型...
DescribePurchasedApiGroups-获取购买的API分组列表
获取云市场购买的 API 分组列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
DescribeApiLatencyData-查询API监控数据中对响应时间...
接口说明 查询指定 API 的监控信息：Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI...
产品优势
方便开发者开发出支持阿里云服务的API接口，并通过API接口获取数据、控制服务器、管理权限等，从而实现对阿里云资源的全面控制和管理。提供多种编程语言和开发框架的SDK，并为每种语言提供专业的部署指南、简单的调试平台和丰富的场景化...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
测试API
同时您也可以对已发布的API进行测试。本文为您介绍如何测试开发中和已发布的API。背景信息 API测试本质上是直接访问实际数据源或后端服务来调用API，会占用数据服务资源组产生数据服务资源组费用，计费详情请参考 数据服务计费说明。测试...
SOFARPC 客户端接入
前置条件 在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体...
SwitchApi-切换指定环境中正在运行中的API定义
指定历史版本切换掉指定环境中正在运行中的API定义，即用历史定义替换运行中定义。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
Zookeeper
本文将介绍API网关集成Zookeeper访问微服务后端的原理，以及如何创建、发布并调用服务发现类型的API。1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建...
DetachPlugin-解绑API绑定的插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DetachPlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 绑定的 API 网关插件 ID 05df2b52a3644a3a8b1935ab8ab59e9d GroupId string 是 指定...
HTTP API 入门
在 定义 API 步骤中，您需要配置以下信息：API 分组：必选，选择步骤三创建的 API 分组。API 名称：必填，用于识别 API，支持英文字母、中文、数字、下划线（_）、连接符（-），32 个字符以内。本示例使用 hello。说明 同一个 API 分组下，...
DescribeApiTrafficData-查询API监控数据中流量统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DescribeApiQpsData-查询API监控数据中对QPS的统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
BatchDeployApis-批量发布API
描述 test Api object[]否 指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数 名称 类型 描述 示例值 object OperationId string...
功能概览
支持混合云管理，对云上资源、云下资源的API进行统一管控；发布和路由 提供API发布管理，线上版本一键切换；支持多环境管理，满足日常研发、预发测试、生产环境并行使用需求；支持灰度发布功能；支持参数路由，可根据HTTP请求内容创建不同...
ModifyApiGroupInstance-修改api分组所属的实例
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
- 产品推荐
- 这些文档可能帮助您