api 590-api 590文档介绍内容-阿里云

授权信息

API：是指操作对应的API接口。访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。资源类型：是指操作中支持授权的资源类型。具体说明如下：对于必选的资源类型，用背景高亮的方式表示。对于不支持资源...

},"workspace_id":"antdemo","upstream_path":"/openapi/apigateway/test/api1","sys_id":"A3QV9pym9CaVKdLV0gIcQMsGNIplTZwd","path":"/openapi/apigateway/test/api1","domain_name":"fifhwqgcsmqo9ycl.apigateway.inc.alipay.net",...

多级API网关

用户在API网关创建的API除了能被客户端调用，还能被API网关本身调用。...在两个分组上创建两个业务API 在每个分组下分别生成一个业务API，两个API均设置为APP鉴权模式，假设两个API相关属性为：API1:Method:GET Path:/business1 后端地址为：...

DescribeApisByBackend-根据后端查询 API 列表

1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...

ApiIpControlItem

描述列举API上IP访问控制信息项的类型节点名 ApiIpControlItem 子节点名称类型描述 ApiId String API编号 ApiName String API名称 IpControlId String IP访问控制ID IpControlName String IP访问控制名称 BoundTime String 绑定时间

查看API操作历史

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

API网关监控

本文主要介绍管理员如何在API网关查看API的调用情况。概述 API网关的监控支持查看 region（地域）、分组、以及API 的监控图表，监控图表的指标主要包含请求数、流量、延时、HttpStatusCode。1.region监控 1.1 登录 API网关控制台。1.2 点击...

混合云API集中管理

本文介绍了如何结合云企业网（CEN），构建跨Region的集中式API管理方案。同时您也可以参考本例中的步骤，结合CEN、高速通道，构建在VPC间、VPC与本地数据中心间的集中式API管理，从而实现全网资源都可以发布在API网关、并通过API网关进行...

API 版本管理

下线后，API 状态切换为未发布，无法被该 API 的订阅方应用继续调用。您可以通过以下任一方法下线 API 当前版本：在 API 列表中选择要下线的 API，单击下线>确认。在 API 详情页面，单击右上角的下线按钮。在 API 详情>版本管理页签中...

使用SDK调用API

1.下载SDK 控制台提供两种SDK的下载方式，如下：1.1 在调用API 的已授权API的SDK 中下载应用APP的SDK，此SDK是基于APP生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java。其他语言调用示例在页面下方。1.2 在开放API 的...

DeleteApi-删除 API 定义

接口说明此功能面向开放 API 的用户，此操作不可逆 API 在运行环境中运行，则不允许删除，需要先调用 AbolishApi 操作下线该接口调用的 QPS 限制为：单用户 QPS 不超过 50 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算...

ModifyApi-修改API定义

接口说明"此接口面向开放 API 的用户该接口需要全量更新，不支持部分参数更新修改 ApiName 时需要注意，同一个分组内 API 不允许重名修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复该接口调用的 QPS 限制为：单用户 QPS ...

AbolishApi-下线 API

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

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

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

概述

4.开发者指南（OpenAPI）插件管理相关的OPENAPI如下：创建插件：CreatePlugin 修改插件：ModifyPlugin 删除插件：DeletePlugin 查询插件：DescribePlugins 绑定API插件：AttachPlugin 解绑API插件：DetachPlugin 查询插件绑定的APIs：...

DescribePluginApis-查询插件绑定的API列表

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

DeployApi-发布 API

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

发送 HTTP 请求（Java）

填写入参，他是一个object可以将实体类作为参数传进来，若想使用query方式传参需要将参数拼接至gatewayUrl 注意：若api后端协议是SOFARPC/DUBBO入参必须和后端服务接口入参完成一直，否则会出现序列化失败或者找不到接口的情况，参数字段为...

版本说明

变更时间：2023-07-04 变更集发布说明：OpenAPI 名称变更内容概要操作 GetTask API 内部配置变更，不影响调用。查看API变更历史查看API文档变更项变更内容 API 内部配置变更，不影响调用。CancelTask API 内部配置变更，不影响调用。...

产品简介

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

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

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

DescribeApisByApp-根据应用查询API列表

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

应用场景

API 提供者在此提供标准的 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 配置

请求参数名称类型是否必填示例描述 cors_id STRING 否 cors_id1 cors标识 param ApiInfoQueryVO 否-param tenant_id STRING 否 TSCPDICNT 租户标识 workspace_id STRING 否 default 工作空间标识返回参数名称类型示例描述 data ...

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...

api 590

新品推荐