开心网 api-开心网 api文档介绍内容-阿里云

API报警设置

4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...

VPC内网访问API网关

API网关支持用户通过公网或VPC内网访问API网关，本文重点介绍如何在VPC内网访问到API网关。1.概述 VPC内网访问时，需要通过每个分组的“内网VPC二级域名”来进行访问，该域名有如下特点：内网VPC二级域名只能在VPC内使用，支持直接访问，且...

创建后端服务为VPC内资源的API

概述您需要依次完成以下步骤：创建VPC授权创建分组创建并定义API 创建应用和API授权安全组放行调试API 调用API 1.创建VPC环境购买VPC环境的SLB、ECS，并搭建服务。本例API网关的后端服务选择的是专有网络VPC的ECS实例，ECS中部署了...

API 流量治理

在 API 详情页，您可以对该 API 进行流量治理，即配置限流与缓存。限流限流指对网关到后端集群的请求进行限制。操作步骤如下：说明目前 API 网关仅支持单机限流，即对经过网关单容器（非集群）到后端集群的请求进行限制。在 API 详情页，...

产品简介

API网关（API Gateway），提供API托管服务，覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等API各个生命周期阶段，帮助您快速建设以API为核心的系统架构。构建中台。通过API网关强大的适配和集成能力，可以将各种业务系统的...

基于Swagger完成API网关与用户CICD流程整合

如下图所示,一个整合了API网关的通用CICD流程，主要有如下步骤：步骤1：自动从您的API业务代码中获取swagger定义步骤2：创建API分组步骤3：通过API网关的OpenAPI导入API定义，并发布在不同的环境中步骤4：对API进行各项额外配置自动...

调用API商品

在左侧导航栏选择调用API>应用管理，找到购买成功后为您创建的应用。单击目标应用，进入应用详情，可以看到AppKey/AppSecret，AppCode等信息，此调用认证信息和在云市场控制台上一致。您购买的API商品会发布在不同的Region下，因此可以在...

CreateApiGroup-创建API分组

接口说明创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...

创建 API

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

导入API网关的扩展Swagger定义

Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...

Zookeeper

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

Nacos

API网关能够集成Nacos实现服务发现的功能，从而与微服务架构深入融合，降低系统的耦合度并提高程序的可管理性。网关可作为微服务系统的请求入口，负责所有客户端的接入、请求的路由和转发、以及保证微服务应用的安全和稳定。本文主要介绍...

TCP连接超时时间配置

使用API网关的TCP连接超时时间配置原则下图是用户的客户端在调用API网关时链路视图，链路比较简单，客户端的请求发送给API网关，API网关将客户端的请求转发给用户的后端服务，等用户的后端服务处理完业务逻辑返回应答后，API网关将后端...

使用自定义域名调用API

用户使用API网关对外提供服务时，需要使用自己拥有的域名开放自己的能力，本文主要描述如何将用户自己的域名绑定到API网关上，让客户端使用自己的域名来调用其开放的API。1.概述 1.1 域名与分组、API之间的关系用户需要将自己拥有的域名...

VPC融合专享实例

混合云网络互通，网关实例在向后端服务转发API请求时，后端服务希望网关实例的IP为VPC内的私网IP地址，详见场景三 API网关内网访问部署在IDC机房的后端服务。与传统方式的专享实例区别优势和局限性总结如下表：VPC融合专享实例传统方式...

产品简介

API 网关是金融分布式架构 SOFAStack 下的一个 API 管理平台，提供 API 托管服务，帮助企业开发者将内部系统的接口封装成 API 开放出去，供外部应用调用，为网络隔离的系统间提供高性能、高安全、高可靠的通信，同时保障内部系统的安全性。...

DescribeApiGroup-查询 API 分组详情

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

RemoveVpcAccess-撤销 VPC 授权

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

DDoS防护接入配置

