基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
错误代码表
I400IP 400 Invalid parameter `${ParameterName}`${Reason} API中配置的参数值非法 I400JR 400 JWT required 未找到JWT参数 S403JI 403 Claim `jti` is required when `preventJtiReplay:true` 当在`JWT授权插件`中配置了防重放功能时，...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API网关中API分组绑定域名接入WAF
应用场景 将API网关中API分组绑定的自定义域名接入WAF防护，保障域名安全。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级。检测逻辑 API网关中的API分组绑定自定义域名，且域名已接入WAF防护，视为...
API网关中API分组绑定自定义域名
API网关中的API分组绑定自定义域名，视为“合规”。应用场景 为API设置合适的自定义域名，满足业务规范和管控要求。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级。检测逻辑 API网关中的API分组绑定...
API网关中API安全认证设置为JWT方式
应用场景 API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级...
查看API资产详情
名称 说明 来源 接口信息 展示基本信息、应用请求、响应示例等信息。已在统一服务模块中创建API，并已上线。血缘关联 展示API和表的关联关系。已在统一服务模块中创建API，并已上线。用户评价 展示用户对该API的评分情况。已被申请，且使用...
查看API资产详情
名称 说明 来源 接口信息 展示基本信息、应用请求、响应示例等信息。已在统一服务模块中创建API，并已上线。血缘关联 展示API和表的关联关系。已在统一服务模块中创建API，并已上线。用户评价 展示用户对该API的评分情况。已被申请，且使用...
什么是 OpenAPI
OpenAPI 是指开放应用程序编程接口（Open Application Programming Interface）的简称。阿里云OpenAPI为开发者提供了一系列开放的应用程序接口，使您可以通过这些应用程序接口来方便的管理云上资源、数据和服务等内容。什么是 OpenAPI？...
Invalid Signature
客户端只需打印出本地自己拼接的 StringToSign 进行对比，找出哪里不同，针对性的解决，如果使用的官方提供的调用 Demo，可以到签名计算的工具类中找出计算签名前的 StringToSign 打印出来即可进行对比。因为 HTTP Response Header 中不...
API网关流量安全
API网关服务端平均延时过高告警 API网关后端服务器错误率过高告警 API网关请求成功率过低告警 API网关服务端平均延时过高告警 告警ID sls_app_audit_dataflow_at_api_latency 告警名称 API网关服务端平均延时过高告警 版本号 1 类别 云平台...
数据服务
API分组是一个特定功能或场景的API集合，是数据服务中API的最小组织单元，对应于API网关中的分组概念。数据服务中的API发布至API网关时，系统会在API网关中自动创建一个同名的分组。如何合理设置API分组？通常将解决同一个问题或者相似功能...
创建后端服务为VPC内资源的API
本文将快速引导您如何在API网关中，发布后端服务为VPC内资源的API，并如何使用"阿里云APP"认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1....
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
使用外部授权 API
在新打开的页面中，选择或输入外部授权 API 相关信息：外部授权 API 名称：必填，用于识别该 API，支持英文字母、中文、数字、下划线（_）、连接符（-），32 个字符以内，以中文或字母开头。后端服务类型：目前仅支持 系统集群，即表示网关...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
DDoS防护接入配置
其中添加网站业务转发规则步骤中，主要填写的信息如下：网站：填写您的域名，需要和 步骤1 中API网关分组上绑定的域名一致；协议类型：需要和您在API网关在发布API的协议类型一致，我们的建议是使用HTTPS；服务器地址：选择“源站域名”，...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
DescribeApiDoc-查询API说明文档
若您是开放 API 的用户，那么调用该接口可以查看当前指定 API 在指定环境中运行的定义，可能与您现在修改中的 API 定义不同，是真正在环境中生效的定义。若您是开放 API 的用户，由于该接口面向 API 调用者鉴权，所以您需要确认该 API 为 ...
API调用授权
BSS OpenAPI的权限为 bssapi:【API名称】，例如 bssapi:QueryOrder 或 bssapi:QueryInstanceBill。为了兼容控制台权限，以下表格中API对应的权限点同样可以使用。对于权限策略中，Allow或Deny一个API对应的任何一个权限点，权限策略都会...
新功能发布记录
调试页面增加自助排错能力 API网关支持用户对配置在API网关中的已发布API进行在线调试，通过API调试中的自助排错功能进行调试过程中的问题排查 全部 API调试及自助排错 第三方鉴权插件支持将鉴权结果透传给后端服务 从鉴权服务返回的应答中...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
ModifyInstanceSpec-网关实例变配
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
使用后端服务提高管理效率
在调用API菜单中选择应用管理，创建一个APP。可以看到阿里云APP下有两种认证方式，AppKey和AppCode。本例中我们选择使用APPCode的方式进行简单认证。关于阿里云APP的更多描述可见此文档 使用简单认证（AppCode）方式调用API 在API列表，...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，...在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：instance/disk/[diskid]，可以与后端服务地址中的动态参数进行映射。
授权API
授权API是指将已上线的API主动授权给其他应用使用。本文介绍如何给应用授权API。前提条件 API已上线，具体操作，请参见 上线API。已创建应用，具体操作，请参加 新建应用。当前账号具有工作组管理员角色权限，具体操作，请参见 工作组成员...
授权API
授权API是指将已上线的API主动授权给其他应用使用。本文介绍如何给应用授权API。前提条件 API已上线，具体操作，请参见 上线API。已创建应用，具体操作，请参加 新建应用。当前账号具有工作组管理员角色权限，具体操作，请参见 工作组成员...
模型管理
同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的POJO类。这样可以增强用户传入参数的便利性，同时可以方便用户反序列化返回的数据。API网关模型定义基于 JSON架构草案4 的规范，但...
数据源配置常见问题
数据源类型 介绍 在DataV中的应用场景 API 通用的数据接口。如果您有直接可用的API，可使用DataV的API数据源连接。例如，已有站点提供的接口，或已购买的云服务搭建的接口等。具体使用操作请参见 添加API数据源。阿里云API网关 阿里云的一...
数据源配置常见问题
数据源类型 介绍 在DataV中的应用场景 API 通用的数据接口。如果您有直接可用的API，可使用DataV的API数据源连接。例如，已有站点提供的接口，或已购买的云服务搭建的接口等。具体使用操作请参见 添加API数据源。阿里云API网关 阿里云的一...
后端路由
1.2.Condition条件表达式 1.2.1 基本语法 Condition表达式与SQL表达式类似，基础表达形式为$A='A' and '$B='B' 参数以$开头，可以引用在API中定义的参数（API为映射与透传方式均可），如果您在API中定义了名为query1的参数，则$query1 可以...
导入数据模型
API 网关会从 Swagger 2.0 文件中的 Model 或 Swagger 文件 3.0 中的 Schema 解析参数名称，参数结构，参数类型并转换后导入数据模型，可直接在 API 中自动生成示例入参的 JSON，数据模型也可直接在流程编排中进行参数配置，参数映射等。...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
利用 API 实现资源和成本管理
利用 BssOpenAPI 实现资源和成本管理 BssOpenAPI 提供的功能 BssOpenAPI 是阿里云提供的实例、订单、账单和卡券管理等系列工具的API集合产品。通过 BssOpenAPI 我们可以实现从产品基本信息查询，到钱账票的统一管理功能。资源概念 BssOpen...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
API网关中的API设置为私有
应用场景 在满足业务生产的前提下，将API网关中的API设置私有，可有效降低业务安全风险。风险等级 默认风险等级：高风险。当您使用该规则时，可以按照实际需求变更风险等级。检测逻辑 API网关中的API设置为私有，视为“合规”。API网关中的...
API网关中配置API安全认证
应用场景 API网关中配置合适的API安全认证方式，降低业务安全风险。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级。检测逻辑 API网关中配置API安全认证为阿里云APP或使用指定的插件类型，视为“合规”。...
- 产品推荐
- 这些文档可能帮助您