View a markdown version of this page

使用 AWS Marketplace 协议 API - AWS Marketplace
重要概念端点Permissions

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

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

使用 AWS Marketplace 协议 API

AWS Marketplace 是一个精心策划的数字目录，客户可以使用它来查找、购买、部署和管理第三方软件、数据和服务，以构建解决方案和运营业务。 AWS Marketplace 协议服务提供了一个 API 接口，可帮助 AWS Marketplace 买家和卖家管理他们的协议，包括上架协议、搜索协议和筛选协议。

重要概念

下表描述了 AWS Marketplace 协议 API 中使用的关键概念。

概念 说明
接受者 接受提议人在协议中延期的全部或部分条款的一方。对于大多数常见的用例，接受者是产品的购买者。
协议 一种约束双方的文件，包括投标人（通常是 seller/ISV 或渠道合作伙伴）和接受者（通常是买方），并定义了他们之间适用的条款和条件。
取消协议申请 由卖方（投标人）发起的取消有效协议的请求。买家（接受者）可以接受或拒绝取消请求。如果接受，则协议取消工作流程将异步执行，协议状态更改为已取消。如果被拒绝，协议将保持有效，卖家可以提交新的取消请求。
协议提案 实体指的是由 terms/offer 提议的集合 seller/proposer.
协议申请 实体指的是由于客户操作而创建的资源，概述了协议 creation/modification 参数、请求生命周期和接受请求后的估计结果。
可计费维度 与产品定价方式相关的要素。例如，亚马逊系统映像 (AMI) 产品的亚马逊弹性计算云 (Amazon EC2) 实例，或者软件即服务 (SaaS) 产品的高级版与只读用户对比。
渠道合作伙伴 (CP) 经产品所有者 (ISV) 授权代表其转售其产品的组织。 AWS Marketplace
独立软件供应商 (ISV) 在中发布和管理自己商品的卖家 AWS Marketplace。
意图 意图代表买方在订立协议时的动机。在协议创建流程中，目前支持的意图有 “新建”、“修改” 和 “替换”。
付款申请 由卖方（投标人）发起的与协议相关的付款请求。买方（接受者）可以接受或拒绝付款请求。
投标人 延长协议中初始条款的一方，最常见的是使用要约。
采购订单 Organizations 要求买方使用采购订单从经批准的供应商处购买，跟踪他们购买的商品，并确保支出得到预测、预算、批准并分配给负责的成本中心。
资源 卖家打算出售的商品或资源 AWS Marketplace，通常称为基础商品。在添加产品信息、部署属性和账单信息之前，基本产品不完整，供买家使用。商品描述了卖家打算出售的商品的商品信息、软件部署属性和计费机制。商品必须与报价配对，才能成为可交易的商品，可供买家出售和使用。 AWS Marketplace
租期 协议中的一个单位，用于控制协议的执行方式（例如，定价）。

端点

您可以使用以下端点访问 AWS Marketplace 协议服务：

端点 Region 支持的 IP 协议
agreement-marketplace.us-east-1.api.aws 美国东部（弗吉尼亚州北部） IPv4、IPv6

Permissions

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

错误代码

以下错误代码适用于AWS Marketplace 协议服务操作。对于多个用例，可能会返回一个错误代码。请参阅以下说明，确定每种错误代码发生的具体情况。此列表并不详尽，可能会随着新功能的发布而更新。

ValidationException

错误代码 说明
INVALID_SOURCE_AGREEMENT_IDENTIFIER 当来源协议标识符与预期格式不匹配时，或者为不需要来源协议标识符的 Intent（例如 NEW）提供了来源协议标识符时返回。
MISSING_SOURCE_AGREEMENT_IDENTIFIER 如果未为需要来源协议标识符的意图（例如 REPLACE 或 AMEND）提供来源协议标识符，则返回。
INVALID_REQUESTED_TERM_CONFIGURATION

当请求的术语配置无效时返回。可能的场景：

  • 为不接受术语的术语提供了配置。

  • 缺少必需的配置。

  • 选择器值不属于协议提案。

  • 当不允许选择多个维度时，这些尺寸只能包含一个尺寸。

  • 协议提案或已接受的条款中不承认维度密钥。

  • 如果未启用尺寸的数量配置，则该尺寸值只能为 1。

  • 该配置包含重复的维度密钥。

  • 该配置与来源协议没有区别。
