api协议开放-api协议开放文档介绍内容-阿里云

发布服务示例场景概述

发布服务就是将一个已有的后端服务在某个CSB实例上注册，并以选定的一种或多种协议开放成API供消费者使用，同时对服务的消费做一定的访问控制。服务发布包含以下三个概念。接入服务：提供API对应的后端服务信息，让CSB能访问到这个已有的...

发布后端已有服务

发布服务就是将一个已有的后端服务在某个CSB实例上注册，并以选定的一种或多种协议开放成API供消费者使用，同时对服务的消费做一定的访问控制。前提条件在体验发布服务前，您需要完成以下操作：创建实例新建服务组了解服务发布的约束...

管理应用

筛选 API 协议类型：单击 API 协议类型右侧的筛选按钮。在打开的筛选框中，选择对应类型的 API 协议并单击确定即可进行筛选。筛选 API 状态：单击状态右侧的筛选按钮。在打开的筛选框中，选择已发布或未发布，并单击确定即可进行...

应用 API 开放

开放 API 可在【API 开放】标签中为指定应用开启/关闭接口调用。启用后，将在【通用配置】标签中获取到的 client_id、client_secret 提供给应用开发者，在正确设定权限后，即可调用接口。接口权限管理员可为指定应用分配其调用的接口权限...

授权API

在 API协议变更对话框中，设置变更后的API协议，单击确认。说明如果您删除了原有协议，则原有协议的接口会调用失败，请谨慎操作。协议变更实时生效。查看获得授权的API 在 API管理页面，单击获得授权的API，查看所有获得授权的API。您...

开放平台概览

DataWorks开放平台提供开放API（OpenAPI）、开放事件（OpenEvent）、扩展程序（Extensions）的能力，可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维，及时响应应用系统对接DataWorks的业务状态...

应用场景

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

开放平台：能力全面开放

DataWorks开放平台提供开放API（OpenAPI）、开放事件（OpenEvent）、扩展程序（Extensions）的能力，可以帮助您快速实现各类应用系统对接DataWorks、方便快捷的进行数据流程管控、数据治理和运维，及时响应应用系统对接DataWorks的业务状态...

DescribeApps-查询应用列表

接口说明此功能面向开放 API 的用户 API 开放者可通过 AppId 或者阿里云登录账号查询 app 信息，进而操作授权每个用户在每个 Region 每天调用次数上限为 200 次调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...

API报警设置

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

名词解释

独立域名 开放API服务，需要为分组绑定独立域名。客户通过访问该独立域名调用API。签名密钥 API服务方可以创建签名密钥并绑定到API上，网关到服务方后端的请求就会带上签名信息，用于后端的安全验证。流量控制策略用于API服务方对API、...

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

API网关也支持您部署在专属网络VPC中的服务开放API。若您的后端服务在VPC环境，需要进行授权API网关访问才可开放相应API。1.授权与绑定VPC 开放VPC环境的API，需要您先授权API网关可访问您VPC内的服务。授权时需指定API网关可以访问的资源+...

API网关监控

4.2 左侧栏选择 开放API —— API列表。点击想要查看监控的API，进入API详情页。4.3 在左侧栏选择监控信息，可以根据环境（线上、测试、预发）查看该API近一周的监控数据。监控指标包括：请求次数（成功、异常）流量（上行、下行）后端...

如何关闭公网访问

操作步骤如下：登录API网关控制台，在左侧栏单击 开放API —— 分组管理。在分组列表中找到想要关闭公网访问的分组，单击分组名称进入分组详情页。在分组详情页的公网二级域名后面找到关闭公网访问按钮，单击确定后即可关闭公网访问。...

VPC内网访问API网关

配置方法：在 API网关控制台->开放API->分组管理->分组详情，点击“开通VPC二级域名”，网关会自动给该分组创建一个内网VPC二级域名，通过该域名可以直接访问API。3.专享实例设置方式专享实例的VPC内网访问能力仅只对某一个VPC开放，其他...

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

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

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

操作步骤如下：进入 API网关控制台，在左侧导航栏选择 开放API-后端服务；在搜索框，通过后端服务类型 EventBridge 搜索后端服务，在右侧操作列点击删除；进入 RAM控制台，点击左侧菜单 RAM 角色管理，找到角色 AliyunServiceRoleForApi...

DescribeRegions-查询支持的区域

接口说明查询支持的区域列表此功能面向开放 API 和调用 API 的用户调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无授权信息透...

DeleteApi-删除 API 定义

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

DeleteAllTrafficSpecialControl-删除所有特殊流控

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

DeployApi-发布 API

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

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

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

AbolishApi-下线 API

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

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

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

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

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

RemoveSignatureApis-解除API与后端签名密钥的绑定

接口说明此功能面向开放 API 的用户即时生效，解除后网关到后端服务的请求将不带有签名字符串，请后端去掉相应的校验环节调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动...

DeleteTrafficSpecialControl-删除特殊流控

接口说明此功能面向开放 API 的用户接口需要用到的入参可以调用其他接口获取调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息当前API暂无...

为分组绑定插件

3.快速使用登录API网关控制台，左侧栏找到 开放API —— 插件管理。单击右上角创建插件，在页面中自定义插件名称，选择插件类型，配置插件规则。配置好插件规则后，点击创建，随后在插件列表中就可以看到刚刚创建的插件了。点击右侧的绑定...

产品简介

通过开放API，可以大大提高各个环节的协作效率，促成更加健康的商业生态。支持实时监控，提供API监控面板，您可以实时查看API服务详情，帮助快速定位问题。跨界创新。API即能力、API即数据，通过API可以进行创新。一方面可以将您的算法、...

使用SDK调用API

1.2 在 开放API 的 SDK/文档自动生成中下载API分组的SDK。此SDK是基于分组生成的。目前支持自动生成的SDK语言包括Objective-C、Android、Java、GOlang、TypeScript。2.使用SDK调用API 通过控制台下载的SDK，下载解压后的目录结构如图：SDK...

AttachPlugin-绑定插件到API上

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

ModifyApi-修改API定义

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

RemoveVpcAccess-撤销 VPC 授权

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

DescribeTrafficControlsByApi-查询API绑定的流控策略

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

DeletePlugin-删除插件

接口说明此接口面向开放 API 的用户。必须先解除 API 和插件的绑定关系，否则删除报错。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试授权信息下...

DescribeSignaturesByApi-查询API绑定的后端签名密钥

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

SetTrafficControlApis-添加指定流控策略与API的绑定

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

API网关-微服务集成服务关联角色

操作步骤如下：进入 API网关控制台，在左侧导航栏选择 开放API-后端服务；在搜索框，通过后端服务类型 EDAS 搜索后端服务，在右侧操作列点击删除；进入 RAM控制台，点击左侧菜单身份管理，找到角色 AliyunServiceRoleForApi...

DescribeDeployedApis-查询已发布 API 列表

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

ModifyPlugin-修改插件

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

api协议开放

新品推荐