http api设计指南-http api设计指南文档介绍内容-阿里云

简介

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

基础术语

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

产品简介

API名称 API描述 ListProducts 查看产品列表 ListResourceTypes 查看资源元数据 CreateResource 创建资源 UpdateResource 更新资源 GetResources 查询资源 DeleteResource 删除资源一致的OpenAPI设计；使开发人员能够轻松地一致地管理云...

API 提供者 Demo

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

系统集群验证签名

说明如网关和服务端之间不需要双向认证，则无需引入 gateway-sdk，直接编写 HTTP API 服务即可。网关 SDK 新增了数据加密的功能，请参见数据加密。groupId>...

API使用指南

重要提示 AI Earth地球科学云平台现已上线，点击立即体验 AI Earth地球科学云平台基于达摩院在深度学习、计算机视觉、地理空间分析等方向上的技术积累，结合阿里云强大算力...API使用指南请参见：API使用指南-文档中心-AI Earth地球科学云平台

Restful API

Elasticsearch采用REST API，所有的操作都可通过HTTP API完成，例如增删改查、别名配置等。本文介绍Restful API的使用方法。Elasticsearch官方参考文档单文档API：Index API Get API Delete API Update API 多文档API：Multi Get API Bulk...

使用阿里云OpenAPI

您可以在 OpenAPI Explorer 中调用阿里云各云产品开放的 API，查看API请求和返回结果。阿里云 OpenAPI 开发者门户是一款集 OpenAPI 智能搜索、OpenAPI 文档、OpenAPI 在线调试、SDK 获取、CodeSample、调用出错诊断、调用统计为一体的产品...

创建 API

目前支持的类型为应用，表示 API 发布后支持 Web 浏览器、H5 容器、小程序、JS、业务系统的调用。请求路径：必填，针对应用设置的请求资源的 URL，通过请求路径可以定位到要请求的资源。支持英文字母、数字、下划线（_）、连接符（-），...

HTTP 转 SOFARPC 入门

本文介绍如何快速创建并发布一个 HTTP API 类型的 API 服务，通过 API 网关进行协议转换，使用 SOFARPC 协议将请求转发到后端业务系统集群。操作步骤说明建议您先阅读快速入门概述，了解 API 网关的角色及完整使用流程。示例工程为方便...

API unsupport the channel

API unsupport the channel:HTTP，API 只允许 HTTPS 访问，而发起 API 请求时却使用了 HTTP，则会得到此提示。API unsupport the channel:HTTPS，API 只允许 HTTP 访问，而 API 请求却使用的是HTTPS，则会得到此提示。解决方案：API ...

SDK和API概览

通用文档智能关于SDK使用的准备工作，请参考 SDK概述。关于API使用的准备工作，请参考 API使用指南。行业文档智能关于SDK使用的准备工作，请参考 SDK概述。关于API使用的准备工作，请参考 API概览。

API网关灰度发布最佳实践

如果用户需要指定授权给某些应用的API调用请求进入灰度环境，可以利用系统参数 CaAppId 来配置路由条件，配置如下-routes:name:appGrey condition:"$CaAppId=4534463 or$CaAppId=86734572"backend:type:HTTP address:...

新手指引

快速使用文档智能服务文档智能产品提供API接口、控制台可视化轻应用、小程序等多种使用方式，您可以灵活地采取各种接入方案：通用文档智能 API使用指南控制台使用指南小程序使用指南行业文档智能 API概览控制台使用指南常见问题产品...

服务端API接入

介绍如何接入虚拟数字人开放平台的服务端API，虚拟数字人开放平台的服务端API使用阿里云的标准OpenAPI接入方案，目前API SDK支持Java、python等多种开发语言，具体支持的开发语言和SDK版本可到虚拟数字人开放平台SDK 查看。整体接入流程 ...

API调用

本文提供通过API使用通用型导播的流程及API参考。前提条件您已经开通云导播服务，操作指引，请参见开通服务。您已完成需要导播的域名添加并配置CNAME，操作指引，请参见添加域名、视频直播CNAME。（可选）若您的视频源需要从直播控制...

API调用

本文提供通过API使用播单型导播台的流程及API参考。前提条件您已经开通云导播服务，操作指引，请参见开通服务。您已完成需要导播的域名添加并配置CNAME，操作指引，请参见添加域名、视频直播CNAME。（可选）若您的视频源需要从直播...

API调用

本文提供通过API使用虚拟演播厅的流程及API参考。说明导播台虚拟演播厅功能从2023年04月01日00:00起正式开始商业化收费，计费详情请参见云导播费用。如果您不需要使用该服务，请在商业化收费前，停止使用虚拟演播厅直播，以免产生费用。...

支持HTTP2.0

API网关支持HTTP2.0 API网关支持HTTP2.0新特性，支持API请求多路复用、支持请求头压缩。多路复用（MultiPlexing）：消除了 HTTP 1.x 中并行处理和发送请求及响应时对多个连接的依赖。可客户端和服务器可以把HTTP消息分解为互不依赖的帧，...

