API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
使用Lua插件
Lua是一种轻量级、高效的脚本语言，在网关开发中，Lua可以用于编写和执行各种网关程序，例如API网关、消息网关、反向代理等。通过Lua脚本，开发人员可以实现请求的路由、过滤、鉴权等功能，并进行定制化的处理。在一些代理中，比如Nginx和...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
DescribeApis-查询定义中的 API 列表
API 名称(模糊匹配)weather CatalogId string 否 分类 ID 1553414085247362 Visibility string 否 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。PRIVATE：不...
DescribePurchasedApis-获取购买的 API 列表
PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上...
ModifyApi-修改API定义
英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Description string 否 API 描述信息，最多 180 个字符 Api description Visibility string 是 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上...
DATASOURCE:ApiGateway:Apis
如果选择此类型，该API的线上环境定义，会在所有用户的控制台“发现API”页面可见。PRIVATE：不公开。如果选择此类型，当该组API在云市场上架时，私有类型的API不会上架。ApiId String 否 是 指定的API编号。无 CatalogId String 否 是 ...
CreateApi-创建 API
支持汉字，英文，数字，下划线，且只能以英文和汉字开头，4~50 个字符 ApiName Visibility string 是 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。...
ModifyApiConfiguration-修改API定义
testModifyApiName Description string 否 api 描述 测试修改描述 Visibility string 否 API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。PRIVATE：不公开，如...
DescribeApiHistory-查询历史版本详情
true Visibility string API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架...
DescribeDeployedApi-查询API在指定环境中的定义
true Visibility string API 是否公开，可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架...
DescribeApi-查询 API 定义
取值：true:请求 API 时强制检查这个字段，防止 API 的重放攻击 false:不检查这个字段 true Visibility string API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 API 的线上环境，会在所有用户的控制台“发现 API”页面展示 ...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些...注意：API网关不维护模型和API的关联关系，删除模型时可能会引起线上API的SDK导出失败等问题。因此，删除模型请谨慎操作。
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
Tair开发运维规范
Lua脚本会占用较多的计算和内存资源，且无法被多线程加速，过于复杂或不合理的Lua脚本可能导致资源被占满的情况。合理使用管道（pipeline）降低链路的往返时延RTT（Round-trip time）。如果有多个操作命令需要被迅速提交至服务器端，且客户...
如何指定调用环境？
调用API时，默认是调用线上环境的API。如果要调用测试环境，请在header中增加参数：X-Ca-Stage:TEST。如果要调用预发环境，请在header中增加参数：X-Ca-Stage:PRE。
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
DescribeApiLatencyData-查询API监控数据中对响应时间...
接口说明 查询指定 API 的监控信息：Latency(ms)此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI...
DescribeApiQpsData-查询API监控数据中对QPS的统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
DescribeApiTrafficData-查询API监控数据中流量统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
自定义事件源API网关
步骤四：创建应用及对API授权 在 API网关控制台 的左侧导航栏，选择 调用API>应用管理。在 应用列表 页面，单击右上角的 创建APP，然后在 创建应用 对话框设置应用的名称和描述，单击 确定。回到 API列表 页面，找到 步骤三：创建API 中...
API 概览
流水线控制 API 名称 描述 运行流水线 运行流水线 终止运行流水线 可以取消运行流水线 删除流水线成员 可以删除流水线成员 更新流水线成员 可以更新流水线成员 增加流水线成员 可以增加流水线成员 使用流水线模板创建流水线 使用流水线模板...
Lua脚本规范与常见报错
说明 若您能够在代码中确保所有操作都在相同slot（如果不能保障这一点，执行会出错），且希望打破 Tair 集群的Lua限制，可以在控制台将 script_check_enable 修改为 0，则后端不会对脚本进行校验，但仍需要使用KEYS数组至少传递一个key，供...
Lua脚本规范与常见报错
说明 若您能够在代码中确保所有操作都在相同slot（如果不能保障这一点，执行会出错），且希望打破 Redis 集群的Lua限制，可以在控制台将 script_check_enable 修改为 0，则后端不会对脚本进行校验，但仍需要使用KEYS数组至少传递一个key，...
创建服务项目
绑定应用或者被组合API引用时，拦截不允许发布：API绑定应用或者被组合API引用时，不允许新版本发布到线上，保证下游应用和组合API的正常调用。适用于使用范围广，影响面大的重要API，如果变更发布到线上会严重影响下游时可以拦截。被组合...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
CVE-2023-27492漏洞公告
Istio下的 Lua过滤器存在拒绝服务的风险。攻击者可以对启用Lua过滤器的监听器发送较大的请求体，并触发istio-proxy进程崩溃。本文介绍CVE-2023-27492漏洞的影响范围、漏洞影响和防范措施。关于CVE-2023-27492漏洞的详细描述，请参见 CVE-...
查看及管理API
说明 若API已被应用绑定或被组合API引用时，新版本发布到线上会影响API的调用，会根据API所属项目配置的发布管控机制，判断是否允许新版本发布到线上。版本管理：若下游应用调用API的API_ID无法修改，在API的数据源或查询条件发生变更后，...
OpenAPI列表
OpenAPI能够提供灵活多样的功能，是所有模块都要提供的标准能力，需购买对应功能模块的OpenAPI后方可使用。本文为您介绍OpenAPI支持的功能。运维 通过该API模块，用户可构建个性化的运维工具，通过API可完成节点及实例的相关操作，又可以...
横向网关产品特性汇总
预热（无损上线）：适用于新扩容业务节点平滑上线的场景，例如，典型的Java应用在新扩容时需要请求流量从小到大线性增加，以保证程序对数据库链接等做预热。一致性哈希ring_hash算法：适用于需要根据Header某些字段做流量调度的场景。一致...
Redis配置参数列表
标准❌ 集群✔️ 读写分离✔️ 标准❌ 集群✔️ 读写分离✔️ 标准️️❌ 集群✔️ 读写分离✔️ 标准️️❌ 集群✔️ 读写分离✔️ ❌ readonly_lua_route_ronode_enable 开启或关闭只读副本的Lua执行模式，可选值：0：默认值，关闭Lua...
- 产品推荐
- 这些文档可能帮助您