客户端调用API示例
X-Ca-Stage:RELEASE#请求 API 的 Stage，目前支持 TEST、PRE、RELEASE 三个 Stage，大小写不敏感，API 提供者可以选择发布到哪个 Stage，只有发布到指定 Stage 后 API 才可以调用，否则会提示 API 找不到或 Invalid Url。X-Ca-Key:60022326...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
概述
具体步骤可参考 创建 API 使用管控API创建API 可以通过管控API创建API，具体操作可参考 CreateApi-创建 API 通过导入Swagger创建API Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持...
请求结构
服务地址 OpenSearch为分区域部署，每个区域访问地址均不同，具体服务地址请查看访问应用-》基本详情中的API入口部分获取，切勿随便使用。通信协议 支持HTTP协议。部分区域（华北1、华北2、华东1、华东2、华南1）已支持HTTPS协议。请求方法...
边缘应用OAuth免登对接
开发API 3.1 获取应用入口地址 接口描述：授权类型 APPSIGN 协议 HTTP 请求方法 get 域名（环境变量中获取）System.getenv(“iot.hosting.api.domain”)路径/api/console/app/get 入参说明 入参名称 数据类型 是否必须 入参示例 入参描述 ...
API详情
API详情页提供指定时间段内应用中所有API请求的成功率、平均成功耗时、平均失败耗时、缓慢次数、错误次数，并以API请求发起端的地域、域名、网络制式等维度展示统计数据。功能入口 登录 ARMS控制台。在左侧导航栏选择 前端监控>前端列表。...
请求结构
阿里云云效 Codeup API 支持基于 URL 发起 HTTP/HTTPS GET 请求。请求参数需要包含在URL 中。本文列举了 GET 请求中的结构解释，并提供了 Codeup 的服务接入地址（Endpoint）。结构示例 以下为 CreateRepository 一条未编码的URL请求示例：...
API安全
API安全模块基于内置检测机制和自定义检测策略，自动梳理已接入 Web应用防火墙（Web Application Firewall，简称WAF）防护的业务的API资产，检测API风险（例如未授权访问、敏感数据过度暴露、内部接口泄露等），通过报表还原API异常事件，...
参数映射与校验规则
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 且 API 的状态是否为 已发布。检查客户端的 API 调用路径和分组等信息是否与网关维护的一致。检查请求的 host、...
请求结构和签名机制
步骤二：构造请求体&签名 不同风格的 OpenAPI 接口，构造的请求体存在差异，且需要对请求进行签名操作，请参看最新版本签名机制 V3版本请求体&签名机制。步骤三：处理返回数据 如果您明确知晓返回值的内容，可将返回数据转化为已经定义好的...
API Release Notes
API版本号 发布说明 2019-03-07 更新内容如下：发布新接口：发起认证请求（DescribeVerifyToken）。发布新接口：获取认证结果（DescribeVerifyResult）。发布新接口：提交认证（VerifyMaterial）。2018-09-16 更新内容如下：提交认证资料...
功能概览
API网关支持以下功能。API 生命周期管理 覆盖设计、开发、测试、发布、运维监测、安全管控、下线等API各个生命周期阶段，API网关为每个阶段提供生产力工具；协议处理 支持HTTPS、SSL卸载、支持HTTP2.0；支持通过泛域名调用API；请求转发 ...
全局服务
功能概述 全局服务是一种支持外部服务调用的功能，您可以通过配置服务接口来新增全局服务。在系统中，"FAQ问答"和"多轮对话"都支持直接引用全局服务，以便获取外部服务提供的信息或功能。重要 注意：一旦某个全局服务被引用，需要先解除...
SynchronizeResource-同步阿里云基础资源到EDAS
变更历史 变更时间 变更内容概要 操作 暂无变更历史 注意事项 该接口在实际执行中，会遇到在 API 接口 Client 程序端在连接 API 网关超时（默认 10 秒）的情况，所以，用户在使用该接口时，须手工设置调用该接口时读取 POP API 网关返回的...
创建后端为函数计算的API
本文将快速引导您如何在API网关中，发布后端服务为函数计算类型的API，并如何使用“阿里云APP“认证中的AppCode进行调用。1 概述 您需要依次完成以下步骤：创建函数；创建分组；定义API；创建应用和API授权；调试API；调用API。2 创建函数 ...
事件总线
概述 您需要依次完成以下步骤：创建后端服务 创建API分组 定义API 创建应用和API授权 调试API 调用API 前提条件 您需要先开通事件总线，并创建自己的自定义事件总线，详情可以参考 管理自定义事件总线 创建后端服务 登录 API网关控制台，在...
创建后端服务为VPC内资源的API
概述 您需要依次完成以下步骤：创建VPC授权 创建分组 创建并定义API 创建应用和API授权 安全组放行 调试API 调用API 1.创建VPC环境 购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...
调用方式
云储存网关接口调用是通过向云存储网关API的服务端地址发送HTTP(s)GET请求。您需要并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。服务地址 SGW API的服务接入地址请参见下...
流量控制
所有的API都启用了访问流量控制机制，并根据地域和具体的API接口进行划分和区分。不同地域和不同接口会有不同的流量控制阈值。对于同一个阿里云账号，在不同地域内调用特定接口的访问流量不能超过系统设定的阈值。如果超出阈值，API调用...
调用方式
阿里云RTC数据服务的API调用是向数据服务端地址发送HTTP请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。服务地址 阿里云RTC数据服务的API接入地址为vdc....
扩展接口
} 解析请求来源 若希望对HTTP请求按照来源限流，则可以自己实现 RequestOriginParser 接口从HTTP请求中解析origin并注册至 WebCallbackManager 中，示例如下：WebCallbackManager.setRequestOriginParser(new RequestOriginParser(){@...
返回值为空
其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...
DescribeApis-查询定义中的 API 列表
Key，Value Key string 否 标签键 key Value string 否 标签值 value ApiPath string 否 API 的请求 Path/illegal/query ApiMethod string 否 API 的请求 HTTP 方法 GET UnDeployed boolean 否 是否过滤未发布的接口 true StageName string...
接口
接口来源 可选：数据分析服务：调用开发者在物联网平台数据服务中开发的API接口（包含 通用接口、用户接口），将返回数据作为组件数据源。通用接口 为数据服务的 预置指标API 和 产品数据API，用户接口 为数据服务的 自定义服务API。更多...
多级API网关
在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：http://backend1.alicloudapi.com:8080/business1API2 Method: GET ...
V2版本RPC风格请求体&签名机制
本文介绍了阿里云 OpenAPI 的 RPC风格接口，包括RPC OpenAPI 请求的组成部分，如何通过这些组成部分构造一个 OpenAPI 请求，如何获取返回结果以及签名机制等。阿里云 RPC OpenAPI 向开发者提供HTTP接口，如果您想要自研阿里云RPC调用风格的...
错误码
在调用API接口过程中，若服务端返回结果中包含错误信息，则表示调用API接口失败。您可以根据本文错误码对照表查找对应的解决方法。概述 当API请求发生错误的时候，服务端会返回错误信息，包括HTTP的Status Code和响应Body中的具体错误细节...
Zookeeper
1.概述 本文依次介绍如下步骤：原理说明 创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用 创建分组 创建后端服务 创建API 创建应用并授予API的调用权限 调试API 2.原理说明 Zookeeper 采用了类似文件...
请求应答改写插件（仅专享实例）
1.概述 请求应答改写插件允许您配置一系列内容修改策略，策略包含修改的类型和参数信息，API网关将根据您提供的策略配置对HTTP请求或响应的内容进行改写。HTTP请求支持的修改类型包括：addRequestParameterIfAbsent：添加请求参数，如果...
发送 HTTP 请求（C#）
本文介绍 API 订阅方应用如何使用 C#语言对 HTTP 请求加签、验签。API 网关提供了 C#SDK，即 mosng-sdk-csharp.zip。该 SDK 集成了加签、验签的逻辑，同时默认支持序列化和反序列化。前提条件 在进行本地应用开发前，您需要确保已经完成...
流量控制与配额管理
保障 OpenAPI 服务稳定性 若在 OpenAPI 网关不知情的情况下，用户对单个接入点的接口进行高频次的调用，会导致网关的服务压力变大，超负荷的请求处理会导致用户在该接入点访问其他云产品的响应时间慢、甚至导致整个服务接入点不可访问等...
调用API
调用CDT的API接口是向CDT的API的服务端地址发送HTTPS请求。您需要按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果均使用UTF-8字符集进行编码。请求结构 CDT的API是RPC风格，您可以通过发送HTTPS请求调用...
通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
监控指标参考
具体指标项如下：指标名称 单位 描述 GetObject请求平均E2E延时 毫秒 请求API为GetObject的成功请求的平均端到端延时。GetObject请求平均服务器延时 毫秒 请求API为GetObject的成功请求的平均服务器延时。GetObject请求最大E2E延时 毫秒 ...
创建 API
1.2 定义API请求 定义用户如何请求API，包括协议、请求Path、HTTP Method、入参请求模式、和入参定义。参数 描述 请求协议 支持HTTP、HTTPS。请求Path Path指相对于服务host，API的请求路径。请求Path可以与后端服务实际Path不同，您可以...
后端路由
当前请求的域名 CaRequestHandleTime：请求处理的UTC时间 CaAppId：请求参数的AppId CaAppKey：请求参数的AppKey CaClientIp：客户端IP CaApiName：创建时候的API名字 CaHttpScheme：请求的协议 HTTP,HTTPS CaClientUa:客户端上传的...
导入API网关的扩展Swagger定义
info in:query required:true type:string x-aliyun-apigateway-query-schema:$ref:"#definitions/EvnetInfo".1.11 x-aliyun-apigateway-any-method:ANY方法 ANY方法，应用于 Path Item Object，用于设置API可以接受任意类型的HTTP请求。...
接口详情
接口详情页面主要展示该应用所有接口的QPS、异常请求、RT、并发数据等，还可以在此页面为接口管理流量防护规则（仅企业版支持该能力）。本文介绍接口详情页的主要功能。功能入口 登录 MSE治理中心控制台，并在顶部菜单栏选择地域。在左侧...
使用限制
本文主要介绍如何查看机器翻译 API流量控制、接口使用限制，并提供API流量控制的合理化建议。说明 如有QPS扩展需求，请前往 售前咨询 或与我们联系钉钉群号：23369411 流量控制范围说明 机器翻译所有API均开启了访问流量控制，不同接口存在...
- 产品推荐
- 这些文档可能帮助您