使用简单认证（AppCode）方式调用API

阿里云API网关提供多种针对客户端请求的安全认证方式，包括阿里云APP认证方式、jwt插件、第三方鉴权等。对于”阿里云APP“这种认证方式，目前用户可以设置两种认证形式：1.签名认证；2.简单认证。1.概述对于请求的签名认证方式，可以参考...

92af1abffc2443eaa2b815fdbd9c13f1 ApiOperation string 该 API 是创建（CREATE）或修改（MODIFY）CREATE FailedApis object[]预检失败的 API 信息 Path string 创建 API 时配置的请求路径/st1 HttpMethod string 创建 API 时配置的 HTTP ...

CLI接入指南

您可以使用阿里云CLI 接入EDAS的API，完成日常的管理操作。安装CLI 安装CLI的步骤，请参见：在Windows上安装阿里云CLI 在Linux上安装阿里云CLI 在macOS上...更多信息 API调用公共参数 Java SDK接入指南 Python SDK接入指南 OpenAPI开发者门户

HTTP API 入门

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

概览

同时，可查阅使用指南、API文档及关联产品推荐。功能介绍登录视图计算控制台，首页展示的即为概览页。您可以通过使用指引快速了解视图计算控制台功能。如果您第一次使用视图计算产品，请您仔细阅读使用指南。使用指南帮助您了解域名...

支持 HTTPS

可以控制到API级别，即您可以强制您的API只支持HTTP、HTTPS或者两者均支持。如果您的API需要支持HTTPS，操作流程如下：步骤1：准备您需要准备如下材料：一个自有可控域名。为这个域名申请一个SSL证书自定义上传证书，包含证书/私钥，均为...

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

接口说明此功能面向 API 提供者。SSL 证书必须与域名匹配。绑定 SSL 证书后，可提供基于 HTTPS 的 API 服务。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码...

概述

API 网关支持的协议转换如下：HTTP/HTTPS>HTTP/HTTPS HTTP/HTTPS>SOFARPC SOFARPC>HTTP/HTTPS DUBBO>HTTP/HTTPS HTTP/HTTPS>DUBBO SOFARPC>SOFARPC 请求认证为了保证数据在传输过程中的安全性，API 网关支持对数据进行签名校验，包括...

概述

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

ImportSwagger-通过 Swagger 创建 API

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

DryRunSwagger-预检查swagger

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

网站后台使用指南（总）

本文旨在概述网站后台如何使用，并串联如何使用网站后台分类下的所有帮助指南。网站的构成网站主要由两部分构成，以阿里云官网为例，如上图所示，域名为一部分，网站内容设计为一部分。域名部分：您需要购买域名、实名认证域名、备案域名...

3D播报数字人接入指南

public static void main(String[]args)throws Exception {/参考OpenAPI官方示例构建Client：https://next.api.aliyun.com/api/avatar/2022-01-30/StartInstance?useCommon=true&tab=DEMO&lang=JAVA Client client = Sample.createClient(.);...

SOFARPC 客户端接入

前置条件在进行本地订阅方应用开发、接入网关前，需要确保已经完成以下操作：已在 API 网关控制台创建了一个应用，参见创建应用。已将该应用的 APPID 提供给了 API 发布者，并获得了授权，参见授权 API。已获取了如下服务配置信息。具体...

3D推流数字人接入指南

public static void main(String[]args)throws Exception {/参考OpenAPI官方示例构建Client：https://next.api.aliyun.com/api/avatar/2022-01-30/StartInstance?useCommon=true&tab=DEMO&lang=JAVA Client client = Sample.createClient(.);...

发送 HTTP 请求（NodeJS）

应用的访问密钥（Access Key/Secret Key）API 的域名地址（host）、请求路径（path）、方法（method）、请求体（body）操作步骤发送请求到网关本质上就是一个简单的 HTTP 请求，但是由于当前 API 网关要求订阅方必须加签，所以在发起 HTTP...

环境管理

本文档介绍如何在API网关上进行环境管理。1.什么是环境管理当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...

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

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

HTTPS安全策略

分组HttpsPolicy的设置用户可以在分组上调整API分组所支持的HTTPS安全策略，HTTPS安全策略仅对绑定了域名及证书的分组有效，目前API网关支持 HTTPS1_1_TLS1_0 ，HTTPS2_TLS1_0 ，HTTPS2_TLS1_2 安全策略，但不同Region支持的安全策略列表...

调用API商品

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

API简介

欢迎您选择机器翻译，如果您熟悉网络服务协议和一种以上编程语言，推荐您调用机器翻译API实现自己的业务需求，如果您不熟悉编程语言可以通过非开发者流程使用在线平台使用指南。使用限制根据您使用机器翻译的实际情况，您能调用的翻译...

http api设计指南

新品推荐