API 网关

API 网关(API Gateway)提供高性能、高可用的 API 托管服务,帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用,提供完整的 API 发布、管理、维护生命周期管理。用户只需进行简单的操作,即可快速、低成本、低风险地开放数据...

OpenAPI Explorer

可视化的 API 调用工具。通过该工具,您可以通过网页或者命令行调用各云产品以及 API 市场上开放的API,查看每次的API请求和返回结果,并生成相应SDK调用示例。\n\n访问地址:https://api.aliyun.com

API错误码(ODPS-04CCCCX)

错误码 模块 严重等级 触发条件 处理方法 ODPS-0410001:Missing authentication parameters Web-Authentication 1 认证参数缺失,API返回400错误。补全认证参数。ODPS-0410011:Invalid authentication parameters Web-Authentication 1 ...

API网关双向通信SDK实现指南

命令类型:应答 发送端:API网关 格式:HO#ConnectionCredential 示例:HO#ffd3234343dae324342 命令字:HF 含义:API网关返回心跳保持失败应答信令,收到此应答需要客户端重新发送注册请求 命令类型:应答 发送端:API网关 格式:HF 没有...

名词解释

API定义 API服务方创建API时,设置的API的后端服务、请求格式、接收格式、返回格式等规则内容。参数映射 用户实际请求的参数与API服务后端参数不一致时,支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则,由网关根据规则...

查询插件下绑定的API

描述查询指定插件下...TotalCount Integer 返回结果的总条数 PageNumber Integer 返回指定的页码 PageSize Integer 返回指定的每页条数 ApiSummarys ApiPluginSummary 由 ApiPluginSummary 组成的数组格式返回API的定义信息 示例请求示例...

下线 API

AbolishApi 操作接口名,系统规定参数,取值:AbolishApi返回数据 名称 类型 示例值 描述 RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BZ016 请求ID 示例 请求示例 http(s):/apigateway....

创建后端为函数计算的API

API返回内容为前面步骤中创建的函数返回内容,函数代码如下:7 调用API通过上述步骤,您已经创建API、创建APP、建立了授权关系,调试API完成,并将API发布到线上环境,本阶段将会模拟如何使用APPCode的认证方式来在您的业务系统中调用发布...

删除 API 定义

请求参数 名称 类型 是否必选 示例值 描述 ApiId String 是 d6f679aeb3be4b91b3688e887ca1fe16 API编号 GroupId String 是 123 分组编号 Action String 否 DeleteApi 操作接口名,系统规定参数,取值:DeleteApi返回数据 名称 类型 示例...

使用函数计算做为API后端服务

函数计算的返回参数格式:函数计算需要将输出内容通过如下 JSON 格式返回API 网关,以便 API 网关解析。{"isBase64Encoded":true|false,"statusCode":httpStatusCode,"headers":{response headers},"body":"."} 当 body 内容为二进制...

查询定义中的 API 列表

名称 类型 描述 RequestId String 本次请求编号 TotalCount Integer 返回结果的总条数 PageNumber Integer 返回指定的页码 PageSize Integer 返回指定的每页条数 ApiSummarys ApiSummary 由 ApiSummary 组成的数组格式返回API的定义信息 ...

发布 API

RELEASE 运行环境名称,取值:RELEASE:线上 PRE:预发 TEST:测试 Action String 否 DeployApi 操作接口名,系统规定参数,取值:DeployApi返回数据 名称 类型 示例值 描述 RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BZ015 请求...

删除 API 分组

描述用于删除指定的API分组 此功能面向API提供者分组下存在API时,分组不可删除,须先删除分组下的API删除分组后,系统分配给此分组的二级域名自动生效删除不存在的分组时,会返回删除成功该接口调用的QPS限制为:单用户QPS不超过50 请求...

概述

1 如何创建API创建API的方式有三种:通过控制台创建API、通过管控API创建API、通过导入Swagger创建API通过控制台创建API登录阿里云API网关控制台,左上角选择地域,然后在分组中创建API。具体步骤可参考创建 API使用管控API创建API可以通过...

