简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API 流量治理
请求参数 名称 类型 是否必填 示例 描述 api_id STRING 否 NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSrsQw3 API 标识 param ApiCacheVO 否-缓存配置信息 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 ...
创建后端服务为HTTP的API
步骤3 API基本信息 本环节是定义API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择刚刚创建的分组，写入对应配置，安全认证这里选择 APPcode（header&Query）认证。步骤4 定义API请求 本环节是定义client端（如...
发布API商品
3 API网关上配置并发布API 3.1 概述 注意：需要使用入驻成功后的服务商账号在API网关上进行配置，否则在云市场服务商控制台上将无法获取到配置好的API信息。以下图的API商品为例，介绍如何在API网关上进行配置。3.2 创建API分组 首先需要在...
服务接入点
2 apigateway.ap-northeast-2.aliyuncs.com 马来西亚（吉隆坡）ap-southeast-3 apigateway.ap-southeast-3.aliyuncs.com apigateway-vpc.ap-southeast-3.aliyuncs.com日本（东京）ap-northeast-1 apigateway.ap-northeast-1.aliyuncs....
TCP连接超时时间配置
在API网关配置的后端服务超时时间（APIGatewayBackendTimeout）根据上图的图示，我们可以看到：ClientReadTimeout=T2+T3+T4+T5 APIGatewayBackendTimeout=T2+T3+T4 因此我们在配置ClientReadTimeout和APIGatewayBackendTimeout的时候，一定...
概述
CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：DescribePluginApis 查询API绑定的插件：DescirbePluginsByApi 5....
函数计算
Control,Range,Content-MD5 Access-Control-Max-Age:172800 X-Ca-Request-Id:16E9D4B5-3A1C-445A-BEF1-4AD8E31434EC x-custom-header:header value {"message":"Hello World!input":{"body":"{\"bodyParam\":\"testBody\"}","headers":{...
WAF接入配置
2 前提条件 开通Web应用防火墙 在API网关上已经发布了API 3 操作步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。绑定成功后如下图所示：重要 由于后续步骤中还需配置WAF，建议当前阶段绑定域名时使用TXT解析。...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
管理API
管理API是CSB提供给用户和第三方开发者使用的CSB管理接口。API访问 访问地址 目前已部署5个地域，后续会根据需要开通其他地域的管理API。各个区域的访问地址如下表：地域 访问地址 华东1（杭州）csb.cn-hangzhou.aliyuncs.com 华东2（上海...
DetachApiProduct-解除API与API产品的绑定关系
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID ba84c55eca46488598da17c0609f3ead StageName string 是 环境名称，取值...
AttachApiProduct-将API绑定到指定API产品
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID 551877242a4b4f3a84a56b7c3570e4a7 StageName string 是 环境名称，枚举...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
DescribeHistoryApis-查询API发布版本定义列表
5af418828f0344a3b588c0cc1331a3bc Description string API 描述 创建对象接口 GroupName string API 分组名称 myGroup2 GroupId string API 分组 ID 1084f9034c744137901057206b39d2b6 DeployedTime string 发布时间(格林威治时间)2016-07...
创建后端服务为VPC内资源的API
本文将快速引导您如何在API网关中，发布后端服务为VPC内资源的API，并如何使用"阿里云APP"认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1....
导入API网关的扩展Swagger定义
现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0，可以创建API实体的Swagger定义，并将Swagger导入API网关用于批量创建或者更新API...
RemoveVpcAccess-撤销 VPC 授权
接口说明 此功能面向开放 API 的用户 撤销 API 网关访问您 VPC 实例的权限 说明 删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...
使用 RAM 管理 API
格式：acs:apigateway:$regionid:$accountid:apigroup/$groupId 示例：acs:apigateway:*:*:apigroup/cbd157704e624ab58a204fd3e0b5ad79 请结合 API 网关的API 手册来查看下表：action-name 接口描述 资源（Resource）CreateApiGroup 创建...
概述
1 如何创建API 创建API的方式有三种：通过控制台创建API、通过管控API创建API、通过导入Swagger创建API 通过控制台创建API 登录阿里云API网关控制台，左上角选择地域，然后在分组中创建API。具体步骤可参考 创建 API 使用管控API创建API ...
版本说明
变更时间：2024-01-25 变更集发布说明：OpenAPI 名称 变更内容概要 操作 SetRenewal API 内部配置变更，不影响调用。查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更，不影响调用。变更时间：2023-12-13 变更集发布说明：...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
流控信息
API名称 API版本 配额 配额维度 QueryOrders 2017-12-14 10/1(s)地域：*API限速维度：regionId,API,ParentUid QueryProductList 2017-12-14 10/1(s)地域：*API限速维度：regionId,API,ParentUid UpgradeResourcePackage 2017-12-14 100/60...
我可以创建多少API分组？
分组的数量限制如下。每个账号下，每个Region的API...每个账号下，每个Region默认最多创建5个未绑定域名的API分组，如果在此Region中有绑定域名的API分组，则未绑定域名的API分组总数上限为20个；支持通过 提交工单 申请增加API分组数量限制。
如何获取错误信息
BBAF-EFB340E0A5AF/API网关返回的错误消息，当请求出现错误时API网关会通过响应头将错误消息返回给客户端 X-Ca-Error-Message:Invalid Parameter Required `field1`/API网关系统错误码，当请求出现错误被网关拦截后，由API网关提供的错误码...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
DescribeDeployApiTask-查询发布API任务进度
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
混合云API集中管理
本文介绍了如何结合云企业网（CEN），构建跨Region的集中式API管理方案。同时您也可以参考本例中的步骤，结合CEN、高速通道，构建在VPC间、VPC与本地数据中心间的集中式API管理，从而实现全网资源都可以发布在API网关、并通过API网关进行...
版本说明
变更时间：2021-12-21 变更集发布说明：调整评价接口必填字段 OpenAPI 名称 变更内容概要 操作 EvaluateTicket OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更项 变更内容 错误码 OpenAPI 错误码发生变更。删除错误码：500 ...
- 产品推荐
- 这些文档可能帮助您