api.getprefs-api.getprefs文档介绍内容-阿里云

应用场景

API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...

日志项描述 apiGroupUid API的分组ID apiGroupName API分组名称 apiUid API的ID apiName API名称 apiStageUid API环境ID apiStageName API环境名称 httpMethod 调用的HTTP方法 path 请求的PATH domain 调用的域名 statusCode ...

DescribePurchasedApis-获取购买的 API 列表

RELEASE:线上 PRE:预发 TEST:测试 RELEASE ApiId string 否 API 编号 3b81fd160f5645e097cc8855d75a1cf6 ApiName string 否 API 名称纯真IP库查询接口 Visibility string 否 API 是否公开，目前可以取值：PUBLIC：公开，如选择此类型，该 ...

授权管理

API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...

调用API商品

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

管理应用

编辑应用信息打开应用编辑界面有以下两种方式：在应用列表页，单击应用右侧操作列中的编辑即可打开编辑应用界面。单击应用名进入应用详情页后，单击页面右上方的编辑即可打开编辑应用界面。打开的编辑应用界面与创建应用界面内容...

HTTP API 入门

步骤五：创建应用在左侧导航栏单击 API 订阅>应用管理页，单击列表右上方的创建应用。在创建应用窗口，选择应用类型为应用。输入应用名称，用于识别应用。本例使用 hello。单击确定。应用添加完成后，订阅者需在应用详情页，获取...

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

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

CORS 配置

data ARRAY[ApiInfoVO]-data 根据 CORS ID 查询 API 分页列表 sofa.apigateway.cors.api.list 用于查询指定 ID 的 CORS 绑定的 API 分页列表。请求参数名称类型是否必填示例描述 cors_id STRING 否 cors_id1 cors标识 param Api...

DeleteApiGroup-删除 API 分组

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

DeployedApiItem

描述"class="reference-link">描述列举API信息项的类型节点名"class="reference-link">节点名 DeployedApiItem 子节点"class="reference-link">子节点名称类型描述 RegionId String 所在的region GroupId String API分组编号 ...

API 提供者 Demo

网关支持用户下载服务端 Demo 进行测试使用，Demo 的代码分支为：server_demo。网关依赖如下：<dependency><groupId>...完成 Demo 的下载后，您可以进行以下多种类型的 API 服务开发与发布：HTTP API 服务 SOFARPC API 服务 DUBBO API 服务

ImportSwagger-通过 Swagger 创建 API

接口说明阿里云目前支持基于 Swagger 2.0 的扩展只支持 json/yaml 格式的 Swagger 配置文件调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权...

ApiSignatureItem

描述"class="reference-link">描述列举API签名密钥信息项的类型节点名"class="reference-link">节点名 ApiSignatureItem 子节点"class="reference-link">子节点名称类型描述 ApiId String API编号 ApiName String API名称 SignatureId...

CreateApiGroup-创建API分组

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

使用后端服务提高管理效率

本文将快速引导您在API网关创建后端服务，并使用该后端服务创建，发布，管理API。概述随着用户管理的API越来越多，为了让用户更方便的对API进行治理，API网关将现在支持的后端服务提取为region上的资源。用户可以在API网关控制台统一配置...

API网关-事件总线服务关联角色

本文为您介绍API网关-事件总线服务关联角色（AliyunServiceRoleForApigatewayPutEventsToEventBridge）的应用场景以及如何删除API网关-事件总线服务关联角色。背景信息 API网关-事件总线服务关联角色（AliyunServiceRoleForApi...

BatchAbolishApis-批量下线API

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

SetSignatureApis-绑定签名密钥与API

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

BatchDeployApis-批量发布API

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

创建 API

示例如下：示例中API分组绑定的请求HOST为xuemeng.XXXX.com，API后端HOST为apigatewayXXXXXXalicloudapi.com:8080，配置前后如下透传HOST头（域名头）开启时：Host:xuemeng.XXXX.com 透传HOST头（域名头）未开启时：Host:api...

函数计算内网访问API网关

1 概述 API网关即能够和函数计算集成，构建起serverless架构，同时在实际场景中，也会出现在函数中需要调用API网关上发布的API，同时很多时候出于安全考虑，往往会希望函数从内网能够访问API。因此本文着重介绍两个场景的实现方式：在同一...

管理 CORS 规则

在绑定的 API 列表中，您可以：查看 API 详情：单击 API 名称，即可跳转至该 API 的详情页，您可查看该 API 的配置信息、版本管理、监控、流量治理、CORS、授权对象、API 调试等详细信息。筛选前端协议类型：单击前端协议类型右侧的...

使用外部授权 API

API 网关支持外部授权功能。通过该功能，用户可以在网关将请求转发给 real-server 之前，插入一个自定义的远程接口。网关会先将请求转发给这个自定义接口，该接口继而选择是否允许这个请求正常转发到 real-server。如下图所示，步骤 2 即为...

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

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

DescribeAbolishApiTask-查询API下线任务

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

使用VPC内资源作为API的后端服务

2.3 创建API 创建API的流程与其他类型API方式一致，创建API分组以及定义API可参考创建 API 创建应用以及授权可参考创建后端服务为VPC内资源的API 2.4 测试API 可以通过以下方式测试您的API 调试API 下载SDK 使用简单认证（AppCode）方式...

ApiTrafficControlItem

描述"class="reference-link">描述列举API流控策略信息项的类型节点名"class="reference-link">节点名 ApiTrafficControlItem 子节点"class="reference-link">子节点名称类型描述 ApiId String API编号 ApiName String API名称 ...

接入 SDK

要使用 SDK 访问 API 网关的 OpenAPI，您必须引入以下两个 SDK：基础 SDK：是 SOFAStack 中通过 SDK 调用任何 API 时都必须依赖的 SDK。基础 SDK-><dependency><groupId>cn.com.antcloud.api</groupId><artifactId>antcloud-api-sdk...

功能概览

API网关支持以下功能。API 生命周期管理覆盖设计、开发、测试、发布、运维监测、安全管控、下线等API各个生命周期阶段，API网关为每个阶段提供生产力工具；协议处理支持HTTPS、SSL卸载、支持HTTP2.0；支持通过泛域名调用API；请求转发 ...

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

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

导入标准OAS定义

API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义主要包括...

DescribeApiMarketAttributes-获取API的属性

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

API 订阅者 Demo

网关依赖如下：<dependency><groupId>com.alipay.sofa</groupId> <artifactId>gateway-sdk</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>cn.com.antcloud.api</groupId><artifactId>antcloud-api-apigateway...

WAF接入配置

1 概述 API网关的核心是为API提供认证、防篡改、防重放、参数验证、全链路签名、限流等诸多安全功能，因此针对恶意攻击者精心构造的攻击请求，进行应用层攻击（如OWASP TOP10常见Web攻击等）、暴力破解等情况，您可以考虑接入云盾Web应用...

DescribePurchasedApiGroup-获取购买的 API 组

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

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

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

创建 API

DUBBO 服务发布 XML 实例<beanid="testService"class="com.dap.provider.TestServiceImpl"/><dubbo:serviceref="testService" interface="com.dap.api.IService"group="dubbo分组"version="服务版本"timeout="5000"/>超时时间：必填，API ...

DescribeAuthorizedApis-查询已授权的API列表

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

AttachPlugin-绑定插件到API上

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

api.getprefs

新品推荐