客户端调用API示例
响应头：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF#请求唯一 ID，请求一旦进入 API 网关应用后，API 网关就会生成请求 ID 并通过响应头返回给客户端，建议客户端与后端服务都记录此请求 ID，可用于问题排查与跟踪。...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
SOFARPC 客户端接入
前置条件 在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体...
ModifyApi-修改API定义
会在所有用户的控制台“发现 API”页面展示 PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架 PUBLIC AuthType string 否 API 安全认证类型，目前可以取值：APP：只允许已授权的 APP 调用 ANONYMOUS：...
API分组同步
本功能主要是帮助您在不同API分组之间实现API定义的快速同步。在开始同步前，建议先了解同步范围，以及需要做的一些工作。1.API分组同步范围 API分组同步功能的 同步范围包括：API分组下所选API的配置信息。API分组无法同步的数据包括：API...
BasicAuth插件
users:username:alice password:123456-username:bob password:666666-username:charlie password:888888-username:dave password:111111 BasicAuth插件支持插件数据集 创建插件数据集 登录API网关控制台，左侧栏点击 API管理 —— 插件...
使用SDK调用API
1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在 调用API 的 已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在 开放API 的...
环境管理
登录API网关控制台，在左侧导航栏 API管理 下，选择 后端服务，进入后端服务列表页面；在界面右上角单击 创建后端服务，类型选择VPC。步骤3：创建好后端服务后，在后端服务后的操作栏选择 配置及关联的AP I，进入后端服务定义页面，测试...
API网关-事件总线服务关联角色
本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...
使用外部授权 API
} 创建外部授权 API 本地编写完外部授权接口后，您需要前往 API 网关的控制台上配置一个对应的外部授权 API。操作步骤如下：进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>外部授权 API。在外部授权 API 列表页，点击列表右上方的...
WAF接入配置
1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
如何关闭公网访问
操作步骤如下：登录API网关控制台，在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组，单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到 关闭公网访问 按钮，单击确定后即可关闭公网访问。...
创建应用
在弹出的 创建应用 窗口中，选择或输入以下相关信息：应用类型：目前仅支持选择 应用，表示订阅的应用运行在 Web 浏览器、H5 容器、小程序、JS、业务系统中。应用名称：输入应用的名称，用于识别应用。描述：选填，用于描述应用的作用等，...
为分组绑定插件
本文主要介绍如何为API分组绑定插件，并验证插件是否对分组下的API生效。1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效...
HTTP自动跳转HTTPS
分组内的所有API定义的请求...操作步骤 登录 API网关控制台。左侧栏点击开放API，选择分组管理，找到目标分组，点击进入分组详情页。在分组详情页找到独立域名栏，开启指定域名的HTTP自动跳转HTTPS功能。点击确认，http的自动跳转开启成功。
SDK下载及使用指南
若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务（包括在 API 市场购买的 API 服务）注意这里的 API 服务是指在 API 市场购买的，或者您在 API 网关接入开放的，或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
基于Swagger完成API网关与用户CICD流程整合
API网关通过访问这些接口，自动获取Swagger定义 创建API分组 用户可以在API网关控制台手动创建分组，或者通过 CreateApiGroup-创建API分组 创建分组。用户创建分组后，可以进行绑定独立域名以及绑定证书等操作。通过OpenAPI导入API并发布 ...
开通服务并创建API-KEY
任何发起自客户端的API调用，例如浏览器、APP或小程序等，均有可能造成API-KEY的泄露。如怀疑API-KEY可能已经被泄露，您可以登录 DashScope控制台 删除该API-KEY。API-KEY被删除后，使用该API-KEY的后续调用均会被拒绝。操作步骤 登录 ...
开通IPv6
操作步骤 登录API网关控制台。点击左侧栏的 实例，选择实例所在的Region。在专享实例中找到IPv6入口能力及IPv6出访能力，点击 开通。实例开通IPv6能力后，在分组管理中找到想要开通IPv6入访能力的分组，点击进入，在分组详情页的公网二级...
概述
API网关提供的SDK内置了签名实现，您可以直接用API网关控制台为您提供的多语言SDK来调用API，具体操作请参考 使用SDK调用API-如果您需要自己在客户端实现签名计算过程，可以参考 客户端签名计算过程说明文档 使用JWT认证方式调用API 还可...
CreateApi-创建 API
支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Visibility string 是 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。...
创建授权对象
操作步骤 登录 API 网关控制台。在左侧导航栏中单击 API 发布>授权管理，进入授权列表。单击授权列表右上方的 创建授权对象。在弹出的 创建授权对象 窗口中，选择或输入相关信息：应用来源：必选。外部系统：表示授权给其他租户的应用订阅...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
配置Trace链路追踪
您可以参考本文在API网关控制台配置trace链路追踪日志上传到阿里云链路追踪平台，链路追踪 Tracing Analysis 提供了完整的调用链路还原、调用请求量统计、链路拓扑、应用依赖分析等工具，可以帮助用户提高开发诊断效率。本功能仅支持专享...
实例级别访问控制
API网关提供实例级别的访问控制，您可以分别配置针对IPv4和IPv6的访问控制策略组应用于实例，仅专享实例支持配置实例级别访问控制策略，并且仅对公网生效。1.创建访问控制策略组 1.1 在API网关控制台中实例页面，单击 访问控制，即进入访问...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
函数计算内网访问API网关
步骤6：配置函数计算的VPC访问 首先需要在vpc-api-access中再创建一个vswitch，用于函数计算的接入，如下图所示：其次在函数计算控制台中，在上一步骤中新建应用的配置服务菜单中进行配置，具体过程以函数计算的文档为准 配置网络。...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
创建数据模型
操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>数据模型。在数据模型列表页，单击列表右上方的 创建数据模型 按钮。在新打开的 创建数据模型 页面中，配置如下信息：模型名称：必填，用于识别数据模型，需保证唯一性。...
更新日志
您将可以在这里找到阿里云Bss OpenAPI的更新日志，我们将持续更新API的更新，包括新接口的开放，参数调整以及问题的修复。建议您收藏并定期查看本页面以了解新的动态。同样建议您通过钉钉扫描文章底部的二维码加入开发者圈子，获取关于费用...
创建参数映射
操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>参数映射。在参数映射列表页，单击列表右上方的 创建参数映射。在新打开的 创建参数映射 页面中，选择或输入相关信息：参数映射名称：必填，用于识别参数映射规则。支持...
API网关-微服务集成服务关联角色
背景信息 API网关-微服务集成服务关联角色（ApiGateway-IntegrateWithMicroservices）是API网关为了访问您在企业级分布式应用服务（EDAS）和微服务引擎（MSE）下的资源，而提供的RAM角色。更多关于服务关联角色的信息请参见 服务关联角色。...
API网关-连接用户VPC服务关联角色
本文为您介绍API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApiGatewayConnectUserVpc）的应用场景以及如何删除API网关-连接用户VPC服务关联角色。背景信息 API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApi...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
使用后端服务提高管理效率
用户可以在API网关控制台统一配置后端，然后在不同的环境上定义不同的后端地址，创建API的时候先选择后端，然后根据发布的环境不同，指向不同的后端地址；同时，用户可以在后端服务的配置页面对已经发布的API进行统一管理，例如：1.当用户...
调用API
调用方式 调用方式 适用场景 说明 安全级别 加密签名身份认证 应用程序开发、数据采集等。该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作，请参见 使用SDK调用API。高 简单身份认证 一般用于可视化场景，如DataV调用。该...
API工作组内调用（Postman）
说明 因为是简单鉴权，所以Authorization值由API应用的code和密钥组成，格式为：ApplicationCode+空格+AppKey。单击 Body，选择 raw，填写API字段名称和默认值为{"climit":"10"}，选择 JSON。API字段名称和默认值获取方式请参见 获取调用...
- 产品推荐
- 这些文档可能帮助您