API使用规范

API 本规范中“API”指:阿里云向您提供的应用程序编程接口(Application Programming Interface,简称API),您编程后通过该应用程序编程接口,可获取阿里云提供的弹性计算服务(ECS)、关系数据库服务(RDS)和对象存储服务(OSS)等阿里...

基础术语

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

概述

本文主要介绍网关的几个核心概念,以便更地进行 API 服务开发与调用。协议转换 API 网关不仅是一个简单的反向代理服务,同时还提供协议转换的能力,支持使用 A 协议调用 B 协议的接口。协议转换与使用的编程语言无关,但是仅 Java 语言...

概述

您可调用数据服务下的预置指标API...自定义服务API:您可以根据业务需要,新建自定义服务API,创建的自定义服务API可以调用来获取数据。具体操作,请参见 自定义服务API。调用示例 Java SDK调用示例 Python SDK调用示例 Node.js SDK调用示例

简介

API 应用程序编程接口 用户开放API,在API网关录入API,以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API,首先需要创建API分组 每个API分组拥有一个二级域名,两个Stage 用户需要将已经备案且解析至...

名词解释

参数映射 用户实际请求的参数与API服务后端参数不一致时,支持API服务方配置参数映射。参数校验 API服务方对入参设置校验规则,由网关根据规则对无效请求进行过滤。常量参数 不需要用户传入的,但是后端服务需要始终接收的常量参数。系统...

API 提供者 Demo

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

概述

角色说明 API 网关产品涉及以下两个角色:API 发布者:将自身应用的服务接口在 API 网关上创建并发布为 API 服务以对外发布。API 订阅者:使用客户端调用发布在 API 网关上的已获得授权的 API 服务。使用流程 API 网关的完整使用流程如下:...

SDK下载及使用指南

若您需要使用 SDK 调用您自己或者其他人在 API 网关开放的 API 服务(包括在 API 市场购买的 API 服务)注意这里的 API 服务是指在 API 市场购买的,或者您在 API 网关接入开放的,或者您的合作伙伴在 API 网关接入开放的那些 API 服务。...

相关协议

阿里云提供的交易和账单管理OpenAPI服务虽经过详细的测试,但不能保证其与所有的软硬件系统完全兼容,并不能保证所提供的服务毫无瑕疵,所以您同意:在阿里云操作交易和账单管理OpenAPI服务期间,阿里云将不对任何服务可用性、可靠性做出...

HTTP API

整体过程分为五步:注册 API 分组 创建 API 配置 API 服务 测试 API 服务 生成客户端 SDK 准备 登录控制台,在 产品与服务 中选择 移动开发平台 mPaaS 进入移动开发平台主页。切换至正确的工作空间后,单击需要接入 API 服务的 App 名称。...

系统集群验证签名

操作步骤如下:引入网关 SDK 配置 API 服务密钥 配置 Filter 引入网关 SDK API 网关的客户端依赖 gateway-sdk。对服务端而言主要是配置 spring 拦截器,对请求进行验签以及对响应进行加签。您需要在本地工程 pom.xml 中添加如下 SDK。说明 ...

应用场景

API 提供者在此提供标准的 API 服务,开发者在此将标准化的 API 服务整合进自己的应用,从而衍生出新的应用,新的服务。API 网关以此促进企业建立商业生态、跨界创新。通过 API 网关将企业的核心能力,开放给合作伙伴,达成深度合作,协同...

约束规范

支持API服务的级联发布,即可以在一个CSB实例上接入服务,可能途经其它中间CSB实例,然后在另一个目标CSB实例上开放服务,消费方应用直接访问目标CSB实例即可。支持对已发布API服务的级联扩展,例如在A实例接入B实例开放的API,可以再次...

产品简介

支持实时监控,提供API监控面板,您可以实时查看API服务详情,帮助快速定位问题。跨界创新。API即能力、API即数据,通过API可以进行创新。一方面可以将您的算法、能力、数据以API商品的形态发布到阿里云API市场,探索新的商业模式;另一...

产品功能

CSB基于API服务总线、API组织管理和API运维监控提供了诸多功能。API服务总线 提供高可用、稳定高效、可线性扩容的服务能力以及丰富全面的访问控制功能。协议转换:支持常用协议服务的接入和开放,支持复杂类型和结构的出入参数定义,以及...

二级域名是什么,有什么使用限制?

二级域名是默认给每个分组分配的域名,是一个公网二级域名。...注意:二级域名您也可以直接调用,不过仅供测试使用,每个二级域名每天1000次访问限制(海外Region及中国香港限制100次/天),您需要通过绑定自己的域名开放API服务

产品架构

应用调用 API 服务 应用通过 HTTP/SOFARPC/SOFAREST 等协议请求到网关。Mosng 网关根据内存中的 API 信息校验应用的请求信息(验签、解密、RPC 信息校验)。如果信息校验失败,则直接返回错误信息给应用。如果信息校验通过,则根据配置的...

HTTP API 入门

说明 如需认证功能,在步骤一编写后端系统、本地 API 服务开发时需要接入网关 SDK。详见 编写HTTP API。描述:用于描述系统集群的作用等,64 个字符以内,可为空。完成后单击 确定。步骤三:创建 API 分组 在左侧导航栏单击 API 发布>API ...

创建数据模型

API 网关支持将 API 服务的请求与响应参数定义成数据模型。继而在创建 API 时,可以直接引用数据模型的配置参数,提高参数设置效率。本文介绍如何快速创建 API 参数数据模型。操作步骤 进入 API 网关控制台页面,在左侧导航栏中选择 API ...

故障排除

