API 类商品接入说明
API 类商品接入，即允许云市场售卖您提供的 API 类商品。本文介绍 API 类商品在云市场上架的操作步骤。前提条件 入驻 API 集市。将您的 API 服务部署在阿里云 API 网关，详情请参见 发布API商品。API 类商品接入 登录云市场 服务商后台。在...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
阿里云OpenAPI
API（应用程序编程接口）是一种允许应用程序之间相互通信的标准接口。API 允许开发者在多个不同的应用程序之间共享数据、功能和服务，使开发者更容易地实现连接两个应用程序之间的功能，也使开发人员可以更轻松地开发和扩展应用程序。Open...
API使用规范
API 本规范中“API”指：阿里云向您提供的应用程序编程接口（Application Programming Interface,简称API），您编程后通过该应用程序编程接口，可获取阿里云提供的弹性计算服务（ECS）、关系数据库服务（RDS）和对象存储服务（OSS）等阿里...
API使用规范
定义 1.1 API：指应用程序编程接口（Application Programming Interface），是指一些预先定义的函数，目的是提供用户与应用程序之间基于某软件或硬件得以访问一组例程的能力，且用户无需访问源码，或理解内部工作机制的细节。1.2 云解析DNS...
测试与发布API
开发的API只有通过测试并发布至数据服务市场中，用户才可以在数据服务市场中查询并申请调用该API的权限。本文为您介绍如何测试与发布API至数据服务市场中。前提条件 在开始执行操作前，请确认您已完成API的创建。更多信息，请参见 API任务...
公共参数
介绍每个接口都需要使用的请求参数和返回参数。公共请求参数 公共请求参数是指每个接口都需要使用到的请求参数。名称 类型 是否必须 描述 Format String 否 返回值的类型，支持 JSON 与 XML。默认为 XML。Version String 是 API 版本号，为...
使用简单认证（AppCode）方式调用API
下面是对整个流程的描述：API提供者创建API的时候选择”阿里云APP“认证模式，且支持AppCode认证（所有云市场的API默认都支持AppCode）；API调用者在API网关”应用管理“创建一个APP。云市场用户在云市场购买API时云市场会为您创建一个 APP...
DescribeApiMarketAttributes-获取API的属性
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
数据服务概述
数据服务与API网关（API Gateway）完全集成，支持您将数据服务快速发布到API网关，从而使用API网关提供的API权限管控、IP白名单控制、流量控制、计量计费、SDK下载等全面的API服务。因此在使用数据服务前，请先开通 API网关。更多API网关...
错误码列表
如果调用API失败，会返回对应的异常错误码以及错误信息。以下异常信息对照表可以帮助您找到解决方法。HTTPCode 错误码 错误信息 描述 500 InternalError The request processing has failed due to some unknown error.服务端异常（主要是...
用户如何通过API使用镜像？
使用方式请参照API手册进行调用。需要注意的是，镜像必须订阅才能使用，因此API用户需要先在镜像商品页面完成对镜像的订阅操作，才能通过API使用镜像。
返回结果
调用 API 服务后返回数据采用统一格式，本文为您提供返回成功结果和错误结果的示例。数据格式 返回的 HTTP 状态码为 2xx，代表调用成功。返回的 HTTP 状态码为 4xx 或 5xx，代表调用失败。调用成功返回的数据格式主要有 XML 和 JSON 两种，...
API余量获取
获取用户的API余量、总量、使用量等数据 注意:该接口支持主账号和Ram子账号获取API余量、总量、使用量信息 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
开发参考
OpenAPI是阿里云产品提供的开放应用程序接口，是除了控制台外，主要的服务形式之一。您可以通过编程的方式来使用阿里云产品提供的服务。API参考汇总了 云原生数据库PolarDB 所有对外公开的API接口供您参考。PolarDB MySQL版 SDK下载 API...
简介
如果您熟悉网络服务协议和一种以上编程语言，我们推荐您使用城市视觉智能引擎API管理您的云上资源和开发自己的应用程序。更多详情，请参阅 API概览。使用说明 我们支持 HTTP 或者 HTTPS 请求，允许 GET 和 POST 方法。您可以通过以下方式...
产品优势
方便开发者快速构建与阿里云相关的应用程序，包括Java、Python、Node.js、Go等。最佳实践 提供集成阿里云OpenAPI的最佳实践。基于大量官方和用户主动分享的社区模式，帮助更多用户。全局可视 全方位展示集成运行状态，涵盖全局调用趋势、...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
DescribePurchasedApis-获取购买的 API 列表
获取在云市场购买的 API 列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action ...
DescribeApis-查询定义中的 API 列表
接口说明 此功能面向开放 API 的用户 接口返回所有定义中的 API 列表，以及概况信息 请注意是返回所有编辑中的 API 定义信息，跟环境无关，也可能跟环境中正在运行的定义不同，是最新的编辑结果 调试 您可以在OpenAPI Explorer中直接运行该...
阿里云SDK
阿里云OpenAPI提供多种编程语言和开发框架的SDK，方便开发者快速构建与阿里云相关的应用程序（包括Java、Python、Node.js、Go等语言）。如果您还不了解什么是OpenAPI，请参见 什么是OpenAPI？阿里云SDK的分类 云产品提供的用于使用OpenAPI...
授权管理
API授权是指应用（APP）与API建立授权关系。应用（APP）是调用API时的身份，应用（APP）需要获得API的授权才能调用该API。前提条件 API认证方式为"阿里云APP认证"1 应用（APP）应用（APP）是调用API的身份，每个APP默认有一对AppKey和...
CreateApi-创建 API
PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架。PUBLIC Description string 否 API 描述信息，最多 180 个字符 Api description AuthType string 否 API 安全认证类型，目前可以取值：APP：只允许已...
API调试及自助排错
请求唯一ID，请求一旦进入API网关应用后，API网关就会生成请求ID并通过响应头返回给客户端，建议客户端与后端服务都记录此请求ID，可用于问题排查与跟踪。X-Ca-Error-Message。API网关返回的错误消息，当请求出现错误时API网关会通过响应头...
DescribePurchasedApiGroup-获取购买的 API 组
获取云市场购买的 API 分组详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
ModifyApiConfiguration-修改API定义
本API用于修改API的草稿定义信息，区别于接口ModifyApi，不需要填充所有的API信息才能操作，只需指定要修改的参数进行修改。例如，当需要修改API的认证方式从匿名变为APP认证，只需要传入AuthType的值APP即可。调试 您可以在OpenAPI ...
DescribeApi-查询 API 定义
接口说明 此接口面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
DescribePurchasedApiGroups-获取购买的API分组列表
获取云市场购买的 API 分组列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action...
DescribeDeployedApi-查询API在指定环境中的定义
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 Action 元素中使用，用来给RAM用户或RAM...
DescribeApiHistory-查询历史版本详情
接口说明 查询指定 API 的某一次历史发布版本的定义详情，即某一次历史发布时发布的 API 定义。此功能面向开放 API 的用户。网关会记录下每个 API 每一次发布的时间、定义等等，您可以通过其他的接口获取版本号来指定查询某一次发布的定义...
DATASOURCE:ApiGateway:Apis
Apis Properties:ApiId:Ref:ApiId Outputs:Apis:Description:The information about ApiGateway apis.Value:Fn:GetAtt:ExtensionDataSource-Apis ApiIds:Description:The list of The ApiGateway api ids.Value:Fn:GetAtt:...
调用API
在API发布并授权之后，您可以通过简单身份认证（在请求头中添加AppCode）或加密签名身份认证（在请求头中添加AppKey和AppSecret）的方式调用API。本文为您介绍如何获取认证信息以及调用API的具体流程。前提条件 您需要首先发布API至API网关...
调用API
依次单击 市场->API服务->API文档。在 API文档 页面，查看 基本信息、业务请求参数列表、公共请求参数列表、返回参数列表 及 JSON返回示例，是否符合您的业务场景。查询到符合您业务场景的API后，单击 立即申请。在 API权限申请 页面，申请...
查看及管理运维监控API
为了保障应用能够正常调用API，同时能够保护系统，数据服务支持监控API的运行情况，包括查看异常影响分析、访问趋势分析、应用调用情况、查看API运行详情、API影响分析、配置API限流和API告警。本文为您介绍如何查看API调用情况及配置API限...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
服务商
SaaS接入类的商品在测试时发现接口地址填错了，能帮忙修改吗 云市场不能帮忙修改。商品已进入信息审核阶段，不支持修改接入信息。需要您重新再提交一个新商品。我们提交了商品还没上架，但是想修改信息，怎么办 审核中状态的商品想要修改...
交付中心能力输出简介
服务商侧通过调用API接口通知云市场完成当前流程节点。客户确认完成项目交付。流程节点示例 云市场侧交付中心流程节点示例如下。接口依赖示例如下。获取信息接口 您可以调用下列接口获取项目信息、附件信息、留言信息和日志信息。...
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
- 产品推荐
- 这些文档可能帮助您