简介

API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经备案且解析至...

开放平台概览

DataWorks开放平台提供开放API(OpenAPI)、开放事件(OpenEvent)、扩展程序(Extensions)的能力,可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维,及时响应应用系统对接DataWorks的业务状态...

开放平台:能力全面开放

DataWorks开放平台提供开放API(OpenAPI)、开放事件(OpenEvent)、扩展程序(Extensions)的能力,可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维,及时响应应用系统对接DataWorks的业务状态...

HTTP自动跳转HTTPS

您可以通过配置自动跳转功能...操作步骤 登录 API网关控制台。左侧栏点击开放API,选择分组管理,找到目标分组,点击进入分组详情页。在分组详情页找到独立域名栏,开启指定域名的HTTP自动跳转HTTPS功能。点击确认,http的自动跳转开启成功。

如何关闭公网访问

操作步骤如下:登录API网关控制台,在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组,单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到 关闭公网访问 按钮,单击确定后即可关闭公网访问。...

支持 HTTPS

步骤2:绑定SSL证书 准备好以上材料,需要进行如下操作进行,登录API网关管理控制台【开放API】-【分组管理】,单击您需要绑定SSL证书的分组,查看分组详情。在绑定SSL证书,您首先需要您在API分组上绑定【独立域名】。【独立域名】-添加...

DeleteAllTrafficSpecialControl-删除所有特殊流控

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...

配置后端服务Host(域名头)

Host概述 当后端服务器同一个IP上存在多个Web应用程序(站点)时,就需要配置Host域名头,Host域名头可以指定API网关要访问的后端服务。常见应用场景如下:API网关后端服务配置的是VPC类型,并且VPC资源内有多个站点时,需要通过Host头指定...

DeleteTrafficSpecialControl-删除特殊流控

接口说明 此功能面向开放 API 的用户 接口需要用到的入参可以调用其他接口获取 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无...

DescribeRegions-查询支持的区域

接口说明 查询支持的区域列表 此功能面向开放 API 和调用 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透...

API网关监控

4.2 左侧栏选择 开放API —— API列表。点击想要查看监控的API,进入API详情页。4.3 在左侧栏选择 监控信息,可以根据环境(线上、测试、预发)查看该API近一周的监控数据。监控指标包括:请求次数(成功、异常)流量(上行、下行)后端...

应用场景

API 网关为您在各种场景下开放API 提供支撑,具体有:支持建立 API 生态,将 API 开放给合作伙伴、开发者,实现企业核心能力的货币化;支持将 API 适配多端,如:移动、互联网、物联,实现系统前后端分离;支持内部系统整合,模块化、微...

API网关-事件总线服务关联角色

操作步骤如下:进入 API网关控制台,在左侧导航栏选择 开放API-后端服务;在搜索框,通过后端服务类型 EventBridge 搜索后端服务,在右侧操作列点击 删除;进入 RAM控制台,点击左侧菜单 RAM 角色管理,找到角色 AliyunServiceRoleForApi...

RemoveIpControlApis-解除API与IP访问控制的绑定

接口说明 此功能面向开放 API 的用户 即时生效,解除后该 API 的对应环境将不会有 IP 访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...

SetIpControlApis-绑定IP访问控制与API关系

接口说明 此功能面向开放 API 的用户 支持多个 API 批量操作,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权...

名词解释

独立域名 开放API服务,需要为分组绑定独立域名。客户通过访问该独立域名调用API。签名密钥 API服务方可以创建签名密钥并绑定到API上,网关到服务方后端的请求就会带上签名信息,用于后端的安全验证。流量控制策略 用于API服务方对API、...

RemoveSignatureApis-解除API与后端签名密钥的绑定

接口说明 此功能面向开放 API 的用户 即时生效,解除后网关到后端服务的请求将不带有签名字符串,请后端去掉相应的校验环节 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动...

RemoveTrafficControlApis-解除API与流控策略的绑定

接口说明 此功能面向开放 API 的用户 用于解除 API 与流控策略的绑定关系,支持 API 批量,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。...

SDK下载及使用指南

若您需要使用 SDK 调用您自己或者其他人在 API 网关开放API 服务(包括在 API 市场购买的 API 服务)注意这里的 API 服务是指在 API 市场购买的,或者您在 API 网关接入开放的,或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...

DeleteApi-删除 API 定义

接口说明 此功能面向开放 API 的用户,此操作不可逆 API 在运行环境中运行,则不允许删除,需要先调用 AbolishApi 操作下线 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算...

为分组绑定插件

3.快速使用 登录API网关控制台,左侧栏找到 开放API —— 插件管理。单击右上角创建插件,在页面中自定义插件名称,选择插件类型,配置插件规则。配置好插件规则后,点击创建,随后在插件列表中就可以看到刚刚创建的插件了。点击右侧的绑定...

