简介
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 的，同时也提供了替代访问策略，因为...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
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_id STRING 否 NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSrsQw3 API 标识 param ApiCacheVO 否-缓存配置信息 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 ...
服务接入点
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....
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
WAF接入配置
2 前提条件 开通Web应用防火墙 在API网关上已经发布了API 3 操作步骤 步骤1：在API分组上绑定您的域名，操作过程详见 使用自定义域名调用API。绑定成功后如下图所示：重要 由于后续步骤中还需配置WAF，建议当前阶段绑定域名时使用TXT解析。...
使用摘要签名认证方式调用API
API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...
发布API商品
3 API网关上配置并发布API 3.1 概述 注意：需要使用入驻成功后的服务商账号在API网关上进行配置，否则在云市场服务商控制台上将无法获取到配置好的API信息。以下图的API商品为例，介绍如何在API网关上进行配置。3.2 创建API分组 首先需要在...
创建后端服务为HTTP的API
步骤3 API基本信息 本环节是定义API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择刚刚创建的分组，写入对应配置，安全认证这里选择 APPcode（header&Query）认证。步骤4 定义API请求 本环节是定义client端（如...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
DescribeDeployApiTask-查询发布API任务进度
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
支持 HTTPS
步骤3：API配置调整 绑定SSL证书后，您可以按API控制不同的访问方式，支持HTTP、HTTPS、HTTP和HTTPS三种，出于安全考虑，建议全部配置成HTTPS。可以在【开放API】-【API列表】找到相应API，【API定义】-编辑-【请求基础定义】中进行修改。...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
对象存储
创建存储空间（Bucket）阿里云对象存储OSS（Object Storage Service）是阿里云提供的海量、安全、低成本、高持久的云存储服务，OSS具有与平台无关的RESTful API接口，您可以在任何应用、任何时间、任何地点存储和访问任意类型的数据。...
API 分组
{"param":{"group_name":"apigroup3","api_group_id":"gjrjknp1s4alzubn","description":"abcd"},"tenant_id":"JADDGOCN","workspace_id":"antdemo"} 返回示例 {"data":true,"result_code":"OK"} 通过 ID 查询 API 分组 sofa.apigateway....
DescribeDeployedApis-查询已发布 API 列表
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
批量操作API
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
函数计算
Apache-HttpClient\/4.1.2(java 1.6)","Host":"test.alicloudapi.com","X-Ca-Key":"testKey","Date":"Mon,05 Jun 2017 08:52:43 GMT","Accept":"application/json","headerParam":"testHeader"{"bodyParam":"testBody"} 3.3.3 API网关返回...
混合云API集中管理
主要场景如下：场景一：阿里云跨region内网VPC调用API网关 场景二：本地数据中心IDC机房内网调用APi网关 场景三：API网关内网访问部署在IDC机房的后端服务 场景一 阿里云跨region内网VPC调用API网关 本场景的客户端为北京vpc-3专有网络下的...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
授权信息
无 apigateway:ModifyApi ModifyApi Write 全部资源*无 无 apigateway:ModifyApiConfiguration ModifyApiConfiguration Write 全部资源*无 无 apigateway:ModifyApiGroup ModifyApiGroup Write 全部资源*无 无 apigateway:ModifyApi...
概述
4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...
版本管理
1 编辑API 您可以查看API定义并根据需要进行编辑。操作步骤：1.登录 API网关控制台。2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 ...
样式语法
在模板模式下，页面样式相关 CSS 放置于<style></style>段内，<style></style>段内支持的样式由 通用样式 决定。模板模式<template></template>段内推荐通过 class 对样式进行设置，例如✅。CSS 样式 支持 class、id、type 选择器，不支持...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
流控信息
API名称 API版本 配额 配额维度 DescribeApi 2016-07-14 暂无数据 地域：*API限速维度：/ModifyIpControlPolicyItem 2016-07-14 暂无数据 地域：*API限速维度：/DescribeApiLatencyData 2016-07-14 暂无数据 地域：*API限速维度：/...
版本说明
变更时间：2024-04-18 变更集发布说明：OpenAPI 名称 变更内容概要 操作 DescribeAuthorizedApps OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-04-18 变更集...
流控信息
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...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
API 管理
本文列出了 API 管理相关的所有 OpenAPI 及其请求参数、返回参数。创建 API 信息 sofa.apigateway.api.create 用于快速创建一个 API 服务。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoVO 是-param tenant_id STRING 是 TSCPDICNT...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
使用 RAM 管理 API
格式：acs:apigateway:$regionid:$accountid:apigroup/$groupId 示例：acs:apigateway:*:*:apigroup/cbd157704e624ab58a204fd3e0b5ad79 请结合 API 网关的API 手册来查看下表：action-name 接口描述 资源（Resource）CreateApiGroup 创建...
- 产品推荐
- 这些文档可能帮助您