html5提供新的api-html5提供新的api文档介绍内容-阿里云

绑定/解绑 API

授权对象创建成功后，您可在该授权对象下批量绑定或解绑指定的 API。绑定 API 在授权管理页面，找到目标应用，单击其名称进入该授权应用详情页。在打开的绑定的 API 标签页中，单击 API 列表右上方的绑定 API。在弹出的绑定 API 窗口...

BatchAbolishApis-批量下线API

批量下线已经发布到环境的API。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...

DescribeApisByBackend-根据后端查询 API 列表

查询使用该后端服务创建的草稿态API，或已发布在某个环境上的API。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息...

创建 API

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

DescribeApiDoc-查询API说明文档

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

DescribeHistoryApis-查询API发布版本定义列表

RELEASE：线上 TEST：测试 RELEASE ApiId string 否指定要查询的 Api 编号 a12068f555964ca8a0c9c33288f1e5a7 ApiName string 否 API 名称（模糊匹配）getPersonInfo PageSize string 否分页参数：每页显示条数。10 PageNumber string 否...

DescribeAuthorizedApis-查询已授权的API列表

查询指定 APP 已授权的API列表，即指定 APP 的API列表。接口说明此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...

管理 API 分组

API 列表：列出了该 API 分组下所有的 API 以及 API 的概览信息，比如 API 名称，前端协议类型、OperationType/接口名称、请求路径、方法、状态、后端服务类型等。在此列表，您还可以对各个 API 进行下线、发布、删除等操作。在列表右上方...

SDK下载及使用指南

若您需要使用 SDK 调用 API 网关开放的 OpenAPI 注意这里的 OpenAPI 是指用于操作 API 网关产品的 API。您需要前往阿里云 SDK 页面下载 SDK 并查看使用。SDK 下载请前往阿里云 SDK 页面各个语言的“获取各产品 XXX SDK”页面下载，若页面...

创建 API 分组

API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击...

RemoveVpcAccess-撤销 VPC 授权

接口说明此功能面向开放 API 的用户撤销 API 网关访问您 VPC 实例的权限说明删除授权可能会影响您线上的 API 运行，请在删除前确认此授权未被 API 使用。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行...

使用简单认证（AppCode）方式调用API

下面是对整个流程的描述：API提供者创建API的时候选择”阿里云APP“认证模式，且支持AppCode认证（所有云市场的API默认都支持AppCode）；API调用者在API网关”应用管理“创建一个APP。云市场用户在云市场购买API时云市场会为您创建一个 APP...

DescribePurchasedApis-获取购买的 API 列表

获取在云市场购买的 API 列表。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...

DeployApi-发布 API

接口说明此功能面向开放 API 的用户，定义的 API 只有发布到运行环境，才能被调用 API 发布到集群里需要一定的时间，最长 5 秒后生效该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，...

DetachPlugin-解绑API绑定的插件

操作访问级别资源类型条件关键字关联操作 apigateway:DetachPlugin Write 全部资源*无无请求参数名称类型必填描述示例值 PluginId string 是绑定的 API 网关插件 ID 05df2b52a3644a3a8b1935ab8ab59e9d GroupId string 是指定...

DescribePluginsByApi-查询API上绑定的插件

接口说明此功能面向开放 API 的用户支持分页调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略...

建议使用云效新版 API 的说明

云效 API 正进行升级，原旧版 API 将不再演进，建议您将 API 切换到新版，点击云效新版 API 手册查看新版接口。如您有 API 相关需求，或者在 API 使用过程中遇到问题，欢迎添加钉钉群 34604478 反馈给我们。

BatchDeployApis-批量发布API

描述 test Api object[]否指定要操作的 api 列表 GroupId string 是 API 分组编号 b4f5c342b8bc4ef88ccda0332402*ApiUid string 是 API 唯一标识 2b35dd68345b472f8051647306a1*返回参数名称类型描述示例值 object OperationId string...

管理应用

