简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
流量控制与配额管理
为什么需要流量控制 保证云服务稳定性 云产品由于产品形态的差异，其所能支持的接口最大并发数也各不相同。对于支持并发数量小的云产品，若单个用户产生大量并发请求，可能会导致其他用户访问云服务速度慢、甚至不可访问等问题。保障 Open...
后端服务调不通
如果使用的是内网 IP，请保证您的后端服务与您的 API 处于同一地域。检查您API定义的“后端超时”时间。在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以...
API概览
ModifyApiConfiguration 修改API定义 本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值...
VPC内网访问API网关
建议您使用专享实例的API网关，此时运行在专享实例上的API分组，其内网VPC二级域名所对应的IP为您所绑定的入访VPC的私网地址，这样便于您的本地路由设置。共享实例上的API分组的内网VPC二级域名统一为100.x.x.x的IP地址，无法分配私网地址...
错误反馈
为什么调用自定义文本库配置管理接口报错：The API is invalid？内容安全图片接口返回错误码400（please contact us to open human audit service）？内容安全Python SDK在jupyter notebook或者命令行直接运行时报错：UnicodeEncodeError？...
API网关为K8s容器应用集群提供强大的接入能力
很容易地升级应用程序容器的新版本 提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构 我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...
概述
使用AppCode调用API（简单身份认证）AppCode认证方式，调用简单，但安全性较低，适合于内网系统之间的API调用。API网关通过检查客户端调用API时的Request Header或Query中，是否包含有满足要求的AppCode来进行认证。具体操作过程请参考 ...
发布API商品
3.5 API商品的域名 在使用API网关进行API全生命周期管理的场景中，您需要在分组上绑定您的正式域名后，业务系统、客户端程序才能正式调用这些发布的API。但针对这些准备上架到云市场的API分组，则不必您绑定域名，在云市场服务商控制台中，...
API网关-连接用户VPC服务关联角色
本文为您介绍API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApiGatewayConnectUserVpc）的应用场景以及如何删除API网关-连接用户VPC服务关联角色。背景信息 API网关-连接用户VPC服务关联角色（AliyunServiceRoleForApi...
后端签名插件
当您想替换某个API的密钥时，请直接修改要修改插件中的key和secret,已绑定的API将会即时生效。3.插件配置 可以选择JSON或者YAML格式的来配置您的插件，两种格式的schema相同，可以搜索yaml to json转换工具来进行配置格式的转换，YAML格式...
API网关-微服务集成服务关联角色
应用场景 创建EDAS类型的后端服务/批量导入EDAS类型的后端服务/批量导入EDAS类型的API时，API网关会提示用户创建服务关联角色，用户通过后系统会自动创建一个名称为AliyunServiceRoleForApiGatewayIntegrateWithMicroservices的服务关联...
Zookeeper
本文将介绍API网关集成Zookeeper访问微服务后端的原理，以及如何创建、发布并调用服务发现类型的API。1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建...
IP访问控制插件
IP访问控制插件 是 API网关 提供的 API 安全防护组件之一，负责控制 API 的调用来源 IP（支持IP段）。您可以通过配置某个 API 的 IP 白名单/黑名单来允许/拒绝某个来源的API请求。1.概述 支持白名单或黑名单方式：白名单：支持配置 IP 或者...
绑定/解绑 API
创建 CORS 规则后，您可在规则下绑定/解绑指定的 API。绑定 API 在 CORS 规则列表页，单击规则右侧 操作 列中的 绑定 API。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中，勾选需要绑定的 API...
多级API网关
用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。API网关自调用允许跨Region调用，如果同Region，可以走内网调用。API网关自调同时支持跨账号调用，使用授权过的AK绑定一个类型为APIGW_FRONTEND的后端签名插件，API网关...
使用VPC内资源作为API的后端服务
2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考 创建 API 创建应用以及授权可参考 创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...
创建 API
创建API即录入API的定义，需要录入API的基本信息、服务信息、请求信息、和返回信息，然后对创建的API进行调试，及进行安全配置。经测试证明API可用后，可发布上线供用户使用。1 定义 API 在API网关控制台中API列表页面，单击创建API，即...
函数计算内网访问API网关
步骤5：新建函数 在函数计算中，创建应用，并创建运行环境为python的函数，函数内容如下所示：函数中仅是使用curl去访问VPC二级域名下的API，如果此时执行，将无法访问。步骤6：配置函数计算的VPC访问 首先需要在vpc-api-access中再创建...
环境管理
1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的测试环境资源，从而可以保证在同一套API...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
导入导出 API
批量导出 API 在 API 发布>API 管理 页面，在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出 按钮，即可将选择的 API 转换为 JSON 文件保存至本地。批量导入 API 在 API 发布>API 管理 页面，单击 API 列表右上方的 ...
管理应用
API 订阅列表 在应用详情页的 API 订阅列表 标签页中，可查看当前应用已订阅的 API。在 API 订阅列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 定义、请求参数、响应示例、错误码 等详细...
SDK下载及使用指南
若您需要使用 SDK 调用 API 网关开放的 OpenAPI 注意这里的 OpenAPI 是指用于操作 API 网关产品的 API。您需要前往 阿里云 SDK 页面下载 SDK 并查看使用。SDK 下载请前往阿里云 SDK 页面各个语言的“获取各产品 XXX SDK”页面下载，若页面...
管理 API 分组
API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...
绑定/解绑 API
授权对象创建成功后，您可在该授权对象下批量绑定或解绑指定的 API。绑定 API 在 授权管理 页面，找到目标应用，单击其名称进入该授权应用详情页。在打开的 绑定的 API 标签页中，单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口...
名词解释
API定义 API服务方创建API时，设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时，支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则，由网关根据规则...
客户端调用API示例
您可以通过 API 网关，调用由其他阿里云用户或者第三方服务商开放的 API 服务。API 网关将为您提供一系列管理服务与支撑。调用API 您可以直接用API网关控制台为您提供的多语言SDK来调用API（SDK和文档下载），也可以自行编写HTTP(s)请求...
管理授权对象
绑定的 API 在授权应用详情页的 绑定的 API 标签页中，可查看当前授权应用已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
管理 CORS 规则
绑定的 API 在 CORS 规则详情页的 绑定的 API 页签中，可查看当前 CORS 规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 配置信息、版本管理、监控、流量...
管理路由规则
绑定的 API 在路由规则详情页的 绑定的 API 标签页中，可查看当前路由规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的 授权对象、配置信息、版本管理 等详细...
错误代码表
若是云市场购买的API，请联系服务商处理 A401AC 401 Invalid AppCode${Reason} 当使用AppCode模式授权时，未找到AppCode，请核实App是否授权，AppCode是否有误 A400IK 400 Invalid AppKey 当使用`Key/Secret`签名授权时，未找到AppKey A403...
产品简介
通过API网关强大的适配和集成能力，可以将各种业务系统的API实现统一管理和统一调用：支持异构网络环境：无论您的业务系统部署在阿里云、本地数据中心、或其他云，API网关均可以统一管理；支持对接多种系统实现方式：您的业务系统基于ECS、...
创建 API
密钥认证：表示订阅应用访问授权的 API 时使用密钥进行身份认证。无需认证：表示订阅应用访问授权的 API 时不需要身份认证。请求参数：可选，详见 API 属性说明>请求参数。响应参数：可选，详见 API 属性说明>响应参数。单击 下一步，进入 ...
参数定义是必须的吗？
不是，但推荐您定义，以便您的 API 用户能够清楚的理解您的 API。
DescribeApiProductApis-查询API产品绑定的API列表
查询API产品绑定的API列表 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 当前API暂无授权信息透出。请求参数 名称 类型 必填 描述 示例值 ...
版本管理
2.单击左侧导航栏的 API管理 —— API列表。3.选择需要查看的API点击操作列下的 管理。您可以看到当前所选API的定义信息。按照您的需要进行编辑，单击 编辑 按钮。编辑API定义的流程和创建API定义一致，详细信息参见 创建 API，如果您想...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
为RAM用户授权
本文为您介绍云控制API的RAM权限管理。您可以为RAM用户授予不同的权限，提供给您企业的员工用来使用云控制API，从而让您避免与其他用户共享云账号密钥，降低您企业的信息安全风险。前提条件 您已创建RAM用户（子用户）。具体操作，请参见 ...
账单域API使用手册
SubscribeBillToOSS 详单订阅服务 UnsubscribeBillToOSS 取消详单订阅服务 QueryRelationList 查询企业财务关系列表 API选择方案 选择账单域API时，您可以结合需要查询的数据，对比每个API的入参、出参，做出最优的API接口决策。...
- 产品推荐
- 这些文档可能帮助您