DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
客户端调用API示例
X-Ca-Stage:RELEASE#请求 API 的 Stage，目前支持 TEST、PRE、RELEASE 三个 Stage，大小写不敏感，API 提供者可以选择发布到哪个 Stage，只有发布到指定 Stage 后 API 才可以调用，否则会提示 API 找不到或 Invalid Url。X-Ca-Key:60022326...
通过注册方式创建API
是否必填 必填参数，若在调用API时不传参数值，则API调用失败。返回参数 参数名 对外开放的参数，API返回时最终展示给用户的参数名称。128字符以内。参数类型 返回参数类型包括 DOUBLE、FlOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN...
日志脱敏插件（仅专享实例）
匹配模式（MatchMode）：在Location为请求或响应的Body时必填，MatchMode定义了用于匹配敏感信息的正则表达式，无需指定Parameters。例如匹配特定长度的数字、邮箱地址、身份证号等。3.配置详情 在配置脱敏规则时，您可以自定义Name和...
API管理
例如，企业所购买的总流量为每秒查询率是500，如果 单位时间 选择 sec，则 API流量限制 填写的数据应该小于等于500。App流量限制 填写API的下游App的流量控制。填写 APP流量限制 的规则：APP流量限制 对API下的所有App生效。APP流量限制 ...
API安全
API安全模块基于内置检测机制和自定义检测策略，自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务的API资产，检测API风险（例如未授权访问、敏感数据过度暴露、内部接口泄露等），通过报表还原API异常事件，...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
通过脚本模式生成API
如果不开启 返回结果分页，则API默认最多返回2000条记录。如果返回结果可能超过2000条，请开启 返回结果分页 功能，开启后，您可以进入右侧导航栏的 服务资源组 页面，根据资源组类型设置单页条数上限。说明 当数据服务的API在编辑页面右侧...
调用服务
本文介绍API消费方应用调用API的多种方式。背景信息 API消费方应用调用API有多种方式，例如HTTP API、HSF API、WebService API等。其中HSF API的消费调用沿用HSF原有的服务调用方式，无需任何专用SDK，如有必要可以指定CSB的服务IP进行HSF...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
通过服务编排的方式创建API
是否必填 必填参数，若在调用API时不传参数值，则API调用失败。请求参数映射关系 解析脚本中引用的子API，返回脚本中引用的子API以及请求参数。在调用子API时，根据映射关系，将组合API的入参值传给子API的请求参数进行调用。如果子API请求...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
API调试及自助排错
API网关支持用户对配置在API网关中的已发布API进行在线调试，本文重点介绍如何通过API调试中的自助排错功能进行调试过程中的问题排查。1.概述 API控制台支持对已发布API进行调试，而在调试过程中遇到问题时，如何理解报错信息并快速定位和...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
管理路由规则
编辑路由规则 说明 如果当前路由规则已绑定 API，则无法被编辑。需前往 API 编辑页面，将对应 API 的路由规则替换为其他路由规则后，方可编辑当前路由规则。在 路由规则 页面，通过以下任一方式打开路由规则编辑界面：在路由规则列表页，...
管理参数映射
绑定的 API：列出了绑定了该映射规则的所有 API 及其基本信息，包括 API 名称，API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情：...
DataWorks数据服务
如果 API测试 对话框页面底部显示 测试成功，则表示API测试通过。您也可以使用数据服务的测试API模块来完成测试，详情请参见 测试API。发布并查看API。在API编辑页面，单击顶部菜单栏右侧的 发布。发布API至API网关，并上架至API市场，详情...
管理外部授权 API
在 外部授权 API 页面，您可以根据业务需要，进行以下操作：查看外部授权 API 在外部授权 API 列表页，您可以查看外部授权 API 的概览信息，包括外部授权 API 名称、协议类型、请求路径/接口名称、后端服务类型、绑定 API 数量以及创建时间...
管理系统集群
绑定的API：列出了绑定了该系统集群作为后端服务类型的所有 API 及其基本信息，例如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 ...
产品计费
计费方式 API 网关目前是按接口调用数进行计费，是一种先使用后付费的计费方式，即根据单月内某个用户使用网关，进行有效调用 API 的请求累计次数进行阶梯计费，此外不收取其他任何费用。计费规则 网关以每小时作为计费周期，在计费周期内...
概述
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
API 限流
API 限流不仅支持对单个 API 进行限流设置，还支持对 API 设置限流默认值以及设置应用级别的限流总值，避免高峰期间后台服务器被压垮。如果同时设置了 API 限流默认值和 App 限流总值，则按照限流值的大小依次处理，限流值较小的优先生效。...
管理应用
在 应用管理 页面，您可以根据业务需要，查看并管理已创建的应用。编辑应用信息 打开应用编辑界面有以下两种方式：在应用列表页，单击应用右侧 操作...说明 如果当前应用已订阅 API，则无法被删除，需前往 API 详情页 解除绑定 后再删除应用。
TCP连接超时时间配置
警告 如果不按照这个原则进行配置，那么在用户后端服务延时较大的情况下，客户端会在API网关返回应答前提前关闭TCP连接，导致API网关在应答的时候找不到可用的TCP连接报N502RE的错误，严重的时候可能会产生雪崩效应。这个配置请务必关注。...
授权API
在API发布后，您可以将API授权给他人，或获取他人已授权的API，以实现数据共享。本文为您介绍如何对API进行授权及不同场景下API的授权方案。前提条件 仅支持对已发布的API进行下线、授权和变更协议等操作，详情请参见 发布API。进入API管理...
断路器插件（仅专享实例）
1.断路器概述 断路器是API网关在后端出现性能问题时保护系统的内置机制，默认配置下，当某个API的后端在30秒钟内出现1000次超时，系统会触发断路器保护，断路器进入打开状态，断路时间为90秒，90秒内所有的请求均快速返回Status=503,X-Ca-...
路径匹配规则
API 网关支持 绝对匹配、参数匹配 和 前缀匹配 三种路径匹配规则。绝对匹配 绝对匹配，表示只有请求的路径和配置的路径完全一样时才能匹配成功。示例 例如，当前 API 的匹配规则为 GET/path。请求示例：请求一：curl ...
通过直连数据源模式创建API
调用API过程中如果超过了设定的 超时时间，则调用API时会报错，便于您及时发现并处理调用API的异常情况。异常情况查看，详情请参见 查看及管理运维监控API。最大返回条数 API最大的返回条数为10000条。支持输入1~10000之间的正整数。当 ...
管理授权对象
在 授权管理 页面，您可以根据业务需要，查看并管理已创建的授权对象。编辑授权对象 打开授权对象编辑界面有以下两种方式：在授权列表页，...说明 如果当前授权应用已绑定 API，则无法被删除，需前往 API 详情页 解除绑定 后再删除授权应用。
DeleteSignature-删除后端签名密钥
接口说明 此功能面向开放 API 的用户 此功能效果是删除已经存在的后端签名密钥 调用该接口时，若要删除的密钥已经绑定了 API，则不能删除。需先解除绑定关系，再调用该接口操作删除 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...
DeleteIpControl-删除IP访问控制
接口说明 此功能面向 API 提供者 若该访问控制已经绑定了 API，则需要先解除绑定才能操作删除，否则会报错 删除一个不存在的 IP 访问控制，会直接返回成功 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
管理API
DMS数据服务提供了功能强大、开发便捷的API模块，本文介绍新增API、发布API、测试API的操作步骤。前提条件 已开通 API网关。步骤一：新增API 登录 数据管理DMS 5.0。在顶部菜单栏中，选择 集成与开发（DTS）>数据应用>数据服务。说明 若您...
存证服务API
如果此时正处于与备份节点的连接中，则会断开与备份节点的连接，重新选择主节点连接。总之，由于联盟链网络一般都是跨机构，只有机构自己的节点（主节点）有最好的网络环境，其它备份节点（一般是别的机构的节点）的网络延迟都较大，所以...
DeleteTrafficControl-删除指定的用户自定义流控策略
接口说明 此功能面向开放 API 的用户 若该策略已经绑定了 API，则需要先解除绑定才能操作删除，否则会报错 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...
通过向导模式创建API（服务单元）
向导模式基于服务单元，通过可视化界面配置API参数的方式创建API。本文为您介绍如何使用向导模式生成API。前提条件 基于服务单元生成，需先完成服务单元的创建。具体操作，请参见 创建服务单元。使用限制 支持 服务项目管理员 和 开发用户 ...
- 产品推荐
- 这些文档可能帮助您