CC API在调用时可能会遇到一些错误,遇到错误时以错误码为依据进行故障排除,本文为您介绍 常见错误码的解决方案。...ServiceUnavailable 原因:CC API服务不可用。解决方案:建议重试,如果多次重试报错请联系服务方或提交工单。

API 属性说明

OperationType 是 针对 mPaaS 移动应用设置的 API 服务标识,用于定位要访问的资源。支持英文字母、数字、英文句号(.),200 字符以内。需按照 com.xxx.opt1 的格式输入。请求路径 是 表示请求的资源的 URL,通过请求路径可以定位到要请求...

使用OpenAPI

数字证书管理服务OpenAPI服务接入点支持列表,请参见 服务接入点。用户身份 用户身份 支持情况 阿里云账号 支持 RAM 用户(推荐)支持 RAM角色(推荐)支持 推荐您使用 RAM用户 或 RAM角色,根据业务的实际情况按需分配权限后进行接口调用...

通过日志服务查看API调用日志

HTTP/HTTPS/WS instanceId API服务所在的网关实例ID initialRequestId API网关自调用时,例如API-1调用API-2,那么API-2的日志中会用initialRequestId来记录API-1的requestid。clientNonce 客户端X-Ca-Nonce头 requestQueryString 客户端...

API网关

instanceId API服务所在的网关实例ID initialRequestId API网关自调用时,例如API-1调用API-2,那么API-2的日志会用initialRequestId来记录API-1的requestid。clientNonce 客户端X-Ca-Nonce头 requestQueryString 客户端请求的查询字符串 ...

功能特性

数据模型 将 API 服务的请求与响应参数定义成数据模型,通过模型复用提高参数设置效率。支持参数类型有 string,int,long,float,double,boolean,list 等。外部授权 创建客户外部授权 API A,然后到业务 API B 配置中进行关联。当客户...

日志字段详情

appId 调用者应用ID appName 调用者应用名称 clientIp 调用者客户端IP exception 后端返回的具体错信息 exchangeTimestamp 整个请求链路的IO时间点 FrontRequestStart:API网关开始接收到客户端请求的时间点 FrontRequestEnd:API网关完成...

API报警设置

您可以通过云监控来对发布在API网关上的API配置报警,以便随时了解API服务运行情况,保障服务的稳定性。1.关联资源 API网关监控报警功能可以满足您多样化的业务需求,监控报警的指标包括:HttpStatusCode API响应时间 API总体请求次数 流入...

SetDomainCertificate-为自定义域名添加SSL证书

绑定 SSL 证书后,可提供基于 HTTPS 的 API 服务。调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息,可以在RAM权限...

调用方式

视觉计算服务接口调用是向视觉计算服务API服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 视觉计算服务API是RPC风格,您可以...

调用API

区块链服务API调用是通过向区块链服务服务端地址发送HTTP请求。您需要并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。请求结构 区块链服务API是RPC风格,您可以通过...

操作流程

服务封装流程及说明 流程图 流程说明 流程 说明 创建应用API应用管理,按应用获取密钥和访问域名信息供外部调用已获得授权API。创建工作组 创建工作组,达到各工作组之间空间隔离的效果。添加云计算资源 添加需要的云计算资源类型。...

调用方式

介绍产品调用API请求的请求和返回模式。请求结构 支持与服务API是RPC风格,您可以通过发送...下面是一个调用 ListEnterpriseDingtalkGroups 接口查询企业服务群列表的示例:说明 为了便于用户查看,本文档中的示例都做了格式化处理。...

导入Swagger API

注意 当使用共享实例发布Swagger API服务时,同一个服务组下最大只能发布3个服务。因此您需要选择小于等于3个服务进行发布,其他服务请先 不导入。待您完成第一批服务的调用后,在 我的服务 页面将其 注销,然后重新选择服务发布,分批完成...

API任务概述

通过直连数据源模式创建API 通过SQL模式创建API SQL模式是基于服务单元、Dataphin逻辑表通过编写SQL语句创建API,灵活应用。通过SQL模式创建API 通过向导模式创建API 向导模式基于服务单元、Dataphin逻辑表通过可视化界面配置API参数的方式...

QueryRequestLogs-获取请求日志

Backend service connect failed `Timeout connecting to[/1XX.20.0.XX:8080]` ConsumerAppId string 调用者应用 ID 11096*InstanceId string API 服务所在的网关实例 ID apigateway-bj-ab2b*ClientNonce string 客户端 X-Ca-Nonce 头 d43...

[推荐]模型服务灵积DashScope

模型服务灵积DashScope,通过灵活、易用的模型API服务,让各种模态模型的能力,都能方便的为AI开发者所用。通过灵积API,开发者不仅可以直接集成大模型的强大能力,也可以对模型进行训练微调,实现模型定制化。前提条件 DashVector:已创建...

API 管理

创建 API 信息 sofa.apigateway.api.create 用于快速创建一个 API 服务。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户标识 workspace_id STRING 是 default 工作空间标识 返回参数...

功能简介

API的生命周期管理:API支持数据服务API、三方API、数据上报API、数据更新API、空间服务API。支持API的创建、编辑和测试,支持的API类型包括实时查询类、离线批量类、流式数据类、非结构化数据类。API管理:支持对API上线、下线、测试等...

统一服务

API的生命周期管理:API支持数据服务API、三方API、数据上报API、空间服务API 和数据更新API。支持API的创建、编辑和测试,支持的API类型包括实时查询类、离线批量类、流式数据类、非结构化数据类。API管理:支持对API上线、下线、测试等...
共有200条 < 1 2 3 4 ... 200 >
跳转至: GO
产品推荐
云服务器 安全管家服务 安全中心
这些文档可能帮助您
API 网关 商标服务 云服务器 ECS 短信服务 对象存储 弹性公网IP
新人特惠 爆款特惠 最新活动 免费试用