针对DDoS攻击，API网关提供了5G的DDoS基础防护，但是针对大流量DDoS攻击，建议使用阿里云DDoS高防服务。关于DDoS高防的详细介绍，请参见什么是DDoS高防（新BGP&国际）。什么是DDoS 分布式拒绝服务（Distributed Denial of Service，简称...

数据加密

对应用开启加密后，默认该应用可访问的所有 API 都会进行加解密，如果部分 API 不需要加解密，可以在 API 列表关闭。步骤三：配置客户端密钥配置客户端加密，必须升级 SDK 到 2.4.0 版本及以上。代码示例如下：说明当前只支持 Java-SDK。...

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

API调用者到API网关控制台的”应用管理“找到AppCode/AppSecret进行签名认证的调用或者AppCode进行简单认证的API调用。2.创建支持简单认证方式API API提供者在创建API安全认证方式时需要选择”阿里云APP”；AppCode认证选项选择允许AppCode...

DescribeApi-查询 API 定义

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

函数计算

API 网关与函数计算对接，可以让您以 API 形式安全地对外开放您的函数，并且解决认证、流量控制、数据转换等问题。1 功能简介 API网关目前支持两种形式的函数，HTTP函数和事件函数。2 HTTP函数对接API网关 2.1 创建HTTP函数在配置API...

DescribeDeployedApi-查询API在指定环境中的定义

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

SetVpcAccess-添加 VPC 授权

接口说明此功能面向开放 API 的用户。授权 API 网关允许访问您的 VPC 实例。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下表是API对应...

API分组的归属实例迁移

2 迁移步骤您可以在控制台的左侧栏的 API管理 —— 分组管理 —— 分组详情页中找到变更分组实例链接，单击变更分组实例，选择目标实例，务必仔细阅读注意事项，之后单击确认迁移完成分组迁移，分组迁移会实时生效在API网关二级域名的...

DescribeApiHistory-查询历史版本详情

接口说明查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...

DescribeApiGroupVpcWhitelist-查询分组VPC白名单

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

RemoveVpcAccessAndAbolishApis-删除VPC授权

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

SOFARPC 客户端接入

前置条件在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见授权 API。已获取了如下服务配置信息。具体...

API网关为K8s容器应用集群提供强大的接入能力

很容易地升级应用程序容器的新版本提供容器弹性，如果容器失效就替换它 2.API网关作为Kubernetes集群的接入层架构我们可以看到Kubernetes集群是可以作为应用服务的，但是Kubernetes集群没有足够的接入能力，特别在大型应用中，它是不能够...

IP访问控制插件

5.接入WAF的同时跨VPC访问有一种场景，用户的API需要同时对公网和内网提供服务，而在公网提供服务的时候，在API网关前接入了WAF中间件，需要API网关对WAF前的客户端做IP访问控制，同时需要对内网来源做IP访问控制。网关为了这种场景做了...

ModifyInstanceAttribute-修改指定实例的信息

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

D504CO错误码排查

排查后端服务是否有黑白名单、后端服务应用程序是否启动、及防火墙是否有拦截；若后端是VPC类型，链路涉及到跨Region或是通过云企业网访问的IDC机房，则需要配置回程路由，文档可以参考访问云服务。2、Backend service connect failed `...

CreateInstance-创建实例

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

ValidateVpcConnectivity-VPC授权连通性测试

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

使用摘要签名认证方式调用API

API的拥有者可以在API网关控制台的应用管理页面生成APP，每个APP会携带一对签名密钥（APP Key和APP Secret）,API拥有者将API授权给指定的APP（APP可以是API拥有者颁发或者API调用者所有）后，API调用者就可以用APP的签名密钥来调用相关的...

如何配置出访连接池告警

若购买的专享实例规格为api.s1.small，最大出访连接池大小为1200，如果后端服务每个请求的应答时间在1秒时，那么这个实例最大支持的出访RPS是1200，超过1200后，如果请求进入API网关，后端连接池被占满，API网关会让请求进入一个等待队列，...

QuerySavingsPlansDeductLog-节省计划抵扣明细查询

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

开心网 api

新品推荐