查询已发布 API 列表

描述查询已经发布到某指定...TotalCount Integer 返回结果的总条数 PageNumber Integer 返回指定的页码 PageSize Integer 返回指定的每页条数 DeployedApis DeployedApiItem 由 DeployedApiItem 组成的数组格式返回API的信息 示例请求示例...

导入Swagger创建API

DryRun Boolean 否 true 预检验 返回数据 名称 类型 示例值 描述 Failed Array of ApiImportSwaggerFailed 本次所有通过swagger导入失败的API信息 ApiImportSwaggerFailed ErrorMsg String api already exists:apiUid=gt;8e274ec61cf6468e...

快速切换 API 版本

StageName String 是 RELEASE 运行环境名称,取值:RELEASE:线上 TEST:测试 Action String 否 SwitchApi 操作接口名,系统规定参数,取值:SwitchApi返回数据 名称 类型 示例值 描述 RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7...

API报警设置

云监控的这个应用分组是由API网关经用户授权后创建的,和当前的API分组对应,命名格式固定为:APIGATEWAY_${region}_${groupId},region的值是API分组所在的region,groupId是API分组的分组ID。4、成功开通云监控后,通过API分组详情页右上...

创建 API

创建API即录入API的定义,需要录入API的基本信息、服务信息、请求信息、和返回信息,然后对创建的API进行调试,及进行安全配置。经测试证明API可用后,可发布上线供用户使用。1 定义 APIAPI网关控制台中API列表页面,单击创建API,即进入...

创建后端服务为HTTP的API

