简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
功能特性
功能总览 API 全生命周期管理 提供 API 的完整生命周期管理，快速构建、发布、订阅、管理 API，统一管理企业所有 API 接口，简化维护，提高效率。多协议与协议转换 支持 HTTP、SOFARPC、DUBBO 协议。对于异构系统，也支持上述协议之间的...
错误代码表
{Reason} B403MO 403 Api Market Subscription overdue API提供商欠费，请联系服务商处理 B403MQ 403 Api Market Subscription quota exhausted 购买的云市场API配额已耗尽，请续费次数 B403ME 403 Api Market Subscription expired API...
API 授权
根据您的业务需求，开启 API 授权、配置授权规则，定义授权方接口，并将授权规则应用到 API。功能介绍 API 授权功能允许业务在 MGS 上定义通用的 API 访问授权规则：创建授权 API A 并在网关管理中配置，然后到业务 API B 配置中做关联。...
QueryRequestLogs-获取请求日志
3b05-4cd6-888a-1c0b*RequestSize string 请求大小，单位：字节 1923 StageId string API 环境 ID 8a305b7f10334052a52d9156*StageName string API 环境名称 RELEASE HttpPath string 请求的 PATH/testPath RequestId string 请求 ID 95657...
ListApiDatasource-查询API数据源列表
取值范围：true：请求成功 false：请求失败 true 示例 正常返回示例 JSON 格式 {"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Result":{"PageNum":1,"PageSize":10,"Data":[{"ApiId":"0f2c3c6409be4dc0810f2a5785e816a8","JobId":...
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
DeleteApiStageVariable-删除环境的指定变量
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
DescribeDeployedApi-查询API在指定环境中的定义
RELEASE:线上 PRE:预发 TEST:测试 RELEASE 返回参数 名称 类型 描述 示例值 object ApiId string API 编号 4eed13a57d4e42fbb51316be8a5329ff ResultType string 后端服务返回应答的格式，目前可以设置为：JSON、TEXT、BINARY、XML、HTML。...
CreateApiStageVariable-创建环境变量
名称 类型 描述 示例值 object RequestId string 请求 ID 03442A3D-3B7D-434C-8A95-A5FEB999B529 示例 正常返回示例 JSON 格式 {"RequestId":"03442A3D-3B7D-434C-8A95-A5FEB999B529"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更...
DescribeApiDoc-查询API说明文档
接口说明 此功能面向调用 API 的用户，指定的 API 必须是发布到运行环境，且 Visibility=PUBLIC 的 API 或者被授权的 Visibility=PRIVATE 的 API 若您是调用 API 的用户，该接口返回您指定的 API 的服务信息及参数定义等详情信息。...
DescribePurchasedApiGroup-获取购买的 API 组
61A16D46-EC04-5288-8A18-811B0F536CC2 GroupId string api 分组 id 48977d7b96074966a7c9c2a8872d7e06 GroupName string API 分组名称 Weather Description string api 分组描述 api group description RegionId string api 分组所在区域 ...
AttachApiProduct-将API绑定到指定API产品
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID 551877242a4b4f3a84a56b7c3570e4a7 StageName string 是 环境名称，枚举...
DeleteDataset-删除数据集
删除用户自定义数据集。...ID 048C8EFB-528F-5E97-8A3D-D17B*示例 正常返回示例 JSON 格式 {"RequestId":"048C8EFB-528F-5E97-8A3D-D17B*"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无变更历史
SdkGenerateByApp-按应用生成SDK
61A16D46-EC04-5288-8A18-811B0F536CC2 示例 正常返回示例 JSON 格式 {"DownloadLink":"UEsDBBQACAAIADdwnFQAAAAAAAAAAAAAAAA2AAAAQ0FTREtfSkFWQV8xMjI3NDY2NjY0MzM0MTMzXzE2NTExMjU3MD.","RequestId":"61A16D46-EC04-5288-8A18-811B0F536...
DescribeHistoryApis-查询API发布版本定义列表
RELEASE：线上 TEST：测试 RELEASE ApiId string 否 指定要查询的 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称（模糊匹配）getPersonInfo PageSize string 否 分页参数：每页显示条数。10 PageNumber string 否...
CreateDatasetItem-创建数据集条目
ID 8A5E2053-4D9F-5280-B7A9-D357*示例 正常返回示例 JSON 格式 {"DatasetItemId":"5045*","RequestId":"8A5E2053-4D9F-5280-B7A9-D357*"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 暂无变更历史
混合云API集中管理
本文介绍了如何结合云企业网（CEN），构建跨Region的集中式API管理方案。同时您也可以参考本例中的步骤，结合CEN、高速通道，构建在VPC间、VPC与本地数据中心间的集中式API管理，从而实现全网资源都可以发布在API网关、并通过API网关进行...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走...charset=UTF-8 X-Forwarded-Proto:http X-Forwarded-For: 192.168.XX.XX,127.0.0.1 Host:backend1.alicloudapi....
SetDomainWebSocketStatus-设置域名WebSocket状态
61A16D46-EC04-5288-8A18-811B0F536CC2 示例 正常返回示例 JSON 格式 {"RequestId":"61A16D46-EC04-5288-8A18-811B0F536CC2"} 错误码 访问 错误中心 查看更多错误码。变更历史 变更时间 变更内容概要 操作 2023-10-19 OpenAPI 入参发生变更...
DeleteApiProduct-删除API产品
删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败）调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
TagResources-为资源添加标签
This API is not applicable for caller.Data boolean 返回数据 true RequestId string 请求 ID 1537A007-72D7-4165-8A26-8694A38E219A Success boolean 是否成功 true 示例 正常返回示例 JSON 格式 {"Code":"InternalError","Message":...
DetachPlugin-解绑API绑定的插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:DetachPlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 绑定的 API 网关插件 ID 05df2b52a3644a3a8b1935ab8ab59e9d GroupId string 是 指定...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
DetachApiProduct-解除API与API产品的绑定关系
请求参数 名称 类型 必填 描述 示例值 ApiProductId string 是 API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e Apis object[]是 API 列表 ApiId string 是 API 的 ID ba84c55eca46488598da17c0609f3ead StageName string 是 环境名称，取值...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
DescribeApiGroup-查询 API 分组详情
接口说明 此功能面向 API 提供者 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的...Api网关支持的模型可以参考如下定义：{"required":["name","photoUrls"],"type":"object","properties":{"id":{"format":"int64","type":"integer"},"category":{"$ref":...
DescribeTrafficControls-查询流控策略列表及详情
接口说明 此功能面向开放 API 的用户 此接口可用于查询所有已创建的流控策略及策略下的特殊流控策略，包括详细信息 此接口还可以支持条件查询，如查询指定接口所绑定的流控策略，如查询指定环境下的流控策略 调试 您可以在OpenAPI Explorer...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
DescribeUpdateVpcInfoTask-查询VPC授权更新状态
CEF72CEB-54B6-4AE8-B225-F876FF7BZ015 ApiUpdateVpcInfoResults object[]任务结果列表 StageId string 阶段 id fe952b95072747e2a8dfd336bcff8d7f UpdateStatus string 更新状态 success GroupId string api 分组编号 e8da6f6346184da9a30...
DescribePurchasedApis-获取购买的 API 列表
RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称 纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...
DescribeApiProductsByApp-根据APP查询有权限的API...
根据APP查询有权限的API产品列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
RemoveApiProductsAuthorities-批量移除API产品对指定...
API 产品 ID 117b7a64a8b3f064eaa4a47ac62aac5e 返回参数 名称 类型 描述 示例值 object RequestId string 请求 ID CEB6EC62-B6C7-5082-A45A-45A204724AC2 示例 正常返回示例 JSON 格式 {"RequestId":"CEB6EC62-B6C7-5082-A45A-45A204724AC...
SetApiProductsAuthorities-批量授权API产品给指定APP
批量授权API产品给指定APP 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...
ModifyPlugin-修改插件
操作 访问级别 资源类型 条件关键字 关联操作 apigateway:ModifyPlugin Write 全部资源*无 无 请求参数 名称 类型 必填 描述 示例值 PluginId string 是 指定要修改的 API 网关插件的 ID a96926e82f994915a8da40a119374537 PluginName ...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
- 产品推荐
- 这些文档可能帮助您