基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
AttachApiProduct-将API绑定到指定API产品
将API绑定到指定的API产品（如果指定的API产品不存在，将自动创建）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
DetachApiProduct-解除API与API产品的绑定关系
解除API与API产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...
事件总线
本文将快速引导您如何在API网关中，发布后端服务为事件总线类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
创建后端服务为VPC内资源的API
本文将快速引导您如何在API网关中，发布后端服务为VPC内资源的API，并如何使用"阿里云APP"认证中的AppCode进行调用。概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1....
基于Swagger完成API网关与用户CICD流程整合
该方法的核心是以swagger为桥接，通过API网关的ImportSwagger接口来完成您的API的自动创建和更新。一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关...
对象存储
本文将快速引导您如何在API网关中，发布后端服务为对象存储（OSS）类型的API，并如何使用“阿里云APP“认证中的AppKey和AppSecret进行调用。1.概述 您需要依次完成以下步骤：开通对象存储（OSS）服务 创建分组 创建并定义API 创建应用和API...
DetachPlugin-解绑API绑定的插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DetachPlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 绑定的 API 网关插件 ID 05df2b52a3644a3a8b1935ab8ab59e9d GroupId string 是 指定...
创建后端服务为HTTP的API
6 调用API 通过上述步骤，您已经创建API、创建APP、建立了授权关系，调试API完成，并将API发布到线上环境，本阶段将会模拟如何通过调用API网关提供的SDK，来在您的业务系统中调用发布好的API。步骤11 调用API 1、在 API调用 中找到 SDK，...
DescribeApiMarketAttributes-获取API的属性
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
Zookeeper
本文将介绍API网关集成Zookeeper访问微服务后端的原理，以及如何创建、发布并调用服务发现类型的API。1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建...
测试API
同时您也可以对已发布的API进行测试。本文为您介绍如何测试开发中和已发布的API。背景信息 API测试本质上是直接访问实际数据源或后端服务来调用API，会占用数据服务资源组产生数据服务资源组费用，计费详情请参考 数据服务计费说明。测试...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
Nacos
API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
Path是什么？
Path 是您的 API 调用时展示给客户的固定路径，也是 API 的标识，在同一分组下 HTTP Method+Path 不可以重复。在 Restful API 中，一般表示为资源，格式为资源/子资源，如：instance/disk。Path 中支持动态参数，用[param]表示，如：...
API名称是什么
名称是 API 的标识，一个有意义的名称，可以让您的用户能够快速理解 API 的功能。
数据服务入门
DataWorks数据服务的主要目标是为个人、团队和企业构建统一的数据服务总线，帮助用户统一管理面向内外部的API服务。例如，您可以将查询数据表功能快速的生成对应的API，或将已有的API注册至数据服务平台进行统一发布和管理。本文以MySQL...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
发布API
如果您的API是为了供自己的应用程序调用，需要在API网关中创建应用，将API授权到应用中，然后通过AppKey和AppSecret加密签名调用，详情请参见 客户端调用API示例。同时API网关提供了主流编程语言的SDK，您可以快速集成API至自己的应用中，...
CreateMonitorGroup-创建监控报警分组
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
CreateApiGroup-创建API分组
接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...
基于RAM实现权限控制
常见云助手功能涉及的自定义策略如下表所示：云助手功能 自定义策略示例 云助手 云助手管理员权限（可读可写）云助手查看权限（只读）设置云助手的地域限制 云助手Agent 查询云助手Agent安装状态 安装云助手Agent 查询和修改云助手Agent...
Workbench终端助手
Workbench的终端助手是基于大语言模型的智能助手，帮助您快速生成运维中需要的脚本/命令。例如：传输文件中忘记创建文件命令，扩容云盘时忘记扩容命令，此时，可以通过终端助手快速查询。计费说明 当前终端助手为免费试用。使用限制 终端...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
产品优势
方便开发者开发出支持阿里云服务的API接口，并通过API接口获取数据、控制服务器、管理权限等，从而实现对阿里云资源的全面控制和管理。提供多种编程语言和开发框架的SDK，并为每种语言提供专业的部署指南、简单的调试平台和丰富的场景化...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
订阅云助手事件
云助手的 RunCommand/InvokeCommand 接口为异步接口，调用之后，需要轮询 DescribeInvocations/DescribeInvocationResults 接口查询任务完成状态，直至该任务完成。云助手任务状态事件用于加强对任务完成情况的感知，您可以利用该事件达到...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
SDK下载及使用指南
若您需要使用 SDK 调用 API 网关开放的 OpenAPI 注意这里的 OpenAPI 是指用于操作 API 网关产品的 API。您需要前往 阿里云 SDK 页面下载 SDK 并查看使用。SDK 下载请前往阿里云 SDK 页面各个语言的“获取各产品 XXX SDK”页面下载，若页面...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
- 产品推荐
- 这些文档可能帮助您