API 版本管理

API 只有在发布后才能被订阅方使用。创建后的 API 可以根据业务需求进行编辑、下线和编辑重发布等操作。新版本发布上线后，老版本自动成为历史版本被下线。API 版本的生命周期如下：版本说明：每次发布一个版本时，系统为当前版本分配一个...

使用SDK调用API

本文主要引导用户如何通过调用API网关自动生成的SDK，来在业务系统中调用发布好的API。概述 在控制台自动生成的SDK内置了签名实现，可以免去繁琐的签名计算，若需要自行实现签名认证您可以参考 客户端签名说明文档 调用API的前期步骤可参考...

DeleteApi-删除 API 定义

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

ModifyApi-修改API定义

接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...

AbolishApi-下线 API

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

创建后端服务为VPC内资源的API

概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...

概述

4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...

DescribePluginApis-查询插件绑定的API列表

10 TotalCount integer 返回结果总数 7 ApiSummarys object[]API 信息集合 ApiId string API 编号 accc8c68b7294b1cb4928741*Description string API 描述信息 API描述信息 GroupName string API 所属的分组名称 myGroup2 GroupId string ...

DeployApi-发布 API

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

发送 HTTP 请求（Java）

填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...

版本说明

变更时间：2023-07-04 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetTask API 内部配置变更，不影响调用。查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更，不影响调用。CancelTask API 内部配置变更，不影响调用。...

产品简介

API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...

DetachApiProduct-解除API与API产品的绑定关系

解除API与API产品的绑定关系 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例...

DescribeApisByApp-根据应用查询API列表

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

应用场景

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

通过日志服务查看API调用日志

日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...

DescribePurchasedApis-获取购买的 API 列表

RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...

授权管理

API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...

调用API商品

在左侧导航栏选择 调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...

管理应用

编辑应用信息 打开应用编辑界面有以下两种方式：在应用列表页，单击应用右侧 操作 列中的 编辑 即可打开编辑应用界面。单击应用名进入应用详情页后，单击页面右上方的 编辑 即可打开编辑应用界面。打开的 编辑应用 界面与创建应用界面内容...

HTTP API 入门

步骤五：创建应用 在左侧导航栏单击 API 订阅>应用管理 页，单击列表右上方的 创建应用。在 创建应用 窗口，选择 应用类型 为 应用。输入 应用名称，用于识别应用。本例使用 hello。单击 确定。应用添加完成后，订阅者需在应用详情页，获取...

API网关-监控服务关联角色

背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...

CORS 配置

请求参数 名称 类型 是否必填 示例 描述 cors_id STRING 否 cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识 返回参数 名称 类型 示例 描述 data ...

DeleteApiGroup-删除 API 分组

接口说明 此功能面向 API 提供者 分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效 删除不存在的分组时，会返回删除成功 该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试 您...

DeployedApiItem

描述"class="reference-link">描述 列举API信息项的类型 节点名"class="reference-link">节点名 DeployedApiItem 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 ...

API 提供者 Demo

网关支持用户 下载服务端 Demo 进行测试使用，Demo 的代码分支为：server_demo。网关依赖如下：<dependency><groupId>...完成 Demo 的下载后，您可以进行以下多种类型的 API 服务开发与发布：HTTP API 服务 SOFARPC API 服务 DUBBO API 服务

ImportSwagger-通过 Swagger 创建 API

接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...

ApiSignatureItem

描述"class="reference-link">描述 列举API签名密钥信息项的类型 节点名"class="reference-link">节点名 ApiSignatureItem 子节点"class="reference-link">子节点 名称 类型 描述 ApiId String API编号 ApiName String API名称 SignatureId...

CreateApiGroup-创建API分组

接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...

使用后端服务提高管理效率

本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述 随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...

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

本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...

BatchAbolishApis-批量下线API

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

SetSignatureApis-绑定签名密钥与API

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

BatchDeployApis-批量发布API

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

创建 API

创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...

函数计算内网访问API网关

1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...

管理 CORS 规则

在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试 等详细信息。筛选前端协议类型：单击 前端协议类型 右侧的...

使用外部授权 API

API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...

基于Swagger完成API网关与用户CICD流程整合

如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1：自动从您的API业务代码中获取swagger定义 步骤2：创建API分组 步骤3：通过API网关的OpenAPI导入API定义，并发布在不同的环境中 步骤4：对API进行各项额外配置 自动...

DescribeAbolishApiTask-查询API下线任务

调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
共有200条 < 1 2 3 4 ... 200 >
跳转至： GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 对象存储 风险识别 短信服务 视觉智能开放平台 弹性公网IP

新品推荐

新人特惠 爆款特惠 最新活动 免费试用
新人特惠 爆款特惠 最新活动 免费试用