HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
API 流量治理
请求参数 名称 类型 是否必填 示例 描述 api_id STRING 否 NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSrsQw3 API 标识 param ApiCacheVO 否-缓存配置信息 tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 ...
API概览
术语表 术语 全称 中文 说明 app application 应用 一个应用即一个完整的搜索服务 错误码 API 描述 错误码说明 返回错误码说明 公共调用方式 API 描述 v3 API 签名机制 详细说明验签过程 应用操作接口 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....
导入API网关的扩展Swagger定义
现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0，可以创建API实体的Swagger定义，并将Swagger导入API网关用于批量创建或者更新API...
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使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
发布API商品
3 API网关上配置并发布API 3.1 概述 注意：需要使用入驻成功后的服务商账号在API网关上进行配置，否则在云市场服务商控制台上将无法获取到配置好的API信息。以下图的API商品为例，介绍如何在API网关上进行配置。3.2 创建API分组 首先需要在...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
创建后端服务为HTTP的API
步骤3 API基本信息 本环节是定义API基本信息，包括API分组、API名称、安全认证方式、API类型、和描述等。选择刚刚创建的分组，写入对应配置，安全认证这里选择 APPcode（header&Query）认证。步骤4 定义API请求 本环节是定义client端（如...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
概述
具体步骤可参考 创建 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...
函数计算
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网关返回...
支持 HTTPS
步骤3：API配置调整 绑定SSL证书后，您可以按API控制不同的访问方式，支持HTTP、HTTPS、HTTP和HTTPS三种，出于安全考虑，建议全部配置成HTTPS。可以在【开放API】-【API列表】找到相应API，【API定义】-编辑-【请求基础定义】中进行修改。...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
API网关中API分组绑定域名接入WAF或者WAF3.0
应用场景 API分组绑定的域名接入WAF可以提供全面的安全防护，减少恶意攻击和非法访问，实时监控和日志记录，并保障API接口的高可用性和可扩展性。风险等级 默认风险等级：中风险。当您使用该规则时，可以按照实际需求变更风险等级。检测...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
版本说明
变更时间：2024-02-26 变更集发布说明：OpenAPI 名称 变更内容概要 操作 QueryAvatar OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。QueryAvatarList OpenAPI 返回结构发生变更...
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....
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
函数计算内网访问API网关
1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...
DescribeApisByIpControl-查询IP访问控制绑定的API
接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
DescribeApisByTrafficControl-查询指定流控策略下已...
接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 ...
API-KEY管理
本文主要介绍如何通过向量检索服务控制台创建、查看和删除API-KEY。前提条件 完成注册阿里云账号，如未注册，请单击 注册阿里云账号 进行注册。完成个人或企业实名认证，如未认证，请单击 实名认证 进行认证。已 创建Cluster。创建API-KEY ...
DescribeApisBySignature-查询签名密钥绑定的API列表
接口说明 此功能面向开放 API 的用户 分页返回 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dyplsapi.aliyuncs.com华北2（北京）cn-beijing dyplsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dyplsapi.aliyuncs.com华北5（呼和浩特）...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dypnsapi.aliyuncs.com华北2（北京）cn-beijing dypnsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dypnsapi.aliyuncs.com华北5（呼和浩特）...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dyvmsapi.aliyuncs.com华北2（北京）cn-beijing dyvmsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dyvmsapi.aliyuncs.com华北5（呼和浩特）...
VPC内网访问API网关
API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...
服务接入点
亚太 地域名称 地域ID 公网接入地址 VPC接入地址 华北1（青岛）cn-qingdao dytnsapi.aliyuncs.com华北2（北京）cn-beijing dytnsapi.aliyuncs.com华北3（张家口）cn-zhangjiakou dytnsapi.aliyuncs.com华北5（呼和浩特）...
- 产品推荐
- 这些文档可能帮助您