DomainItem

描述"class="reference-link">描述 API的调用域名信息 节点名"class="reference-link">节点名 DomainItem 子节点"class="reference-link">子节点 名称 类型 描述 DomainName String API的调用域名

API名称是什么

名称是 API 标识,一个有意义的名称,可以让您的用户能够快速理解 API 功能。

API概览

术语表 术语 全称 中文 说明 app application 应用 一个应用即一个完整的搜索服务 错误码 API 描述 错误码说明 返回错误码说明 公共调用方式 API 描述 v3 API 签名机制 详细说明验签过程 应用操作接口 API 描述 数据处理 上传、修改、删除...

API概览

术语表 术语 全称 中文 说明 app application 应用 一个应用即一个完整的搜索服务 错误码 API 描述 错误码 返回错误码说明 公共调用方式 API 描述 授权机制 详细说明验签过程 应用操作接口 API 描述 数据处理 上传、修改、删除文档 搜索 ...

基础术语

中文 释义 API 应用程序编程接口,是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组,同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识,用于定位在访问的 API。...

授权管理

应用(APP)是调用API时的身份,应用(APP)需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用(APP)应用(APP)是调用API的身份,每个APP有一对AppKey和AppSecret密钥对,AppKey需要在请求时作为参数在...

AuthorizedApi

AuthorizedApis 描述"class="reference-link">描述 应用API的对应关系 节点名"class="reference-link">节点名 AuthorizedApi 子节点"class="reference-link">子节点 名称 类型 描述 RegionId String API所在区域 GroupId String API分组 ...

ErrorCodeSample

描述"class="reference-link">描述 错误码示例的类型 节点名"class="reference-link">节点名 ErrorCodeSample 子节点"class="reference-link">子节点 名称 类型 描述 Code String 错误码 Message String 错误信息 Description String 描述

SDK下载及使用指南

非开放者请前往:已授权 API SDK。您还可以在“应用管理”——点击应用名称进入应用详情—— SDK/文档自动生成链接,来生成 SDK。SDK 的使用说明将随 SDK 的生成一并压缩在下载压缩包内,请注意查看。SDK中的ClientReadTimeout时间配置...

API监控的维度

可以对 API 调用量、错误分布、响应时间、流量大小等维度进行监控。

为什么要填写API描述

对于 API 功能的具体描述,会展示给您的用户。

绑定/解绑 API

创建 CORS 规则后,您可在规则下绑定/解绑指定的 API。...批量解绑:若需要一次解绑当前规则下的多个 API,可先通过左侧的复选框勾选多个 API 后,单击页面底部的 批量解除授权,在弹出的确认框中单击 确定,即可批量解除 API 绑定。

版本管理

说明 当您需要编辑某个API的定义时,如果该API已经发布,对定义的修改不会对线上产生影响,定义修改后需要再次发布才能把修改后的定义同步到线上环境。2 对比差异 API编辑后您可以通过 对比差异 功能来与之前发布的API进行配置对比,确认...

API类型是什么

API 类型包含公开、私有两种,公测期间,两种类型无特殊区别。

返回值为空

用户发起的 API 请求只要能够到达网关,就会返回成功/错误的结果信息。重要的返回信息都在Header里面,以X-Ca开头的为网关返回的信息。其中较主要的为下面的几个信息:X-Ca-Request-Id:7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF/请求唯一ID,...

云导播API概览

本文提供云导播API的功能分组、接口描述以及接口文档参考。云导播API按功能可以分为:导播台管理 输入源媒体管理 布局管理 组件管理 节目单与节目管理 场景与音频管理 通道管理 备播管理 播单型导播台管理 虚拟演播厅管理 导播台管理 API ...

如何查看API的运行情况

API 网关,为您提供监控服务,您可以在控制台,以图表形式查看您 API 调用量、流量大小及错误分布等监控信息。

数据服务

加工后的数据供应用读取:通过数据工具对数据进行加工汇总后,业务应用希望读取这部分加工后的数据进行业务处理,则可通过API的方式快速输出。当需要变更读取的逻辑时,只需要调整API背后的数据逻辑,而不需要重新发布应用。目前API网关...

概述

