账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
Quick BI仪表板API接口的嵌套链接获取
将获取的链接拼接上accessToken就可以无需登录查看报表。如下样例：https://bi.aliyun.com/dashboard/view/pc.htm?pageId=01f38fb3-c52d-4b13-b7ec-120bf573f867 &accessToken=2542072db3e0e42ca019e27c03d6c005 或 ...
获取API调用信息
API的调用权限依赖应用进行管理，因此您在调用API时，需要先获取API的调用地址和所属应用的code、AppKey以及AppSecret信息。本文为您介绍两种获取API调用信息的操作。获取自有API的调用信息 前提条件 您已创建API并上线至API管理页面，具体...
参数映射与校验规则
转发 客户端请求 到 后端服务 在透传模式下，API网关在处理签名和授权后，会将请求透明传输给后端，对于不同位置的透传规则如下 Path:当用户将API的请求路径配置为/path/to/[user]的格式时，可以同时配置/path/backend/[user]到后端服务...
后端路由
将API的请求按权重分发到两个不同的后端服务，权重越高的后端服务将被分发更多的请求。配置示例如下：routes:#配置两个后端服务，根据后端服务承载能力不同，分别配置不同的权重，权重越高分发的请求将越多-name:Backend01 condition:"1=1...
支持 HTTPS
可以在【开放API】-【API列表】找到相应API，【API定义】-编辑-【请求基础定义】中进行修改。API支持的协议包括：HTTP：只允许HTTP访问，不允许HTTPS HTTPS：只允许HTTPS访问，不允许HTTP HTTP和HTTPS：两者均可，调整后，API支持HTTPS协议...
发布API商品
发布完成后，由于API的认证方式是"阿里云APP"，因此需要在 应用管理 菜单中创建一个调试用的APP，如下图：需要在API的 授权信息 菜单中，为此API添加授权，授权成功后如下图所示：最后可以在 API调试 菜单中进行参数的调试确认，如下图所示...
公开API
公开API服务模板可帮助您创建一个无需鉴权和SDK即可直接调用的API服务，且创建之后无法再修改为需要AppKey鉴权的API。该API主要用于更简单的物联网能力输出。前提条件 已完成创建项目。详细内容，请参见 项目。创建公开API模板业务服务 ...
添加阿里云API网关数据源
将您的API托管在API网关，通过DataV调用API网关来调用您的接口，接入方式请参见 阿里云API网关官方帮助文档。在阿里云的 云市场 中，购买相关的API服务，通过DataV调用相关的结果，获取API服务的返回结果，例如IP定位等服务。在DataV中配置...
添加阿里云API网关数据源
将您的API托管在API网关，通过DataV调用API网关来调用您的接口，接入方式请参见 阿里云API网关官方帮助文档。在阿里云的 云市场 中，购买相关的API服务，通过DataV调用相关的结果，获取API服务的返回结果，例如IP定位等服务。在DataV中配置...
API概览
本产品（云安全中心（响应...DescribePopApi 获取OpenAPI接口详情 用于获取OpenAPI的接口详情。DescribePlaybooks 获取剧本列表 用于获取剧本列表。DescribePlaybookReleases 获取剧本发布的版本列表 用于获取剧本发布的线上版本的信息列表。...
调用API（Postman）
说明 因为是简单鉴权，所以 Authorization 值由API应用的code和授权API密钥组成，格式为：ApplicationCode+空格+AppKey。关于应用的code和授权API密钥获取方式，请参见 获取调用信息。单击 Body，选择 raw，填写API字段名称和默认值为{...
创建数据模型
API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时，可以直接引用数据模型的配置参数，提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面，在左侧导航栏中选择 API ...
功能特性
数据模型 将 API 服务的请求与响应参数定义成数据模型，通过模型复用提高参数设置效率。支持参数类型有 string，int，long，float，double，boolean，list 等。外部授权 创建客户外部授权 API A，然后到业务 API B 配置中进行关联。当客户...
管理路由规则
需前往 API 编辑页面，将对应 API 的路由规则替换为其他路由规则后，方可编辑当前路由规则。在 路由规则 页面，通过以下任一方式打开路由规则编辑界面：在路由规则列表页，单击路由规则右侧 操作 列中的 编辑 即可打开路由规则编辑界面。...
管理参数映射
绑定的 API：列出了绑定了该映射规则的所有 API 及其基本信息，包括 API 名称，API 分组、发布状态、前端协议类型、创建时间等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。配置详情：...
用前必读
使用API前请必读，本章将介绍如何获取相关API的访问地址 在 API参考 中您可以查看到需要调用的API列表 点击进入具体API介绍后，您可以看到对应接口的访问域名 api.link.aliyun.com ，该域名是公共云中的API网关地址，该地址在不同的部署...
专享实例集群
创建API分组时，可以直接将API分组的所属实例指定为专享实例集群。当集群进行配置变更，添加或移除专享实例操作时，此时不可以在指定集群下创建API分组；API分组支持从其他API网关实例迁移至专享实例集群，以实现业务的快速迁移；在添加专...
导入导出 API
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及导出。说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 ...
DescribePopApi-获取OpenAPI接口详情
用于获取OpenAPI的接口详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
如何使您的API支持HTTPS？
首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。
DescribeApiList-获取OpenAPI列表
用于获取OpenAPI的产品列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
基于Swagger完成API网关与用户CICD流程整合
将API的后端服务后端信息 Map,String>globalCondition=new HashMap();globalCondition.put("x-aliyun-apigateway-backend",JSON.toJSONString(info));ImportSwagger 上文中,我们已经完成了Group的创建，原生Swagger的获取以及...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
API余量获取
获取用户的API余量、总量、使用量等数据 注意:该接口支持主账号和Ram子账号获取API余量、总量、使用量信息 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
ImportOAS-通过OAS导入API
目前可以取值：APP：只允许已授权的 APP 调用 ANONYMOUS：允许匿名调用，设置为允许匿名调用需要注意：任何能够获取该 API 服务信息的人，都将能够调用该 API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该 API 请...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiHistory-查询历史版本详情
网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成...
应用场景
API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...
通过播放地址播放
如果您对音视频进行了 分级存储，调用 GetPlayInfo-获取音视频播放地址 接口获取音视频的播放地址时：默认情况下，若存储类型为标准存储，则播放接口会正常返回播放流；若存储类型为媒资范围的非标准存储，则播放接口不返回播放流；若存储...
调用API
在API发布并授权之后，您可以通过简单身份认证（在请求头中添加AppCode）或加密签名身份认证（在请求头中添加AppKey和AppSecret）的方式调用API。本文为您介绍如何获取认证信息以及调用API的具体流程。前提条件 您需要首先发布API至API网关...
请求结构
获取用户AccessKey 使用阿里云API需要获取用户的AccessKey以对入参进行签名,获取用户AccessKey的方法请参见 获取AccessKey。获取运行区的RegionId 需要确定使用区的RegionId，每个区域的值请参见 地域和可用区。请求地址的构成 数据湖分析...
VPC授权连通性测试
VPC授权连通性测试用于验证API网关实例到您授权的VPC中实例的网络连通性，有助于将API调试阶段由于网络连通问题引发的调用失败提前暴露。本文将重点介绍VPC授权连通性测试功能，以及如何根据排错引导解决连通性测试失败的情况。1.概述 VPC...
Nacos
API网关集成Nacos主要应用的是Nacos的服务发现能力，如下图所示，网关作为服务的订阅者，可以从Nacos获取微服务实例的地址、端口等信息，并根据地址和端口将请求分发到后端的多个微服务实例中，从而实现动态路由和负载均衡。以下流程图展示...
API概览
本产品中所有开放的API，按照功能目录分类，将API链接和API描述罗列出来。项目管理 API 描述 分页查询项目列表 调用ListProject获取所有项目列表。查询项目信息 调用DetailProject获取指定项目信息。新增项目 调用AddProject创建新项目。...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
- 产品推荐
- 这些文档可能帮助您