DeployApi-发布 API

接口说明 此功能面向开放 API 的用户,定义的 API 只有发布到运行环境,才能被调用 API 发布到集群里需要一定的时间,最长 5 秒后生效 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,...

AbolishApi-下线 API

接口说明 此功能面向开放 API 的用户,和发布 API 相对应 将指定环境中运行的指定 API 从运行环境里删除,需要一定的时间,最长不超过 5s API 下线后将不能被调用(指定环境)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算...

DeletePlugin-删除插件

接口说明 此接口面向开放 API 的用户。必须先解除 API 和插件的绑定关系,否则删除报错。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下...

DescribeSignaturesByApi-查询API绑定的后端签名密钥

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...

DescribeTrafficControlsByApi-查询API绑定的流控策略

接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 ...

AttachPlugin-绑定插件到API

接口说明 此接口面向开放 API 的用户 绑定操作只能选择发布状态的 API 绑定以后及时生效 修改插件后及时生效 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例...

VPC内网访问API网关

配置方法:在 API网关控制台->开放API->分组管理->分组详情,点击“开通VPC二级域名”,网关会自动给该分组创建一个内网VPC二级域名,通过该域名可以直接访问API。3.专享实例设置方式 专享实例的VPC内网访问能力仅只对某一个VPC开放,其他...

创建后端为函数计算的API

步骤9 创建应用 在 调用API 菜单中选择 应用管理,创建一个APP,如下图所示。可以看到阿里云APP下有两种认证方式,AppKey和AppCode。本例中我们选择使用APPCode的方式进行简单认证。关于阿里云APP的更多描述可见此文档 API授权。步骤10 对...

DeleteSignature-删除后端签名密钥

接口说明 此功能面向开放 API 的用户 此功能效果是删除已经存在的后端签名密钥 调用该接口时,若要删除的密钥已经绑定了 API,则不能删除。需先解除绑定关系,再调用该接口操作删除 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您...

DeleteTrafficControl-删除指定的用户自定义流控策略

接口说明 此功能面向开放 API 的用户 若该策略已经绑定了 API,则需要先解除绑定才能操作删除,否则会报错 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...

授权管理

API授权:2.1 登录 API网关控制台,在左侧栏选择 开放API —— API列表,单击API后的 更多,选择 授权。2.2 选择要授权的环境,和要授权的应用。左侧为我的应用,此时直接单击搜索,会自动加载本账号下的APP。如果要给其他账号下APP授权,...

ModifyPlugin-修改插件

接口说明 此接口面向开放 API 的用户。插件不允许重名。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM...

SetTrafficControlApis-添加指定流控策略与API的绑定

接口说明 此功能面向开放 API 的用户 用于添加 API 与策略的绑定关系,支持多个 API 批量操作,最多 100 个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例...

ModifySignature-修改后端签名密钥

接口说明 此功能面向开放 API 的用户 用于修改某个已存在的签名密钥的名称、Key 和 Secret 需要注意,修改立即生效,若该密钥已经绑定 API,后端做验证时请及时调整为针对新签名字符串的验证 该接口调用的 QPS 限制为:单用户 QPS 不超过 ...

使用SDK调用API

1.2 在 开放API 的 SDK/文档自动生成 中下载API分组的SDK。此SDK是基于分组生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java、GOlang、TypeScript。2.使用SDK调用API 通过控制台下载的SDK,下载解压后的目录结构如图:SDK...

产品简介

通过开放API,可以大大提高各个环节的协作效率,促成更加健康的商业生态。支持实时监控,提供API监控面板,您可以实时查看API服务详情,帮助快速定位问题。跨界创新。API即能力、API即数据,通过API可以进行创新。一方面可以将您的算法、...

AddTrafficSpecialControl-添加特殊流控配置

接口说明 此功能面向开放 API 的用户 若传入的 SpecialKey 已经存在,则会直接覆盖之前的配置,请慎重操作 注意特殊流控是添加到已存在的指定流控策略下的,添加后特殊流控策略将对该策略下的所有 API 生效 调试 您可以在OpenAPI Explorer...

SetVpcAccess-添加 VPC 授权

接口说明 此功能面向开放 API 的用户。授权 API 网关允许访问您的 VPC 实例。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应...

CreateTrafficControl-创建流控策略

接口说明 此功能面向开放 API 的用户 策略创建后,未绑定 API 前是无意义的,绑定 API 后,对绑定的 API 即时生效 该接口调用的 QPS 限制为:单用户 QPS 不超过 50 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 智能开放搜索 OpenSearch 视觉智能开放平台 对象存储 短信服务 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用