完成API的创建和发布之后,本章节重点会从客户端(如其他业务系统的代码、手机APP或HTML页面中等)角度来介绍如何调用您发布在API网关上的API,因此重点会涉及到如下部分的内容:了解API的认证方式、适用场景并如何实现客户端代码-了解客户...

导出标准OAS定义

结合API网关的 导入标准OAS定义,您可以:跨平台跨地域迁移数据:借助API网关的导出和导入功能,您可以方便地从其他平台或API网关导出OAS规范的API数据,并在其他地域或账号下实现API的快速导入,简化您迁移的过程;API发布与扩展:通过将...

使用简单认证(AppCode)方式调用API

下面是对整个流程的描述:API提供者创建API的时候选择”阿里云APP“认证模式,且支持AppCode认证(所有云市场的API默认都支持AppCode);API调用者在API网关”应用管理“创建一个APP。云市场用户在云市场购买API时云市场会为您创建一个 APP...

绑定/解绑 API

绑定 API 在 授权管理 页面,找到目标应用,单击其名称进入该授权应用详情页。在打开的 绑定的 API 标签页中,单击 API 列表右上方的 绑定 API。在弹出的 绑定 API 窗口中,勾选需要绑定的 API。单击页面底部的 确认,即可完成绑定。解绑 ...

如何找到已购买的API

您在API市场上购买API之后,即完成API的自动授权。您可以在管理控制台寻找您都已经购买的API。打开 云市场,在右上角点击【买家中心】-【[进入管理控制台]】(https://market.console.aliyun.com/imageconsole/index.htm "进入管理控制台")...

DetachPlugin-解绑API绑定的插件

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

ApiPluginSummary

描述 绑定到插件的API概要信息 节点名 ApiPluginSummary 子节点 名称 类型 描述 RegionId String 所在的region GroupId String API分组编号 GroupName String API分组名称 StageName String Stage名称 ApiId String API编号 ApiName String...

API 网关服务等级协议(SLA)

本服务等级协议(Service Level Agreement,简称“SLA”)规定了阿里云向客户提供的API网关的服务可用性等级指标及赔偿方案。API网关的服务等级协议(SLA)请参见 API网关服务等级协议。

绑定/解绑授权对象

在 API 详情页的 授权对象 标签页下,您可以绑定授权对象、解除绑定以及限制应用访问 API 次数。绑定授权对象 进入 API 发布>API 管理 页面,找到待授权的 API,单击进入其详情页。在 授权对象 标签页下,单击 绑定授权对象,进入 添加...

版本说明

变更时间:2022-11-21 变更集发布说明:工作流支持资源组和资源组鉴权 OpenAPI 名称 变更内容概要 操作 CloneFlow OpenAPI 描述信息更新、OpenAPI 变更为 deprecated,即将下线、OpenAPI 错误码发生变更。查看API变更历史 查看API文档 变更...

应用场景

将 API 接入阿里云市场,以 API 形式开放能力、服务、数据供广大开发者采购使用,产生价值;在 API 市场,采购第三方成熟的能力和服务,避免平铺式开发,专注专业,借力发展。2.安全地实现多端统一,一套服务,多端输出 随着移动、物联网...

批量操作API

注意事项 批量修改API基础配置后,可一键发布API,发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据,没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用(APP)。...

API 提供者 Demo

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

AttachPlugin-绑定插件到API

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

ModifyApiConfiguration-修改API定义

本API用于修改API的草稿定义信息,区别于接口ModifyApi,不需要填充所有的API信息才能操作,只需指定要修改的参数进行修改。例如,当需要修改API的认证方式从匿名变为APP认证,只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...

导入API网关的扩展Swagger定义

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

产品简介

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

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

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

ApiHisItem

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

ApiInfo

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

CreateApiDestination-创建API端点信息

删除错误码:409 2023-04-06 OpenAPI 错误码发生变更、OpenAPI 入参发生变更 看变更集 变更项 变更内容 错误码 OpenAPI 错误码发生变更。错误码 409 变更 入参 OpenAPI 入参发生变更。删除入参:InvocationRateLimitPerSecond

导入导出 API

说明 为减少操作耗时,建议一次性导入/导出 API 数量不超过 100 个。导入 API JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 页面,在 API 列表左侧勾选需要导出的 API。单击 API 列表右下角的 批量导出...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 视觉智能开放平台 文件存储 CPFS 对象存储 短信服务 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用