创建服务项目
说明 若API被其他组合API引用又无法通知到组合API的负责人及时修正组合API时，为避免因子API的变更导致组合API不能正常调用的问题，则不允许API的变更发布到线上。绑定应用时，拦截不允许发布：API绑定应用时，不允许新版本发布到线上，...
API 属性说明
应用以及 mPaas 移动应用：表示 API 发布后支持 web 浏览器、H5 容器、小程序、JS、业务系统的调用，同时也支持 mPaaS 移动客户端（iOS、Android）的调用。OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识，用于定位要访问的资源...
数据服务API
数据地图支持对当前租户下所有工作空间的数据服务API进行搜索和定位，实现数据服务API的高效查找。进入API查找界面 进入数据地图页面。登录 DataWorks控制台，切换至目标地域后，单击左侧导航栏的 数据治理>数据地图，在右侧页面中单击 ...
下载桌面版 ODC
推荐安装环境 环境 要求 系统版本 Windows：Win 7/Win 10/Win Server 2016/Win Server 2019 Mac：10.13.6（17G65）Linux：Ubuntu 18.x/Ubuntu 20.x/统信 UOS 1060 arm-desktop。Java 环境 JDK>=1.8.0_200 且 JDK说明 ODC V3.2.0 及之后的...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
发送 HTTP 请求（C#）
前提条件 在进行本地应用开发前，您需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见 创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见 授权 API。已获取了如下服务配置信息。具体获取方法，参见...
创建 API 分组
API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组 登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击...
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
创建 API
目前支持的类型为 应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...
使用限制
限制项 限制描述 使用API网关服务的用户限制 用户需实名认证 用户创建API分组数量限制-每个账号下，每个Region的API分组（含绑定域名和未绑定域名的分组）的总数上限200个；每个账号下，每个Region默认最多创建5个未绑定域名的API分组，...
支持 HTTPS
可以在【开放API】-【API列表】找到相应API，【API定义】-编辑-【请求基础定义】中进行修改。API支持的协议包括：HTTP：只允许HTTP访问，不允许HTTPS HTTPS：只允许HTTPS访问，不允许HTTP HTTP和HTTPS：两者均可，调整后，API支持HTTPS协议...
功能总览
网关主要功能模块如下：API 全生命周期管理 快速构建多种协议类型的 API 支持按需导入导出 API 多版本管理满足企业迭代需求 统一接入 支持多种方式创建路由规则 通过参数映射实现多部门参数统一规范 支持创建多种参数类型的外部授权 API ...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
安装SDK
本文为您介绍云控制API的SDK安装方法。安装操作 云控制API 为您提供以下开发语言的SDK安装方法。语言 安装方式 Java Java SDK安装 Go Go SDK安装 Python Python SDK安装 TypeScript TypeScript SDK安装 PHP PHP SDK安装 Swift Swift SDK...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
新功能发布记录
本章节介绍了API网关的产品功能和对应的文档动态。更多有关阿里云产品动态，请订阅 云产品动态。2024-01 功能名称 功能描述 发布地域 相关文档 后端路由插件支持哈希 后端路由插件支持哈希分发策略 全部 后端路由 日志 日志中增加所有IO...
创建参数映射
API 网关支持参数映射。参数映射是将请求或响应参数中的不规范或者不统一的参数，映射为符合客户端或者服务端规范的参数。该功能常用于多部门协同、实现参数统一规范，以及实现统一错误码等场景。操作步骤 进入 API 网关控制台页面，在左侧...
IP访问控制插件
IP访问控制插件 是 API网关 提供的 API 安全防护组件之一，负责控制 API 的调用来源 IP（支持IP段）。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。1.概述 支持白名单或黑名单方式：白名单：支持配置 IP 或者...
API分组的归属实例迁移
—— 分组管理 —— 分组详情页 中找到变更分组实例链接，单击变更分组实例，选择 目标实例，务必仔细阅读注意事项，之后单击 确认迁移 完成分组迁移，分组迁移会实时生效在API网关二级域名的DNS上，根据DNS的缓存，大约1~10分钟内完整生效...
CreateMonitorGroup-创建监控报警分组
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
参数映射与校验规则
123"${User}.${Group}.api.io 123.g01.api.io User:"123"Group:"g01"${Admin}.admin.api.io${User}.${Group}.api.io.123.api.io User:"123"${Admin}.admin.api.io${User}.${Group}.api.io 123.admin.api.io Admin:"123"${Admin}.admin.api...
产品计费
计费方式 API 网关目前是按接口调用数进行计费，是一种先使用后付费的计费方式，即根据单月内某个用户使用网关，进行有效调用 API 的请求累计次数进行阶梯计费，此外不收取其他任何费用。计费规则 网关以每小时作为计费周期，在计费周期内...
DescribeBackendList-查询后端服务列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
导入数据模型
为了方便用户快速生成数据模型，API 网关支持通过 Proto 文件和 Swagger 文件来快速导入数据模型。操作步骤 登录 API 网关控制台。在左侧导航栏单击 API 发布>数据模型，进入数据模型页面。在页面右上角单击 导入数据模型，在弹出的窗口中...
CreateResource-创建资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
创建 CORS 规则
但在实际应用中，经常会发生跨域访问。为此，W3C 提供了一个标准的跨域解决方案：跨域资源共享（Cross-Origin Resource Sharing，CORS），支持安全的跨域请求和数据传输。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>...
创建系统集群
系统集群表示 API 网关接收到前端请求后转发到真实业务系统的集群。本文介绍如何在 API 网关控制台快速创建系统集群。目前 API 网关支持创建 HTTP、SOFARPC、DUBBO、TRIPLE 和 SOFA_TR 五种协议类型的系统集群。说明 公有云环境中，创建 ...
搭建无服务器应用之手机号归属地查询
本文主要介绍配合使用API网关、函数计算和云市场三种产品，搭建一个可以查询手机号归属地的服务。在这个框架里不需要配置Web容器、不需要搭建运行环境、不需要购买负载均衡，通过配置和一段代码即可完成一个高扩容无服务器的应用服务。服务...
DescribeDatasetItemInfo-查询数据集条目信息
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
后端路由
backend:后端描述，与API网关的Swagger标准保持一致，后端在原有API的后端上覆盖backend配置后处理，如果覆盖后的backend不完整，会提示客户端 X-Ca-Error-Code:I504RB，当看到这个错误时，请检查自己的backend配置是否完整，关于Backend...
插件数据集
API网关为用户提供了功能强大、支持热更新插件体系，大量核心能力均被迁移到插件体系中，截止目前为止API网关已经为用户提供了12种插件。插件功能的上线极大丰富了API网关为用户提供服务的功能点，也很大程度提升了API网关元数据管理的灵活...
GetTask-查询任务
用户通过此接口查询指定任务详情。接口说明 GET/api/v1/tasks/{taskId}。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的...
快速入门
帮助渠道商提供标准的销售和积分商城的API接入或SaaS软件产品，使用阿里平台电商体系链接直接销售获取返佣收益，并配合定制API，可快速接入企业自有业务体系，直接接入商品供应链。适合需要统一开票和账期服务的渠道商。操作步骤：入驻流程...
CreateResourcePackage-创建资源包服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
基于JWT的token认证
阿里云API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所...
RenewChangeInstance-续费变配服务
请求参数 名称 类型 必填 描述 示例值 ProductCode string 是 产品代码，可通过接口 QueryProductList 查询产品代码，或查看 阿里云产品 Code 速查手册。rds ProductType string 否 产品类型 rds InstanceId string 是 实例 ID。rm-...
流量控制插件
当取值为 API 时：流控策略在每个API中分别生效，在本例子中，每个API的限流均为 10次/秒 当取值为 PLUGIN 时：所有绑定了本插件的API共享这个限流，如果本例子中的插件绑定了一堆API，则这一堆API的总流控限制为 10次/秒 parameters（必选...
GetResourcePackagePrice-资源包产品询价服务
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
错误码
排查方式如下：检查网关是否配置了相应的 API 且 API 的状态是否为 已发布。检查客户端的 API 调用路径和分组等信息是否与网关维护的一致。检查请求的 host、path、method 是否正确。加签/验签失败 在对网关进行加签/验签操作失败时，常见...
- 产品推荐
- 这些文档可能帮助您