INVALID_AGREEMENT_PROPOSAL_IDENTIFIER 当协议提案标识符与预期格式不匹配时，或者为不需要协议提案标识符的意图（例如 AMEND）提供了协议提案标识符时，将返回。
MISSING_AGREEMENT_PROPOSAL_IDENTIFIER 如果未为需要协议提案标识符的意图（例如 NEW 或 REPLACE）提供协议提案标识符，则返回。
INVALID_FILTER_NAME 如果提供的过滤器名称不是可识别的过滤器，或者请求中包含重复的过滤器名称，则返回。
INVALID_FILTER_VALUES 当筛选值无效、重复、为空、超过允许的最大计数或日期范围筛选器指定的值位于该BeforeEndTime值之前的值时返回。AfterEndTime
INVALID_NEXT_TOKEN 当分页令牌格式错误、已过期、无法解密或请求参数在分页调用之间发生更改时返回。
DUPLICATE_CHARGES 如果请求包含重复的费用标识符，或者为相同的费用标识符提供了不同的采购订单值，则返回。
UNSUPPORTED_FILTERS 当不支持提供的过滤器组合时返回。支持的过滤器组合因派对类型而异。在公共文档中查看支持的组合。
INVALID_PURCHASE_ORDER_REFERENCE 如果采购订单参考不符合格式要求，或者账户管理员没有按照配置提供所需的采购订单，则返回。
INVALID_CHARGE_AMOUNT

当费用金额无效时返回。可能的场景：

  • 费用金额超过该期限的最大总费用金额。

  • 费用金额格式与币种要求不符（例如，小数位太多）。

  • 由于协议已达到最大总费用金额，因此没有剩余金额可用。
UNSUPPORTED_ACTION

当资源的当前状态不支持请求的操作时返回。具体场景因 API 而异：

  • UpdatePurchaseOrders— 收费日期已过去，auto renewal 已禁用，收费日期在 3 小时内，费用为退款费用，费用修订不是最新的，采购订单不属于同一个协议，或者协议未激活。

  • CreateAgreementRequest— 不支持修改远期协议，资源类型和期限类型组合不支持请求的意图，不允许用未来日期的协议替换有效协议，修改期间不能更改协议期限，此时无法更新协议（例如，存在待定权利），协议提案必须引用与来源协议相同的资源，协议提案必须与来源协议引用相同的资源，协议提案必须与来源协议不同，或者协议类型不是支持这个动作。

  • AcceptAgreementRequest— 资源类型和条款类型组合不支持此操作，协议类型不支持此操作，同一资源上已存在有效协议，或者此时无法更新协议。

  • CancelAgreement— 协议有待处理的权利，协议类型不支持取消，与的协议在与同一资源的协议ConfigurableUpfrontPricingTerm或在同一资源上仍PaymentScheduleTerm处于有效状态时UsageBasedPricingTerm无法取消，或者资源类型和期限类型组合不支持取消。

  • GetBillingAdjustmentRequest— 协议是非购买协议类型，或者调用方是协议的接受者。

  • SendAgreementCancellationRequest— 协议类型不支持此操作。

  • AcceptAgreementCancellationRequest— 协议类型不支持此操作。

  • RejectAgreementCancellationRequest— 协议类型不支持此操作。

  • CancelAgreementCancellationRequest— 协议类型不支持此操作。

  • GetAgreementCancellationRequest— 该协议是一种非购买协议类型。

ResourceNotFoundException

标识无法找到的资源的ResourceNotFoundException包含resourceType和resourceId字段。下表描述了可能导致每种资源类型出现此异常的情况。

注意

出于安全考虑，无论资源不存在还是调用者无权访问该资源，都会返回相同的错误。这可以防止枚举有效的资源标识符。

资源类型 可能的场景
AgreementProposal

  • 未找到针对给定标识符的协议提案。

  • 该报价不是针对接受者的。

  • 该报价在接受者所在的国家/地区不可用。
Agreement

  • 找不到与给定标识符相关的协议。

  • 来电者既不是协议的接受者，也不是协议的提议者。
AgreementRequest

  • 未找到针对给定标识符的协议请求。

  • 协议请求属于另一个来电者。

  • 协议请求已过期。

  • 该协议请求已被随后接受的关于同一产品或报价的请求所取代。

  • 由于报价重新发布或报价到期CreateAgreementRequest，协议提案在两次AcceptAgreementRequest通话之间失效。
Charge

  • 找不到针对给定标识符的费用。

  • 该费用不属于特定协议。
BillingAdjustmentRequest

  • 未找到针对给定标识符的账单调整请求。

  • 调用方既不是与调整相关的协议的接受者，也不是提议人。
AgreementCancellationRequest

  • 未找到针对给定标识符的协议取消请求。

  • 来电者既不是与取消请求相关的协议的接受者，也不是提议者。
PaymentRequest

  • 未找到针对给定标识符的付款请求。

  • 来电者既不是与付款申请相关的协议的接受者，也不是提议者。