api4-api4文档介绍内容-阿里云

注册API

参数描述 API名称支持中文、英文、数字、下划线（_），且只能以英文或中文开头，4~50个字符。API Path API存放的路径，例如/user。说明支持英文、数字、下划线（_）和连字符（-），且只能以（/）开头，不得超过200个字符。协议支持 ...

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

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

DescribeApisByApp-根据应用查询API列表

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

AttachPlugin-绑定插件到API上

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

创建 API

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

最大公网入访带宽（bps）最大公网出访带宽（bps）SLA api.s1.small 2500 50000 ...api.s2.large.x4 40000 800000 20000 19200 5120M 400M 99.99%api.s2.large.x5 50000 1000000 20000 24000 5120M 600M 99.99%api.s2.large.x6 60000 1000000...

根据应用查询API列表，返回环境聚合的结果

根据应用查询API列表，返回环境聚合的结果。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权信息，可以在RAM权限策略...

使用HTTPS并用域名访问

用户可以将自己的域名绑定到API网关的API分组上，API网关通过域名来定位到一个唯一的API分组，再通过Path+HTTPMethod确定唯一的API。API网关为每个分组默认提供了公网二级域名，如果客户端直接调用API分组提供的公网二级域名，将会受到每天...

模型管理

API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的...Api网关支持的模型可以参考如下定义：{"required":["name","photoUrls"],"type":"object","properties":{"id":{"format":"int64","type":"integer"},"category":{"$ref":...

配置后端服务Host（域名头）

Host概述当后端服务器同一个IP上存在多个Web应用程序（站点）时，就需要配置Host域名头，Host域名头可以指定API网关要访问的后端服务。常见应用场景如下：API网关后端服务配置的是VPC类型，并且VPC资源内有多个站点时，需要通过Host头指定...

专享实例集群

API网关现在支持使用专享实例组建专享实例集群，突破最大规格专享实例的限制，以提供更高性能。概述 API网关当前可以提供的专享实例能够支持的最大能力有限（实例规格），当最大规格的专享实例还无法满足您的使用需要时，网关支持将同地域...

流控信息

API名称 API版本配额配额维度 QueryOrders 2017-12-14 10/1(s)地域：*API限速维度：regionId,API,ParentUid QueryProductList 2017-12-14 10/1(s)地域：*API限速维度：regionId,API,ParentUid UpgradeResourcePackage 2017-12-14 100/60...

导出标准OAS定义

概述本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...

DeleteApiProduct-删除API产品

删除API产品，会自动删除API与API产品的绑定关系（如果存在API产品与APP的授权关系，将删除失败）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

AbolishApi-下线 API

接口说明此功能面向开放 API 的用户，和发布 API 相对应将指定环境中运行的指定 API 从运行环境里删除，需要一定的时间，最长不超过 5s API 下线后将不能被调用（指定环境）调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算...

DeployApi-发布 API

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

DescribeApisByBackend-根据后端查询 API 列表

操作访问级别资源类型条件关键字关联操作 apigateway:DescribeApisByBackend Read 全部资源*无无请求参数名称类型必填描述示例值 BackendId string 是后端服务 ID 4ac69b7a17524781b275ed4c5eb25c54 StageName string 否指定...

API调试及自助排错

请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪。X-Ca-Error-Message。API网关返回的错误消息，当请求出现错误时API网关会通过响应头...

DescribeApiMarketAttributes-获取API的属性

4F77-5EC4-BB7E-7344CEC7B5E6 MarketChargingMode string 云市场计费模式 PREPAID_BY_USAGE NeedCharging string 是否需要收费 true 示例正常返回示例 JSON 格式 {"ApiId":"6318cd8f6a304cac9318dea8d9a78f7a","RequestId":"545D4E52-4F77...

DescribePurchasedApis-获取购买的 API 列表

操作访问级别资源类型条件关键字关联操作 apigateway:DescribePurchasedApis Read 全部资源*无无请求参数名称类型必填描述示例值 GroupId string 否分组编号 d27ad517be5f4c95ac3631780a8f4d50 StageName string 否指定要操作...

DeleteApiGroup-删除 API 分组

接口说明此功能面向 API 提供者分组下存在 API 时，分组不可删除，须先删除分组下的 API 删除分组后，系统分配给此分组的二级域名自动生效删除不存在的分组时，会返回删除成功该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您...

BatchAbolishApis-批量下线API

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

API网关-监控服务关联角色

背景信息 API网关-监控服务关联角色（AliyunServiceRoleForApiGatewayMonitoring）是为了方便用户对同一分组上的所有API应用相同的报警配置时，而提供的RAM角色。更多关于服务关联角色的信息请参见服务关联角色。应用场景 API网关通过服务...

DescribeAuthorizedApis-查询已授权的API列表

接口说明此功能面向 API 使用者 App 可以调用查询结果返回的所有 API 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应的授权...

CreateApiGroup-创建API分组

条件关键字关联操作 apigateway:CreateApiGroup Write 全部资源*无无请求参数名称类型必填描述示例值 GroupName string 是分组名称，必须唯一，支持汉字、英文字母、数字、英文格式的下划线，必须以英文字母或汉字开头，4~50 个...

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

6C87A26A-6A18-4B8E-8099-705278381A2C","PageSize":10,"TotalCount":20,"ApiHisItems":{"ApiHisItem":[{"Status":"ONLINE","ApiId":"5af418828f0344a3b588c0cc1331a3bc","Description":"创建对象接口","GroupName":"myGroup2","GroupId":...

DescribeApisByIpControl-查询IP访问控制绑定的API

接口说明此功能面向开放 API 的用户分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透出。请求参数名称 ...

DescribeApiHistories-查询API历史发布的版本列表

接口说明此功能面向开放 API 的用户，有过发布的 API 才有历史版本记录调用该接口能获取 API 历史版本号数据，用于其他接口的调用调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer...

SetApisAuthorities-给多个API添加APP访问权限

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

RemoveTrafficControlApis-解除API与流控策略的绑定

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

DescribeApiGroups-查询 API 分组列表

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

ModifyApiGroup-修改API分组的信息

接口说明此功能面向 API 提供者该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API...

DescribeApiSignatures-查询API签名密钥绑定情况

接口说明此功能面向开放 API 的用户非必填的参数，不传入则默认返回所有，分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是...

DescribeApisBySignature-查询签名密钥绑定的API列表

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

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

接口说明此功能面向开放 API 的用户即时生效，解除后该 API 的对应环境将不会有 IP 访问控制调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

DescribeApiTrafficControls-查询API流控策略绑定概况

接口说明此功能面向开放 API 的用户非必填的参数，不传入则默认返回所有，分页返回调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是...

DescribeDeployApiTask-查询发布API任务进度

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

SetIpControlApis-绑定IP访问控制与API关系

接口说明此功能面向开放 API 的用户支持多个 API 批量操作，最多 100 个调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权...

Zookeeper

1.概述本文依次介绍如下步骤：原理说明创建VPC融合专享实例（仅VPC融合实例支持Zookeeper）部署Zookeeper服务并注册微服务应用创建分组创建后端服务创建API 创建应用并授予API的调用权限调试API 2.原理说明 Zookeeper 采用了类似文件...

api4

新品推荐