API 订阅列表在应用详情页的 API 订阅列表标签页中，可查看当前应用已订阅的 API。在 API 订阅列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的定义、请求参数、响应示例、错误码等详细...

DescribeApisByApp-根据应用查询API列表

根据APP查询关联的API列表。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素...

AttachPlugin-绑定插件到API上

接口说明此接口面向开放 API 的用户绑定操作只能选择发布状态的 API 绑定以后及时生效修改插件后及时生效调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例...

ApiPluginSummary

描述绑定到插件的API概要信息节点名 ApiPluginSummary 子节点名称类型描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...

SetAppsAuthToApiProduct-批量授权多个APP给指定API...

批量授权多个APP给指定的API产品调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action...

管理 CORS 规则

绑定的 API 在 CORS 规则详情页的绑定的 API 页签中，可查看当前 CORS 规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的配置信息、版本管理、监控、流量...

DetachApiProduct-解除API与API产品的绑定关系

解除API与API产品的绑定关系调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称类型必填描述示例...

根据APP查询有权限的API产品列表

根据APP查询有权限的API产品列表调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action...

ImportOAS-通过OAS导入API

调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...

管理授权对象

绑定的 API 在授权应用详情页的绑定的 API 标签页中，可查看当前授权应用已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的授权对象、配置信息、版本管理等详细...

查看API操作历史

操作步骤登录API网关控制台。在API管理菜单中点击 API列表，找到想要查询的API，点击API名称或在操作栏点击管理进入API详情页。在API详情页的左侧栏点击 ...目前可查看的历史记录包括创建、编辑、发布、下线、回滚、绑定插件、解绑插件。

管理路由规则

绑定的 API 在路由规则详情页的绑定的 API 标签页中，可查看当前路由规则已绑定的 API。在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的授权对象、配置信息、版本管理等详细...

参数访问控制插件

2.配置说明在这个例子中假设我们的API请求Path为/{userId}/.,API使用JWT认证，JWT中有userId和userType两个claim,我们这个插件的校验条件为：当userType=admin时，允许所有的路径。当userType=user时，仅允许/{userId}路径一致的请求。在...

upstreamType":"SYSTEM_CLUSTER","apiId":"1h3WttiKTeTUtZpWn5Xg5P5bu2UBGjrP","apiStatus":"CLOSED","workspaceId":"antdemo"}],"result_code":"OK"} 查询 API 分页列表 sofa.apigateway.api.list 用于快速查询 API 分页列表。...

返回值为空

其中较主要的为下面的几个信息：X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与...

管理数据模型

绑定的 API：列出了绑定了该数据模型的所有 API 及其基本信息，包括 API 名称、API 分组、授权应用数量、前端协议类型、请求路径等。在此列表，您还可以单击任一 API 名称，进入该 API 的详情页查看 API 的具体信息及监控数据等。参数配置...

支持 HTTPS

API网关也支持使用HTTPS对您的API请求进行加密。可以控制到API级别，即您可以强制您的API只支持HTTP、HTTPS或者两者均支持。如果您的API需要支持HTTPS，操作流程如下：步骤1：准备您需要准备如下材料：一个自有可控域名。为这个域名申请...

ApiHisItem

StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...

如何使您的API支持HTTPS？

首先，您需要申请一张SSL证书，然后将SSL证书，将证书绑定到网关（查看分组明细-找到相应域名-上传证书）。其次，将您的API请求协议修改为：HTTPS或者HTTP和HTTPS。

如何找到已购买的API

您可以在管理控制台寻找您都已经购买的API。打开云市场，在右上角点击【买家中心】-【[进入管理控制台]】(https://market.console.aliyun.com/imageconsole/index.htm "进入管理控制台")在左侧菜单，点击【API】即可，如图：

API网关监控

1.3 region监控仅对最近7天内的API调用情况进行统计监控。可根据API发布的不同环境（线上、预发、测试）查看监控图表。可监控指标包括：API请求次数统计按实例统计API请求次数流量统计（请求流量、应答流量）平均延时（API网关处理延时、...

html5提供新的api

新品推荐