var result=await client.get(url,{/请求响应体类型部分 API 可以根据指定的响应类型来返回对应数据格式,建议手动指定此请求头 headers:{ accept:'application/json' },});console.log(JSON.stringify(result));} get().catch((err)=gt;{ ...

修改 API

此接口面向开放API的用户 该接口需要全量更新,不支持部分参数更新 修改ApiName时需要注意,同一个分组内API不允许重名 修改RequestPath时需要注意,同一个分组内Path不允许重复 该接口调用的QPS限制为:单用户QPS不超过50 调试 您可以在...

签名密钥绑定 API

调用SetSignatureApis添加指定签名密钥与API的绑定。此功能面向开放API的用户 用于添加API与签名密钥的绑定关系,支持多个API批量操作,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,Open...

创建 API 分组

API分组描述,不超过180个字符 返回参数 名称 类型 描述 RequestId String 请求唯一标识 GroupID String API分组 ID,系统生成,全局唯一 GroupName String API分组名称 SubDomain String 系统给分组绑定的二级域名,用于测试API调用 ...

发布API商品

发布完成后,由于API的认证方式是"阿里云APP",因此需要在应用管理菜单中创建一个调试用的APP,如下图:需要在API的授权信息 菜单中,为此API添加授权,授权成功后如下图所示:最后可以在API调试菜单中进行参数的调试确认,如下图所示:...

查询密钥绑定的 API

ApiInfo 组成的数组格式返回API的信息项 ApiId String 3b81fd160f5645e097cc8855d75a1cf6 API编号 ApiName String testapi API名称 BoundTime String 2016-07-23T08:28:48Z 绑定时间 Description String 描述 API描述 GroupId String ...

查询 API 服务文档

此功能面向调用API的用户,指定的API必须是发布到运行环境,且Visibility=PUBLIC的API或者被授权的Visibility=PRIVATE的API若您是调用API的用户,该接口返回您指定的API的服务信息及参数定义等详情信息。若您是开放API的用户,那么调用该...

插件绑定API

描述绑定插件到API上 此接口面向开放API的用户绑定操作只能选择发布状态的API绑定以后及时生效修改插件后及时生效 请求参数 名称 类型 是否必须 描述 Action String 是 操作接口名,系统规定参数,取值:AttachPlugin PluginId String 是 ...

查询 API 密钥绑定情况

类型 示例值 描述 ApiSignatures Array 由 ApiSignatureItem 组成的数组格式返回签名密钥的信息项 ApiSignatureItem 由 ApiSignatureItem 组成的数组格式返回签名密钥的信息项 ApiId String 46fbb52840d146f186e38e8e70fc8c90 API编号 ...

查询策略下绑定的 API

ApiInfo 组成的数组格式返回API的信息项 ApiId String 3b81fd160f5645e097cc8855d75a1cf6 API编号 ApiName String testapi API名称 BoundTime String 2016-07-23T08:28:48Z 绑定时间 Description String 描述 API描述 GroupId String ...

流控策略与 API 绑定

调用SetTrafficControlApis添加指定流控策略与API的绑定。此功能面向开放API的用户 用于添加API与策略的绑定关系,支持多个API批量操作,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,...

修改 API 分组

描述用于修改已经存在的API分组的名称或者描述 此功能面向API提供者该接口调用的QPS限制为:单用户QPS不超过50 请求参数 名称 类型 是否必须 描述 Action String 是 接口名称,系统规定参数,取值:ModifyApiGroup GroupId String 是 API...

查询策略与 API 绑定情况

类型 示例值 描述 ApiTrafficControls Array 由 ApiTrafficControlItem 组成的数组格式返回流控策略的信息项 ApiTrafficControlItem 由 ApiTrafficControlItem 组成的数组格式返回流控策略的信息项 ApiId String 46fbb52840d146f186e38...

解除策略与 API 绑定

调用RemoveTrafficControlApis解除API与流控策略的绑定关系。此功能面向开放API的用户 用于解除API与流控策略的绑定关系,支持API批量,最多100个 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,Open...

创建 API

调用CreateApi新建一个API。此接口面向开放API的用户。同一个分组内API不允许重名。同一个分组内Path不允许重复。该接口调用的QPS限制为:单用户QPS不超过50。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行...

给指定 app 添加多个 API 的访问权限

此功能面向API提供者和API使用者 API提供者可以授权自己的API给任意应用(app)调用 API使用者可以将已购买的API授权给自己的应用(app)调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI ...

使用 RAM 管理 API

acs:apigateway:$regionid:$accountid:apigroup/*CreateApi 创建API acs:apigateway:$regionid:$accountid:apigroup/$groupId DeployApi 发布API acs:apigateway:$regionid:$accountid:apigroup/$groupId AbolishApi 下线API acs:api...

解除IP访问控制与 API 的绑定

调用RemoveIpControlApis解除API与IP访问控制的绑定关系。此功能面向开放API的用户 即时生效,解除后该API的对应环境将不会有IP访问控制 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI ...

查询IP访问控制绑定的API

ApiInfo 组成的数组格式返回API的信息项 ApiId String 3b81fd160f5645e097cc8855d75a1cf6 API编号 ApiName String testapi API名称 BoundTime String 2016-07-23T08:28:48Z 绑定时间 Description String 描述 API描述 GroupId String ...

客户端调用API示例

Accept:application/json/请求响应体类型,部分 API 可以根据指定的响应类型来返回对应数据格式,建议手动指定此请求头,如果不设置,部分 HTTP 客户端会设置默认值*/*,导致签名错误。X-Ca-Request-Mode:debug/是否开启 Debug 模式,大...

查询 API 历史版本列表

默认值为10 StageName String 否 RELEASE 环境名称,可选值:RELEASE:线上 TEST:测试 返回数据 名称 类型 示例值 描述 ApiHisItems Array 由 ApiHisItem 组成的数组格式返回API的信息 ApiHisItem 由 ApiHisItem 组成的数组格式返回...
< 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 轻量应用服务器 商标 物联网无线连接服务 SSL证书 对象存储
这些文档可能帮助您
什么是阿里云实时计算Flink版 国内短信快速入门 短信服务-SendSms 人脸人体介绍 Web端上传介绍 快速使用ossbrowser

新品推荐

你可能感兴趣

热门推荐

新人福利专场 阿里云试用中心 企业支持计划 飞天会员助力企业低成本上云 智能财税30天免费试用 云解析DNS新用户首购低至36元/年起 ECS限时升级特惠6.5折