View a markdown version of this page

使用 AWS Marketplace 发现 API - AWS Marketplace
服务终端节点API 版本数据模型身份验证发出请求响应格式使用 AWS SDK分页节流

AWS Marketplace API 参考已重组。有关支持的 API 操作的更多信息，请参阅 AWS Marketplace API 参考。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用 AWS Marketplace 发现 API

AWS Marketplace Discovery API 提供对 AWS Marketplace 目录的编程访问权限。您可以使用它来检索产品和定价信息、构建集成的采购体验以及创建自定义店面。

服务终端节点

发现 API 使用以下端点格式：

https://discovery-marketplace.region.api.aws

例如，要在美国东部（弗吉尼亚北部）调用 API，请执行以下操作：

https://discovery-marketplace.us-east-1.api.aws

API 版本

当前的 API 版本是2026-02-05。

数据模型

Discovery API 将 AWS Marketplace 目录组织成以下实体：

  • 清单 — 买家看到的产品或多产品解决方案。清单包括描述、亮点、类别、徽章、定价模式、定价单位、评论、促销媒体、卖家互动、配送选项类型以及对相关产品和优惠的引用。GetListing用于检索房源，或在房源之间SearchListings进行搜索。

  • 产品-销售的底层软件或服务。产品包括描述、亮点、类别、促销媒体、卖家互动和配送选项，这些选项描述了买家如何部署或访问产品（例如 AMI、SaaS、Container 或 Helm）。GetProduct用于检索商品详情和ListFulfillmentOptions检索商品的详细配送选项。

  • 报价 — 产品的定价安排，包括定价模式、记录在案的卖家、上市日期和徽章。优惠包含商业条款，例如基于使用量的定价、固定的预付定价、免费试用期、法律文件、付款时间表和续订条款。用于ListPurchaseOptions查找商品的所有可用报价、GetOffer检索报价的详细信息以及GetOfferTerms检索报价的具体条款。

  • 优惠套装 — 多产品解决方案中每种产品的私人报价的分组集合。报价套装允许买家一起查看所有报价，并通过一个操作同时接受报价。ListPurchaseOptions用于查找商品的所有可用优惠集、GetOfferSet检索优惠套餐的详细信息、GetOffer检索报价的详细信息以及GetOfferTerms检索优惠的具体条款。

身份验证

Discovery API 使用标准的 AWS 签名版本 4 (Sigv4) 身份验证。您必须拥有有效的 AWS 证书和相应的 IAM 权限才能调用 API。有关更多信息，请参阅 的访问控制 AWS Marketplace 发现 API。

发出请求

所有 Discovery API 操作都使用带有 JSON 请求正文的 HTTP POST 方法。操作名称在 URL 路径中指定。

响应格式

所有响应均以 JSON 格式返回。成功的响应会返回 HTTP 状态码 200。错误响应包括错误类型和消息。有关详细信息，请参阅常见错误。

使用 AWS SDK

调用 Discovery API 的推荐方法是通过 S AWS DK。SDK 会自动处理身份验证、请求签名、序列化和错误处理。

# Python (Boto3) example
import boto3

client = boto3.client('marketplace-discovery', region_name='us-east-1')

response = client.get_listing(
    listingId='listing-saas-abc123'
)

print(response['listingName'])
// JavaScript (AWS SDK v3) example
import { MarketplaceDiscoveryClient, GetListingCommand } from "@aws-sdk/client-marketplace-discovery";

const client = new MarketplaceDiscoveryClient({ region: "us-east-1" });
const response = await client.send(new GetListingCommand({
    listingId: "listing-saas-abc123"
}));

console.log(response.listingName);

分页

返回列表的操作（例如ListPurchaseOptions和SearchFacets）支持使用进行nextToken分页。如果响应中包含一个nextToken值，则在下一个请求中传递该值以检索其他结果。

节流

Discovery API 强制执行请求速率限制以确保服务的可用性。如果您超过了速率限制，API 将返回 ThrottlingException (HTTP 429)。在应用程序中实现指数退避和重试逻辑。