HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API基础定义是什么
可以配置您 API 被访问的方式，包含：http 或 https ，以及使用 HTTP 方法，目前网关支持所有标准的 HTTP 方法。
产品使用是怎么收费的？
按 API 被调用的次数、使用的流量及指定的缓存大小收费，公测期间免费。
错误代码表
请从内网调用，文档参考 私网调用API A403VN 403 Access from invalid VPC is disabled 来源VPC被阻止 A403AC 403 Access Control Forbidden by${RuleName} 被`授权控制`插件阻止 A403CO 403 Cross origin resource forbidden${Domain} 被...
操作流程
上线API 通过上线API操作才能使API被调用。服务调用流程（工作组内）及说明 流程图 流程说明 流程 说明 API调试 通过调试API，了解API运行结果详情。代码调用 根据需求，对API进行调用。监控诊断 对API进行实时监控，随时掌握API的使用情况...
断路器插件（仅专享实例）
错误代码 HTTP状态码 Message 描述 D503BB 503 Backend circuit breaker busy API被断路器阻止。D503CB 503 Backend circuit breaker open,${Reason} API处于熔断/断路器开状态，请检查后端性能后稍后再试。5.使用限制 仅专享实例生效。...
函数概述
数据服务支持您编写函数，并将函数关联至API，使得函数可以作为API的过滤...如果将函数设置为API的后置过滤器，当API被调用时，函数可以对API的返回结果进行二次加工和改造。常见场景的代码示例请参见：使用Aviator函数作为过滤器的最佳实践。
操作流程
服务报表 API被调用后，支持进行服务调用汇总展示，以及查看服务调用明细和调用趋势。服务调用流程（API共享）及说明 流程图 流程说明 流程 说明 创建应用 对API的应用管理，按应用获取密钥和访问域名信息供外部调用已获得授权API。数据...
上线API
API上线后，才能使API被调用。数据服务API的上线方式相似，本文以数据服务API上线为例介绍如何上线API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式创建数据服务API 操作步骤 登录企业...
API调用统计
API调用统计功能可以统计API被调用的详细信息，包括 开放API 和 数据服务 API。该功能仅对组织管理员可见。功能入口 您可以按照图示步骤进入API调用统计页面。API调用统计 在 API调用统计 页面，您可以查看 开放API 或 数据服务 API的 今日...
上线API
API上线后，才能使API被调用。数据服务API、数据上报API、三方API、空间服务API 的上线方式相似，本文以数据服务API上线为例介绍如何上线API。前提条件 已创建下面任意一种API，具体操作，请参见：使用向导模式创建数据服务API 使用SQL模式...
ModifyVpcAccessAndUpdateApis-修改VPC授权信息，并且...
名称 类型 描述 示例值 object OperationId string 异步任务 ID 说明 如果关联 API 被刷新，可使用任务 ID，调用 DescribeUpdateVpcInfoTask 接口，查询更新结果。7b6d0cb72b2e4215b0129f675c889746 RequestId string 请求 id C2CEC6EA-...
授权API
如果已授权的API被下线或修改后重新发布，则需要API的负责人对新发布的API重新授权。单击相应API后的 测试，进入 API测试 页面测试API。详情请参见 测试API。鼠标悬停至相应API后的 更多，单击 协议变更。在 API协议变更 对话框中，设置...
基本概念
通过DashScope，丰富多样化的模型不仅能通过推理API被集成，也能通过训练微调API实现模型定制化。DashScope为AI模型提供云原生的Serverless服务，使得开发者无需关注模型服务API背后的服务器管理，也可直接获得稳定可靠的服务。此外...
API调试及自助排错
当请求被API网关拦截时，API网关会返回相应的 错误信息，并附有简单的 错误原因说明（X-Ca-Error-Message），可以根据该部分内容排查错误原因。更多错误码解释请参考 错误代码表。2.1.2.后端服务报错 当本次调用的 HTTP状态码 不为200，且 ...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走内网调用。API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关...
API 类商品接入说明
按量售卖（后付费）：如果您的 API 服务不是仅仅依赖使用次数计费，而是依赖 API 被调用后需要消耗的后端资源来进行计费，则选择按量售卖模式。按量模式可配置响应的资源包，即客户如果购买资源包，则会优先消耗资源包内的配额，当超出资源...
UpdateScoreForApi-编辑评分大项
无替代API，历史原因导致该API被标记为弃用。编辑评分大项。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求...
InsertScoreForApi-创建评分大项
无替代API，历史原因导致该API被标记为弃用。创建评分大项。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求...
DeleteScoreForApi-删除评分大项
无替代API，历史原因导致该API被标记为弃用。删除评分大项。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求...
DeleteUser-删除用户
无替代API，历史原因导致该API被标记为弃用。该接口已废弃，请勿接入。接口说明 调用该接口删除用户，仅仅是将用户从智能对话分析服务的用户列表中删除，解除智能对话分析服务的使用权限，并未真正删除该用户，所以如果误删可以再次导入...
DDoS防护接入配置
针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大...您的API由于受到黑客DDoS攻击而导致被API网关限制的请求，不会被计入API网关SLA的错误率统计。您可以购买阿里云的DDoS高防产品配合API网关使用，避免因为DDoS攻击导致的业务中断。
后端服务调不通
请保证安全组可以被API网关的出口IP段访问。需要强调，API网关访问外部的出口IP不能保证不会变动，通过设置安全组来判断请求来源的方法可能会由于API网关出口IP变化而导致API网关访问后端服务失败，因此我们不建议使用安全组方法。API网关...
功能概览
请求转发 支持参数清洗，包括参数类型、参数值（范围、枚举、正则）校验，无效校验会被 API 网关直接拒绝；支持参数映射，实现前端、后端请求信息映射；安全防护支持多种认证方式 支持 HMAC(SHA-1，SHA-256)算法签名；支持HTTPS双向认证、...
可重复基础设施
例如，运维人员通过控制台创建、配置和监控云服务器、数据库、存储等资源，查看和处理系统告警和日志，业务人员可以通过控制台访问应用程序和查看业务数据等等。总之，这类用户一般不需要编写代码，通过相对简单的操作即可与云资源交互。...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
D504CO错误码排查
请保证安全组可以被API网关的出口IP段访问。排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截；若后端是VPC类型，链路涉及到跨Region或是通过云企业网访问的IDC机房，则需要配置回程路由，文档可以参考 访问...
参数映射与校验规则
入参映射（过滤未知参数）模式：API网关会根据用户配置的所有参数执行校验与映射，如果客户端传递了未在配置中的参数，参数将会被API网关过滤掉，不会转发给后端，详细请参考 章节4。入参映射（透传未知参数）模式：在此模式下，如果用户...
VPC融合专享实例
如果您的其他服务在其他网段中，需要被API网关访问，可以手动添加。步骤如下：登录API网关控制台，左侧导航栏选择 实例，进入实例列表；找到要操作的VPC融合类型专享实例，单击 VPC可被访问网段 的 新增；添加网段支持两种方式：按列表选择...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
Zookeeper
4.2 注册微服务应用 微服务应用也需部署在步骤3中选择的【VPC-可用区-交换机】下，这样才能确保微服务能够成功注册到Zookeeper并能够被API网关成功访问。可以选择将微服务应用部署在ECS中，该ECS需创建在步骤3中指定的交换机下。注册到...
专享实例集群
专享实例的配置如 IPv6入口能力，IPv6出访能力，是否允许被API网关自身调用 不同时，无法将实例添加到集群中；专享实例的配置如 HTTPS安全策略，入访VPC，IPv6 访问控制，IPv4 访问控制，自定义内网网段 不同时，专享实例的配置会被集群的...
IP访问控制插件
黑名单：您可以配置 IP 黑名单，黑名单中 IP 的访问将被 API 网关拒绝。重要 IP访问控制插件仅支持Ipv4地址，不支持Ipv6地址。2.插件配置 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索 yaml to json 转换...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
创建服务项目
被组合API引用时，拦截不允许发布：API被组合API引用时，不允许新版本发布到线上，保证组合API的正常调用，调用受影响的应用由开发人员线下通知对应负责人。适用于API变更后发布到线上可以保证能及时通知应用负责人调整应用的调用配置，...
- 产品推荐
- 这些文档可能帮助您