通过日志服务查看API调用日志
日志项 描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...
API网关监控
本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
ImportSwagger-通过 Swagger 创建 API
接口说明 阿里云目前支持基于 Swagger 2.0 的扩展 只支持 json/yaml 格式的 Swagger 配置文件 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权...
调用API
云价签接口调用是向云价签API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 云价签的API是RPC风格，您可以通过发送HTTP GET请求...
DeleteResource-删除资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
HTTP API 入门
API 授权应用类型：必选，指定可以订阅并调用该 API 的应用类型。根据本示例，需选择 应用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。根据本示例，需输入/hello/world。路径匹配规则：选择 ...
使用简单认证（AppCode）方式调用API
API调用者到API网关控制台的”应用管理“找到AppCode/AppSecret进行签名认证的调用或者AppCode进行简单认证的API调用。2.创建支持简单认证方式API API提供者在创建API安全认证方式时需要选择”阿里云APP”；AppCode认证选项选择允许AppCode...
CreateResource-创建资源
接口说明 用户可前往 在线调试 API 门户 查看资源文档和体验 Cloud Control API。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API...
调用方式
智能语音导航接口调用是向智能语音导航API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 智能语音导航的API是RPC风格，您可以...
API 调用返回20003 错误码
1.问题背景 API 在调用时,需要指定域名（domain）、方法（method）、API 版本（version）API 网关也是通过上面3个参数来准确定义和完成请求路由到指定的后台服务 如果上面的三个三有一个不正确,API 网关在路由配置里面并没有找到对应的后台...
调用方式
视觉计算服务接口调用是向视觉计算服务API的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 视觉计算服务的API是RPC风格，您可以...
错误信息查询
您可以优先在本文档查询错误码、错误消息，获取对应解决方案。调用API请求时常见错误码 HTTP status code 错误码 错误信息 描述 解决方案 500 ServerError Server error.系统错误 请提交工单或者联系通义听悟工程师。400 BRK....
后端服务调不通
如果使用的是内网 IP，请保证您的后端服务与您的 API 处于同一地域。检查您API定义的“后端超时”时间。在API定义时会要求您录入一个超时时间，当您的后端服务没有在您指定的时间内返回时，API网关仍然会提示您无法连接后端服务。您可以...
调用方式
请求结构 云游戏的API是RPC风格，您可以通过发送HTTP GET请求调用云游戏API。其请求结构如下：...下面是一个调用 ListGames 接口查询游戏列表的示例：说明 为了便于用户查看，本文档中的示例都做了格式化处理。...
DescribeDeployedApi-查询API在指定环境中的定义
true ResultBodyModel string api 的返回结果 ResultSample string 后端服务返回应答的示例 {code:200,message:'success',data:''} AllowSignatureMethod string API 的客户端请求签名方法，可选值：HmacSHA256 HmacSHA1,HmacSHA256 ...
DescribePluginTemplates-获取插件模板列表
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API网关灰度发布最佳实践
本文主要用于介绍在API后端服务版本...如果用户需要指定授权给某些应用的API调用请求进入灰度环境，可以利用系统参数 CaAppId 来配置路由条件，配置如下-routes:name:appGrey condition:"$CaAppId=4534463 or$CaAppId=86734572"backend:type:...
SdkGenerateByApp-按应用生成SDK
按APP应用生成SDK。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，...
DescribeApiHistory-查询历史版本详情
查询指定API的某一次历史发布版本的定义详情，即某一次历史发布时发布的API定义。接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次...
DescribePluginSchemas-描述插件模式
调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...
SdkGenerateByAppForRegion-按应用生成SDK
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
使用HTTPS并用域名访问
用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...
API概览
本文主要介绍了API概览信息，在开始调用API接口之前，请先阅读 API使用指南。文档理解 API API概述 文档智能解析 进行通用文档抽取和理解，从文档中提取出层级结构、文本内容、KV字段、样式信息等。表格智能解析 进行表格抽取和理解，从...
VPC授权连通性测试
这三条数据可以唯一确定您的一个业务服务，并授权API网关访问该业务服务，具体可参考 使用VPC内资源作为API的后端服务。2.连通性测试 进入API网关控制台-API管理-VPC授权，根据上述文档创建VPC授权。在操作列表可以看到 连通性测试。点击 ...
版本说明
变更时间：2024-05-20 变更集发布说明：OpenAPI 名称 变更内容概要 操作 CancelReserveTask API 内部配置变更，不影响调用。查看API变更历史 查看API文档 变更项 变更内容 API 内部配置变更，不影响调用。CreateCapacityReservation API ...
VPC融合专享实例
适用场景 VPC融合类型专享实例是阿里云API网关推出的新版本专享实例，重点对API网关和您的VPC之间的网络架构进行了优化，适用场景：API网关需要访问同一VPC内的多个资源（如ECS、SLB），即托管在网关上的API，其后端服务是同一VPC下的多个...
API 网关
API 网关（API Gateway）提供高性能、高可用的 API 托管服务，帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用，提供完整的 API 发布、管理、维护生命周期管理。用户只需进行简单的操作，即可快速、低成本、低风险地开放数据...
SubscribeBillToOSS-导出订阅详单
接口说明 在调用该接口时，请注意：用户一次订阅一个类型的账单文件。订阅后次日开始每日推送上一日生成的账单文件，每月 4 号推送上月整账期的全量账单文件。月账单 PDF 每月 4 号推送上月账单文件。按天生成的账单文件可能存在时延，延迟...
使用自定义域名调用API
用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系 用户需要将自己拥有的域名...
DeleteDbfs-删除数据库文件系统
接口说明 调用该接口时，您需要注意：释放数据库文件系统时，数据库文件系统的状态必须为：待挂载（Unattached）。如果指定 ID 的数据库文件系统不存在，请求将被忽略。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的...
DeleteFileSystem-删除文件系统
接口说明 仅当文件系统的挂载点数目为 0 时，支持删除文件系统实例。当文件系统未创建生命周期策略时，支持删除文件系统实例。文件系统实例一旦删除，数据将不可恢复，请谨慎操作。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您...
DeleteFileSystem-删除文件系统
接口说明 仅当文件系统的挂载点数目为 0 时，支持删除文件系统实例。当文件系统未创建生命周期策略时，支持删除文件系统实例。文件系统实例一旦删除，数据将不可恢复，请谨慎操作。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
配置后端服务Host（域名头）
Host概述 当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...
QueryBillToOSSSubscription-详单订阅查询
调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：操作：是指具体的权限点。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取...
基于Swagger完成API网关与用户CICD流程整合
该方法的核心是以swagger为桥接，通过API网关的ImportSwagger接口来完成您的API的自动创建和更新。一、概述 API网关提供了完备的OpenAPI接口，用户可以通过这些接口完成API网关的管理需要。用户CICD集成API网关的核心，其实就是对API网关...
接口鉴权
1.1 接口调用及鉴权 阿里云API接口会为每一个项目颁发一套鉴权密钥，密钥包含appkey、appsecrt，您可以通过这套密钥创建多个小区进行管理，请下载SDK进行接口调用 https://github.com/aliyun/iotx-api-gateway-client。1.1.1 获取小区授权...
云控制API
云控制API（CloudControl API）是一款面向开发者的资源化OpenAPI开发者工具。云控制API免去了开发者学习上百个产品、上万个OpenAPI的差异化成本；让开发者无需维护多套SDK、学习多个产品的OpenAPI。
- 产品推荐
- 这些文档可能帮助您