View a markdown version of this page

使用私人报价处理私人报价AWS MarketplaceAPI - AWS Marketplace

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

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

使用私人报价处理私人报价AWS MarketplaceAPI

您可以使用自动执行AWS Marketplace Catalog API处理选件的任务。

虽然产品描述了销售的内容AWS Marketplace,但报价描述了如何购买和消费产品的条款和规则。 AWS Marketplace商品可以有多个由不同卖家出售的报价。但是,每个AWS Marketplace报价只能针对一种商品创建。要包含双方之间的一系列协议条款。已接受的报价条款将转换为协议作为交易证据。

有两种类型的优惠:

  • 私人报价供卖家和买家协商定价。卖家为购买软件签署最终用户许可协议 (EULA)。AWS Marketplace报价仅对指定的买家可见。有关更多信息,请参阅《AWS Marketplace卖家指南》中的私人报价

  • 公开报价适用于全球采购计划。卖家根据可用的计划和地理位置识别客户,这使得只有特定买家才能获得报价。

请参阅以下资源:

以下主题介绍如何使用目录 API 创建和更新选件:

创建报价

您可以使用目录 API 在中创建新报价AWS Marketplace。如果您的请求成功处理,则会AWS Marketplace Catalog API创建一个Draft,这是一份不完整的报价,买家看不见。要完成报价,请使用Update更改类型。报价完成后,使用ReleaseOffer变更类型创建和发布报价。发布报价可验证其有效性,并使其对中的AWS Marketplace买家可见。

要创建新报价,请使用CreateOffer更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateOffer", "Entity": { "Type": "Offer@1.0" }, "DetailsDocument": { "ProductId": "prod-ad8EXAMPLE51", "Name": "Test Offer", "OfferSetId": "offerset-b3f9EXAMPLE27" } } ] }

为要添加CreateOffer更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • ProductId(字符串)(必填)-所提供产品的唯一标识符。

    • 名称(字符串)(可选)— 与报价关联的名称,便于您和您的客户阅读。它也作为协议信息的一部分显示。

    • OfferSetId(字符串)(可选)-设置为与此优惠关联的优惠的 ID。仅在创建将成为优惠套餐一部分的报价时才指定此字段。如果 OfferSetId 未提供,则将创建可单独购买的个人报价。请注意,在创建报价 OfferSetId 期间指定仅表示您打算将该优惠与该优惠集相关联。要完成关联,您必须在创建优惠后使用 AssociateOffers 更改类型

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

如果StatusSUCCEEDED,则生成一个新OfferId的。

响应看起来与以下内容类似。

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef", "ChangeSetName": "Submitted by 123456789012", "StartTime": "2021-05-27T22:21:26Z", "EndTime": "2021-05-27T22:32:19Z", "Status": "SUCCEEDED", "ChangeSet": [ { "ChangeType": "CreateOffer", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "ProductId": "prod-ad8EXAMPLE51", "Name": "Test Offer" }, "ErrorDetailList": [] } ] }

同步验证

以下架构验证特定于中的CreateOfferAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
ProductId

必填

长度必须介于 1 到 50 个字符之间

不得包含非法字符 (\、<、>)

422
ProductId

必填

必须授权用户为给定产品创建报价
403
ProductId

必填

必须是目录中的现有商品或者是在同一个更改集中创建的
404
Name

可选

长度必须介于 1 到 150 个字符之间

不得包含非法字符 (\、<、>)

422

异步错误

以下错误特定于中的CreateOffer操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容的产品 使用处于LimitedPublic状态的有效产品。
不兼容的产品 目前不支持管理所选产品类型的报价AWS Marketplace Catalog API。
不兼容的产品 目前不支持管理该产品的报价AWS Marketplace Catalog API。
不兼容的产品 OfferSetId 不支持该产品的报价。
不兼容的产品 CreateOffer 无法调用更改类型为产品创建报价。使用 CreateOfferUsingResaleAuthorization 更改类型。

创建替换报价

您可以使用目录 API 在中创建替代报价(也称为基于协议的报价)。AWS Marketplace

如果您的请求已成功处理,则系统AWS Marketplace Catalog API将为您生成一份Draft状态为 “报价”,该报价不完整,买家无法看见AWS Marketplace。您将使用Update变更类型来完成报价。报价完成后,您将使用ReleaseOffer更改类型来完成报价创建流程并发布报价,这将验证整个报价,并向买家显示您的报价AWS Marketplace。从那以后,买方可以选择接受替代报价或继续根据原始协议经营。

要创建替代报价,请使用CreateReplacementOffer变更类型调用 StartChangeSet API 操作并提供预先存在的协议 ID,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateReplacementOffer", "Entity": { "Type": "Offer@1.0" }, "DetailsDocument": { "AgreementId": "agmt-12345", "Name": "Offer name" } } ] }

为要添加CreateReplacementOffer更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • AgreementId(字符串)(必填)-要替换的当前协议的唯一标识符。

    • 名称(字符串)(可选)— 与报价关联的名称,便于您和您的客户阅读。它也将作为协议信息的一部分显示。

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的CreateReplacementOfferAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
AgreementId 必填

长度必须介于 1 到 64 个字符之间

422
AgreementId

必填

必须授权用户为给定协议创建报价
403
Name 可选

长度必须介于 1 到 150 个字符之间

不得包含无效字符 (\、<、>)

422

异步错误

以下错误特定于中的CreateReplacementOffer操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容的产品 该产品不支持换货优惠。
不兼容协议 CreateReplacementOffer 不能调用变更类型为协议创建替代报价。使用 CreateReplacementOfferUsingResaleAuthorization 更改类型。

更新优惠信息

您可以使用目录 API 更新中的商品信息AWS Marketplace。

要更新优惠信息,请使用UpdateInformation更改类型调用 StartChangeSet API 操作,如以下示例所示。所有其他信息将保持不变。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateInformation", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "Name": "New offer name", "Description": "New offer description", "PreExistingAgreement": { "AcquisitionChannel": "External", "PricingModel": "Contract" } } } ] }

为要添加UpdateInformation更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • 名称(字符串)(可选)-与选件关联的名称,以提高可读性。它作为协议信息的一部分显示。

    • 描述(字符串)(可选)— 一种自由格式的文本,仅供您使用,买家永远看不见。

    • PreExistingAgreement(object)(可选)— 确定此优惠是否为与现有客户签订的相同基础产品的现有协议的续订。现有协议可以是内部协议,也可以是外部协议AWS Marketplace。 AWS可能会审核并确认您的报价是否为续订。AWS如果无法验证您的报价,则AWS可以撤销客户的报价和权利。

      • AcquisitionChannel(字符串)(必填)-表示现有协议是在外部AWS Marketplace还是内部签署AWS Marketplace。

        可能的值:ExternalAwsMarketplace

      • PricingModel(字符串)(必填)— 表示现有协议使用哪种定价模式。

        可能的值:ContractUsageByolFree

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateInformationAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
Properties 必须至少提供以下属性之一 422
Name

可选

长度必须介于 1 到 150 个字符之间

不得包含非法字符 (\、<、>)

422
说明

可选

长度必须介于 1 到 255 个字符之间

422
PreExistingAgreement 可选

PreExistingAgreement从报价中移除时可以为空

422
PreExistingAgreement.PricingModel

必填

可以是以下值之一:[ByolFreeUsageContract]

422
PreExistingAgreement.AcquisitionChannel

必填

可以是以下值之一:[AwsMarketplaceExternal]

422

异步错误

以下错误特定于中的UpdateInformation操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容预先存在的协议 PreExistingAgreement 优惠发布后无法更改。

更新定位配置

您可以使用目录 API 在中更新您的商品的定位配置AWS Marketplace。

所有未包含在最新请求中且将从报价中移除的现有定位选项。

注意

报价可以选择包含PositiveTargetingNegativeTargeting,但不能两者兼而有之。

正面定位选项:

  • 仅限国家/地区代码-创建面向指定国家/地区的买家的公开报价。

  • 仅限买家账户 — 创建针对特定 AWS 账户的私有报价。

  • 国家/地区代码和买家账户 — 创建私密报价,目标账户只有位于指定国家/地区之一时才能接受报价。

负面定位选项:

  • 国家/地区代码-不包括来自指定国家/地区的买家。这就为除所列国家以外的所有国家/地区提供了公开报价。

要更新您的商品的定位配置,请使用UpdateTargeting更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateTargeting", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "PositiveTargeting": { "CountryCodes": [ "US", "CA" ], "BuyerAccounts": [ "111122223333" ] }, "NegativeTargeting": { "CountryCodes": [ "XX" ] } } } ] }

为要添加UpdateTargeting更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • PositiveTargeting(object)(可选)— 正面定位定义了任何买家的个人资料都应满足的标准,才允许他们访问报价。此字段为可选字段,但如果存在此字段,则应至少提供一个定位选项。

      • CountryCodes(字符串数组)(可选)-列出为允许基于国家/地区进行定位的选项。如果目的不是将报价定位到某个国家/地区,则应省略此字段。如果存在,则该列表必须至少包含一个国家/地区代码。此列表中的每个元素都应为有效的 2 个字母的国家/地区代码,格式为:ISO 3166-1 alpha-2。

      • BuyerAccounts(字符串数组)(可选)— 列出为一个选项,允许基于该选项进行定位AWS 账户(也称为私人报价)。如果意图不是将报价定位到AWS 账户,则应省略此字段。

    • NegativeTargeting(object)(可选)— 负面定位定义了任何客户的个人资料都应满足的标准,以限制其访问优惠。尽管此字段是可选字段,但如果存在此字段,则应至少提供一个定位选项。

      • CountryCodes(字符串数组)(必填)-列出为允许基于国家/地区进行定位的选项。如果目的不是将报价定位到特定的国家/地区,则应省略此字段。如果存在,则该列表必须至少包含一个国家/地区代码。此列表中的每个元素都应为有效的 2 个字母的国家/地区代码,格式如下:ISO 3166-1 alpha-2。

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateTargetingAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
NegativeTargeting

可选

可以有以下任一项:[CountryCodes]

422
NegativeTargeting.CountryCodes

可选

列表大小必须介于 1 和 244 之间

国家/地区代码必须有效(ISO 3166-1 alpha-2)

422
PositiveTargeting

可选

可以有以下任一项:[CountryCodesBuyerAccounts]

422
PositiveTargeting.BuyerAccounts

可选

列表大小必须介于 1 和 26 之间

AWS 账户身份证必须采用有效格式(12 位数字)

422
PositiveTargeting.CountryCodes

可选

列表大小必须介于 1 和 244 之间

国家/地区代码必须有效(ISO 3166-1 alpha-2)

422

异步错误

以下错误特定于中的UpdateTargeting操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
买家账户无效 提供有效的买家账户。无效的帐户:[x]。
无效的国家/地区代码 提供支持的国家/地区代码。
无效定位 对同一属性使用负面或正面定位。
不兼容的产品 Country-based 该产品不支持定位。
不兼容_转售_授权 提供 BuyerAccounts 与. 兼容的产品 ResaleAuthorization。
不兼容的定位 报价发布后,无法执行所请求的更改。
不兼容的定位 报价到期后,无法执行所请求的更改。
不兼容的定位 无法更新替换报价的定位。如果买家与提供的商品无关 AgreementId,则通过提供与买家 AgreementId关联的报价来创建新的私募报价。
买家账户太多了 在允许的限制 BuyerAccounts 范围内提供。
不兼容的定位 BuyerAccounts 优惠发布后无法删除。
不兼容的定位 BuyerAccounts 优惠发布后无法添加。
缺少国家/地区代码 提供 PositiveTargeting CountryCodes:[x]。
不兼容的国家/地区代码 提供兼容 CountryCodes 的。
不兼容的买家账户 提供与协议 BuyerAccounts 相符的条款。

更新退款政策

您可以使用目录 API 来更新您的商品的退款政策AWS Marketplace。

此更改不影响现有协议。最新请求中未包含的支持条款将从报价中删除。

要更新退款政策,请使用UpdateSupportTerms更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateSupportTerms", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "SupportTerm", "RefundPolicy": "Updated refund policy description" } ] } } ] }

为要添加UpdateSupportTerms更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • 条款(结构数组)(必填)-您要更新的支持条款列表。可接受的支持条款是:

      • SupportTerm(object)(必填)— 定义接受者在购买软件时可获得的客户支持。

        • 类型(字符串)(必填)-要更新的术语的类型。这是对象的值:"SupportTerm"

        • RefundPolicy(字符串)(必填)— 有关退款政策描述的字段,该 Free-text 字段将按原样在网站和控制台上向客户显示。

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateSupportTermsAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
术语

必填

422
条款 []。 RefundPolicy

必填

长度必须介于 1 和 500 之间

不能以空格开头或结尾

422
条款 [] .Type 必填

只能是 SupportTerm

422

异步错误

以下错误特定于中的UpdateSupportTerms操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容的产品 SupportTerm 不支持该产品的私密报价。
不兼容条款 SupportTerm 不支持免费试用优惠。
不兼容条款 报价发布后,无法执行所请求的更改。
不兼容条款 报价到期后,无法执行所请求的更改。

您可以使用目录 API 来替换现有的法律文件,例如最终用户许可协议 (EULA)。最新申请中未包含的法律条款将从报价中删除。

要更新报价的合法资源,请使用UpdateLegalTerms变更类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateLegalTerms", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "LegalTerm", "Documents": [ { "Type": "CustomEula", "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt" } ] } ] } } ] }

为要添加UpdateLegalTerms更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • LegalTerm(object)(必填)— 定义要向接受者提出的文本协议清单。此类协议的一个例子是最终用户许可协议 (EULA)。

      • 类型(字符串)(必填)-要更新的术语的类型。这是对象的值:"LegalTerm"

      • 文件(结构阵列)(必填)— 向买方提出的法律资源参考清单。此类资源的一个例子是最终用户许可协议 (EULA)。每个引用都由 a Type 和 a 组成URL

        • 类型(字符串)(必填)-文档类型。可用的文件类型有:

          • CustomEula— 您作为卖家提供的自定义 EULA。此文档类型需要公共 S3 网址或预签名 URL

          • StandardEula— 标准合约AWS Marketplace(南华早报)。有关 SCMP 的更多信息,请参阅《AWS Marketplace卖家指南》。您没有为此类型提供 URL,因为它是由管理的AWS Marketplace。

        • 网址(字符串)(有条件必填)— 供买家阅读的法律文件的 URL。当Type是以下 [CustomEula] 之一时为必填项。

        • 版本(字符串)(有条件要求)-提供的AWS Marketplace标准合约版本。当Type为 [StandardEula] 时为必填项。可用版本:

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateLegalTermsAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
术语

必填

LegalTerm仅允许出现在列表中

列表大小必须为 1

422
条款 [] .Type 必填

只能是 LegalTerm

422
条款 []。 LegalTerm.Documents

必填

422
条款 []。 LegalTerm.Documents[] .Type

必填

允许的值:

  • CustomEula

  • StandardEula

422
条款 []。 LegalTerm.Documents[] .Url 必填且必须Type是有效的 URL CustomEula 422
条款 []。 LegalTerm.Documents[] .Version 必填且必须是有效版本时必须Type是有效版本 StandardEula

有效StandardEula版本:[“2019-04-24”、“2022-07-14”]

422

异步错误

以下错误特定于中的UpdateLegalTerms操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容条款 报价发布后,无法执行所请求的更改。
不兼容条款 报价到期后,无法执行所请求的更改。
无效的法律文件 为存储在可访问的 S3 存储桶中的法律文档提供网址。
无效的法律文件 新优惠 StandardEula 仅支持最新版本的。
无效的法律文件 以支持的文件格式提供法律文件。
无效的法律文件 使用支持的文档类型提供法律文件。
LIMIT_EXCEDED_LEGAL_DOCUMENT_SIZE 在允许的大小范围内提供法律文件。
无效的法律文件 LegalTerm 包含受密码保护的文档。在中提供无障碍文档 LegalTerm。
无效的法律文件 LegalTerm 包含无效的 PDF 文档。在中提供无障碍文档 LegalTerm。

更新定价

您可以使用目录 API 来完全替换现有的定价条款。最新请求中未包含的定价条款将从报价中删除。

要更新报价条款,请使用UpdatePricingTerms更改类型调用 StartChangeSet API 操作,如以下示例所示。

注意

以下请求语法结合了多个示例。这种组合不能用作有效的有效载荷。例如,Terms数组不能同时包含术语类型FixedUpfrontPricingTerm和术语类型ConfigurableUpfrontPricingTerm。有关如何针对不同定价用例组合不同术语类型的示例,请参阅AWS Marketplace卖家研讨会中的使用 API 管理报价

注意

对于采用免费定价模式的 SaaS 产品,您必须包含其中一个UsageBasedPricingTermConfigurableUpfrontPricingTerm至少一个 RateCard (维度),其中所有价格均设置为 0.00 美元。此要求是 SaaS 产品所独有的。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdatePricingTerms", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "PricingModel": "Usage", "Terms": [ { "Type": "UsageBasedPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "RateCard": [ { "DimensionKey": "m3.large", "Price": "0.10" }, { "DimensionKey": "m4.xlarge", "Price": "0.20" } ] } ] }, { "Type": "ConfigurableUpfrontPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "Selector": { "Type": "Duration", "Value": "P365D" }, "RateCard": [ { "DimensionKey": "m3.large", "Price": "300" }, { "DimensionKey": "m4.xlarge", "Price": "400" } ], "Constraints": { "MultipleDimensionSelection": "Allowed", "QuantityConfiguration": "Allowed" } } ] }, { "Type": "ByolPricingTerm" }, { "Type": "RecurringPaymentTerm", "CurrencyCode": "USD", "BillingPeriod": "Monthly", "Price": "100.0" }, { "Type": "FixedUpfrontPricingTerm", "CurrencyCode": "USD", "Price": "200.00", "Grants": [ { "DimensionKey": "Users", "MaxQuantity": 10 } ] }, { "Type": "FreeTrialPricingTerm", "Duration": "P30D", "Grants": [ { "DimensionKey": "m3.xlarge", "MaxQuantity": 10 }, { "DimensionKey": "m4.xlarge", "MaxQuantity": 10 } ] } ] } } ] }

为要添加UpdatePricingTerms更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • PricingModel(字符串)(必填)-报价的定价模型。定价模型的可能值为:

      • 用法 — Usage-based 定价模式,将向买家收取使用您产品的费用。

      • 合同 — Contract-based 定价模式,在这种模式下,买家要么提前收取使用您的产品的费用,要么为他们提供灵活的付款时间表。买家还可以为合同之外的额外使用付费。

      • 免费 — 免费定价模式,不向买家收取产品使用费。使用此定价模型时,任何定价条款或付款计划期限都不能具有非零费率。

      • Byol — Byol 定价模式,在这种模式下,买家将自带产品使用许可证。

    • 条款(结构数组)(必填)-要更新的定价术语列表。支持的定价条款有:

      • FreeTrialPricingTerm(object)— 定义一种短期免费定价模式,在这种模式下,买家无需在指定限额内支付任何费用。

        • 类型(字符串)-要更新的术语的类型。这是对象的值:"FreeTrialPricingTerm"

        • 持续时间(字符串)-免费试用期的持续时间。

        • 赠款(结构数组)— 作为协议执行的一部分,将授予免费试用版接受者的权利。

          • DimensionKey(字符串)-产品文档中定义的唯一维度键。尺寸代表产品的容量类别,在列出产品时指定AWS Marketplace。

          • MaxQuantity(整数)(可选)-买方有权获得产品给定尺寸的最大容量。如果MaxQuantity未提供,则买家将能够无限量使用给定维度。

      • UsageBasedPricingTerm(object)— 定义一种即用即付 (PAYG) 定价模型,其中根据产品使用情况向客户收费。

        • 类型(字符串)(必填)-正在更新的术语的类别。这是对象的值:UsageBasedPricingTerm

        • CurrencyCode(字符串)— 定义本术语中提及的价格的货币。目前,仅支持美元。

        • RateCards(结构数组)-价目表列表。

          • RateCard(结构数组)— 价目表定义产品维度的单位费率。

            • DimensionKey(字符串)-给定权利适用的维度。尺寸代表产品的容量类别,在列出产品时指定AWS Marketplace。

            • 价格(字符串)— 产品维度的 Per-unit 价格,用于计算向买家收取的金额。

      • ConfigurableUpfrontPricingTerm(object)— 定义预付费支付模式,允许买家配置他们想要购买的权利和权利的期限。您可以更新每个合同期限的费率列表以及每个维度的权利列表。

        • 类型(字符串)(必填)-要更新的术语的类型。这是对象的值:ConfigurableUpfrontPricingTerm

        • CurrencyCode(字符串)(必填)— 定义本术语中提及的价格的货币。对于公开报价,仅支持美元。对于私募出价,支持美元、澳元、欧元、英镑和日元。

        • RateCards(结构数组)(必填)-价目表列表。

          • 选择器(对象)(必填)— 选择器用于区分相同定价条件下的互斥价目表,供买方选择。

            • 类型(字符串)(必填)-选择器的类别。目前,Duration仅支持。

            • (字符串)(必填)-合同期限。此字段支持 ISO 8601 格式。

          • RateCard(结构数组)(必填)— 价目表定义产品维度的单位费率。

            • DimensionKey(字符串)(必填)-产品文档中定义的唯一维度密钥。尺寸代表产品的容量类别,在列出产品时指定AWS Marketplace。

            • 价格(字符串)(必填)— 商品维度的 Per-unit 价格,用于计算向买家收取的金额。

          • 约束(对象)(必填)-定义接受者如何配置术语的限制。

            注意

            目前,MultipleDimensionSelection和的QuantityConfiguration值必须相同。

            • MultipleDimensionSelection(字符串)(必填)-确定是否允许买家在价目表中选择多个维度。可能的值为 AllowedDisallowed

            • QuantityConfiguration(字符串)(必填)-确定是否允许接受者在价目表中为每个维度配置数量。可能的值为 AllowedDisallowed

      • ByolPricingTerm(object)— 使您和您的客户能够将现有协议移至AWS Marketplace。不会向客户收取产品使用费,AWS Marketplace因为他们已经在以外的地方支付了产品使用费AWS Marketplace。

        • 类型(字符串)(必填)-要更新的术语的类型。这是对象的值:ByolPricingTerm

      • RecurringPaymentTerm(object)— 定义一种定价模型,即在每个账单周期结束时向客户收取固定的经常性价格。

        • 类型(字符串)(必填)-要更新的术语的类型。这是对象的值:RecurringPaymentTerm

        • BillingPeriod(字符串)(必填)-定义向买家收取费用的重复次数。Monthly目前仅支持。

        • 价格(字符串)(必填)-每个账单周期向买家收取的金额。

        • CurrencyCode(字符串)(必填)— 定义本术语中提及的价格的货币。目前仅支持 USD

      • FixedUpfrontPricingTerm(object)— 定义一种预付费定价模型,在该模型中,向客户收取固定的预付金额。

        • 类型(字符串)(必填)-要更新的术语的类型。这是对象的值:FixedUpfrontPricingTerm

        • CurrencyCode(字符串)(必填)— 定义本术语中提及的价格的货币。对于公开报价,仅支持美元。对于私募出价,支持美元、澳元、欧元、英镑和日元。

        • 价格(字符串)(必填)-接受此条款时向客户收取的固定金额。

        • 补助金(结构数组)(必填)— 作为协议执行的一部分,将向固定预付的接受者授予的权利。

          • DimensionKey(字符串)(必填)-产品文档中定义的唯一维度密钥。尺寸代表产品的容量类别,在列出产品时指定AWS Marketplace。

          • MaxQuantity(整数)(必填)-买方有权获得产品给定尺寸的最大容量。如果MaxQuantity未提供,则买家将能够无限量使用给定维度。

        • 持续时间(字符串)(可选)-定义术语保持活动状态的持续时间。此字段支持 ISO 8601 格式。

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

更改请求将添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdatePricingTermsAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP
PricingModel 必填

允许的定价模式:[“Byol”、“免费”、“使用”、“合同”]

422
术语 必填

允许的条款:[” ConfigurableUpfrontPricingTerm “、” ByolPricingTerm “、” FreeTrialPricingTerm “”、UsageBasedPricingTerm “”、RecurringPaymentTerm “”、“” FixedUpfrontPricingTerm “]

422
条款 []。 ByolPricingTerm 必填 422
条款 []。 ByolPricingTerm.Type 必填

只能是 “ByolPricingTerm”

422
条款 []。 ConfigurableUpfrontPricingTerm 必填 422
条款 []。 ConfigurableUpfrontPricingTerm.Type 必填

只能是 “ConfigurableUpfrontPricingTerm”

422
条款 []。 ConfigurableUpfrontPricingTerm.CurrencyCode 必填

支持的货币:[“美元”、“澳元”、“欧元”、“英镑”、“日元”]

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards 必填

列表大小必须介于 1 和 5 之间

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]. 约束 必填 422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 Contraints.MultipleDimensionSelection 必填

允许的值:[“允许”、“不允许”]

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 Contraints.QuantityConfiguration 必填

允许的值:[“允许”、“不允许”]

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 RateCard 必填

列表大小必须介于 1 和 800 之间

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 RateCard[]。 DimensionKey 必填

长度必须介于 1 和 100 之间

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 RateCard[] .Price 必填

数据类型为 “字符串”

Non-negative支持最多 3 位小数的小数

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[] .Selector 必填 422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 Selector.Type 必填

允许的值:["持续时间"]

422
条款 []。 ConfigurableUpfrontPricingTerm.RateCards[]。 Selector.Value 必填

每种选择器类型的预期格式:ISO 8601 持续时间

422
条款 []。 FixedUpfrontPricingTerm 必填 422
条款 []。 FixedUpfrontPricingTerm.Type 必填

只能是 “FixedUpfrontPricingTerm”

422
条款 []。 FixedUpfrontPricingTerm.CurrencyCode 必填

支持的货币:[“美元”、“澳元”、“欧元”、“英镑”、“日元”]

422
条款 []。 FixedUpfrontPricingTerm.Duration 必填

每种选择器类型的预期格式:ISO 8601 持续时间

422
条款 []。 FixedUpfrontPricingTerm.Grants 必填

列表大小必须介于 1 和 200 之间

422
条款 []。 FixedUpfrontPricingTerm.Grants[]。 DimensionKey 必填

长度必须介于 1 和 100 之间

422
条款 []。 FixedUpfrontPricingTerm.Grants[]。 MaxQuantity RequiredValue 必须大于 0 422
条款 []。 FixedUpfrontPricingTerm.Price 必填

数据类型为 “字符串”

Non-negative支持最多 3 位小数的小数

422
条款 []。 FreeTrialPricingTerm 必填 422
条款 []。 FreeTrialPricingTerm.Type 必填

只能是 “FreeTrialPricingTerm”

422
条款 []。 FreeTrialPricingTerm.Duration 必填

预期格式:ISO 8601 持续时间

422
条款 []。 FreeTrialPricingTerm.Grants 必填

列表大小必须介于 1 和 800 之间

422
条款 []。 FreeTrialPricingTerm.Grants[]。 DimensionKey 必填

长度必须介于 1 和 100 之间

422
条款 []。 FreeTrialPricingTerm.Grants[]。 MaxQuantity 可选

值必须大于 0

422
条款 []。 RecurringPaymentTerm 必填 422
条款 []。 RecurringPaymentTerm.Type 必填

只能是 “RecurringPaymentTerm”

422
条款 []。 RecurringPaymentTerm.BillingPeriod 必填

允许的值:["每月"]

422
条款 []。 RecurringPaymentTerm.CurrencyCode 必填

支持的货币:[“美元”]

422
条款 []。 RecurringPaymentTerm.Price 必填

数据类型为 “字符串”

Non-negative支持最多 3 位小数的小数

422
条款 []。 UsageBasedPricingTerm 必填 422
条款 []。 UsageBasedPricingTerm.Type 必填

只能是 “UsagedBasedPricingTerm”

422
条款 []。 UsageBasedPricingTerm.CurrencyCode 必填

支持的货币:[“美元”]

422
条款 []。 UsageBasedPricingTerm.RateCards 必填

大小必须为 1

422
条款 []。 UsageBasedPricingTerm.RateCards[]。 RateCard 必填

列表大小必须介于 1 和 800 之间

422
条款 []。 UsageBasedPricingTerm.RateCards[]。 RateCard[]。 DimensionKey 必填

长度必须介于 1 和 100 之间

422
条款 []。 UsageBasedPricingTerm.RateCards[]。 RateCard[] .Price 必填

数据类型为 “字符串”

Non-negative支持最多 8 位小数的小数

422

异步错误

以下错误特定于中的UpdatePricingTerms操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
重复的维度键 在 [x] 中为 Grants 提供唯一的维度键列表。
重复的维度键 在 [x] 中提供 RateCard 唯一的维度键列表。
重复选择器 在中提供唯一的选择器列表。 ConfigurableUpfrontPricingTerm
重复术语类型 提供唯一的术语类型列表。
不兼容协议 无法从替换商品中删除以下条款:[x, y, z]。
不兼容协议 以下条款不能添加到替换商品中:[x, y, z]。
不兼容的货币代码 CurrencyCode 优惠发布后无法更改。
不兼容的付款设置 更新您的付款设置以使其与兼容 CurrencyCode。
不兼容的产品 该产品不支持使用量定价模式。
不兼容的产品 该产品不支持合同定价模式。
不兼容的产品 该产品不支持 Byol 定价模式。
不兼容的产品 该产品不支持免费定价模式。
不兼容的产品 该产品的报价不支持 [x]。
不兼容的产品 提供的付款和定价条款不兼容。
不兼容的产品 在 [x] 中使用产品中现有的可用尺寸。
不兼容的产品 FreeTrialPricingTerm 因为该产品不支持该报价的唯一定价条款。
不兼容的产品 该产品不支持以下术语:[x, y, z]。
不兼容的产品 仅合同定价模式支持替换报价。
不兼容的产品 提供与产品尺寸兼容的定价条款。不兼容的定价条款:[x, y, z]。
不兼容的费率卡片约束 在使用量定价模式中, QuantityConfiguration 将 MultipleDimensionSelection 和设置 ConfigurableUpfrontPricingTerm 为 “允许”。
不兼容的费率卡片约束 在使用量定价模式中 QuantityConfiguration ,将 MultipleDimensionSelection 和设置 ConfigurableUpfrontPricingTerm 为 “不允许”。
不兼容的费率卡片约束 QuantityConfiguration 优惠发布后 ConfigurableUpfrontPricingTerm 无法更改 in。
不兼容的费率卡片约束 MultipleDimensionSelection 优惠发布后 ConfigurableUpfrontPricingTerm 无法更改 in。
不兼容率 使用免费定价模式时,将所有费用金额和价格设置为零 (0)。
不兼容率 该产品的免费试用优惠只允许使用零 (0) 个价格。 UsageBasedPricingTerm
不兼容_转售_授权 请提供中指定的相同 CurrencyCode 内容 ResaleAuthorization。
不兼容_转售_授权 确保比赛持续时间在中指定的 FixedUpfrontPricingTerm 比赛持续时间中指定 ResaleAuthorization。
不兼容_转售_授权 提供与. 兼容的术语 ResaleAuthorization。不兼容的术语:[x, y, z]。
不兼容的选择器持续时间 优惠发布 ConfigurableUpfrontPricingTerm 后,不允许从价目表中删除时长。
不兼容_卖家_验证 完成所有必需的卖家验证流程。
不兼容条款 不支持 [x] 和以下术语:[y, z]。
不兼容条款 优惠发布后无法添加以下条款:[x, y, z]。
不兼容条款 优惠发布后无法删除以下条款:[x, y, z]。
不兼容条款 私密优惠不支持 [x]。
不兼容条款 不支持以下允许无限使用的术语:[x, y, z]。 FreeTrialPricingTerm
不兼容条款 该产品不支持以下术语:[x, y, z]。 FreeTrialPricingTerm
不兼容条款 FixedUpfrontPricingTerm如果报价包含,则提供零 (0) 价格 PaymentScheduleTerm。
不兼容条款 以下术语与 PricingModel:[x, y, z] 不兼容。
不兼容条款 FixedUpfrontPricingTerm 大于零 (0) 时 MarkupPercentage 不支持。
不兼容条款 报价发布后,无法执行所请求的更改。
不兼容条款 报价到期后,无法执行所请求的更改。
无效协议持续时间 提供介于 [x] 和 [y] 个月之间的持续时间。
无效协议持续时间 确保计量维度的持续时间粒度为日级别。
无效的货币代码 提供支持的 CurrencyCode。
无效的货币代码 CurrencyCode 所有定价和付款条件均相同。
无效的货币代码 提供支持的 CurrencyCode。
无效的货币代码 CurrencyCode 所有定价和付款条件均相同。
无效持续时间 确保持续时间 FreeTrialPricingTerm 在允许的范围内。
无效持续时间 在中提供与之间的 AgreementStartDate 持续时间 FixedUpfrontPricingTerm 相匹配的持续时间 AgreementEndDate。
无效持续时间 提供介于 [x] 和 [y] 个月之间的持续时间。
无效持续时间 确保计量维度的持续时间粒度为日级别。
无效补助金 为中的所有补助金 MaxQuantity 提供相同的补助金 FreeTrialPricingTerm。
无效补助金 为中所有可用的计量维度提供资助。 FreeTrialPricingTerm
无效补助金 The combination of Dimensions in grants is invalid in FixedUpfrontPricingTerm for the product.
无效补助金 The combination of Dimensions in grants is invalid in FreeTrialPricingTerm for the product.
无效补助金 FixedUpfrontPricingTerm with MaxQuantity is not supported for this product.
价格变动无效 [x] 要等到 [y] 才能更新,因为您在过去 120 天内申请了提价。要取消您之前的涨价请求或了解更多信息,请联系AWS Marketplace托管目录运营团队。
价格变动无效 同一请求不支持在 [x] 中增加价格和增加维度。先添加维度。
价格变动无效 同一请求 UsageBasedPricingTerm不支持涨价和降价。先降低价格。
价格变动无效 在同一个请求中 UsageBasedPricingTerm 不支持价格上涨 RecurringPaymentTerm 和降价。先降低价格。
价格变动无效 在同一个请求中 UsageBasedPricingTerm 不支持降价 RecurringPaymentTerm 和提价。先降低价格。
无效的费率卡 ConfigurableUpfrontPricingTerm 在持续时间 [x] 内缺少一个或多个维度密钥。提供所有持续时间内同一组维度密钥的价格。
无效的费率卡 在中仅提供计量尺寸的价目表。 UsageBasedPricingTerm
无效的费率卡 无法从 [x] 中删除费率。在现有价目表中提供所有维度的价格。
无效的费率卡 提供在 [x] 中具有相同单位的尺寸。
无效的费率卡 在 [x] 中提供所有计量尺寸或所有授权尺寸。
无效的费率卡 在 [x] 中仅提供授权尺寸。
无效的费率卡 为中所有可用的计量维度提供基于使用量的费率。 UsageBasedPricingTerm
无效的费率卡 为所有免费试用版维度提供基于使用量的费率。
无效的费率卡 提供最多 8 位小数点的价格 UsageBasedPricingTerm。
无效的费率卡 The combination of Dimensions in rate card is invalid in UsageBasedPricingTerm for the product.
选择器持续时间值无效 提供介于 [x] 和 [y] 个月之间的持续时间。
选择器持续时间值无效 确保计量维度的持续时间粒度为日级别。
选择器持续时间值无效 确保持续时间 ConfigurableUpfrontPricingTerm 在允许的范围内。
选择器持续时间值无效 提供一个或多个支持的合同期限。
选择器持续时间值无效 提供一个或多个支持的合同期限或单个自定义期限。
选择器持续时间值无效 在中提供与之间的 AgreementStartDate 持续时间 ConfigurableUpfrontPricingTerm相匹配的持续时间 AgreementEndDate。
缺少持续时间 提供持续时间 FixedUpfrontPricingTerm。
缺少强制性条款 FixedUpfrontPricingTerm 仅在与 ByolPricingTerm 或配对时才支持 PaymentScheduleTerm。
缺少强制性条款 至少提供 [x, y, z] 中的一个。
缺少强制性条款 在使用 Byol 定价模型 ByolPricingTerm 时提供信息。
补助金太多了 在 [y] 中提供最多 [x] 项补助。
评分卡太多了 该产品只允许 ConfigurableUpfrontPricingTerm使用一张价目表。
评分卡太多了 该产品最多允许 [x] 张 ConfigurableUpfrontPricingTerm 价目表。
费率太多了 在允许的限制 RateCards 范围内提供 ConfigurableUpfrontPricingTerm。
费率太多了 在允许的限制 RateCards 范围内提供 UsageBasedPricingTerm。
不兼容的费率卡片约束 在中将 MultipleDimensionSelection 和设置 QuantityConfiguration 为相同的值(“允许” 或 “不允许”)。 ConfigurableUpfrontPricingTerm
不兼容的费率卡片约束 为中的所有价目表提供相同的限制 ConfigurableUpfrontPricingTerm。
无效的更新请求 [x] 无法更新。要申请价格变更或了解更多信息,请联系AWS Marketplace托管目录运营团队。
不兼容的定价模型 PricingModel 无法从 [x] 更改为 [y]。
无效补助金 MaxQuantity 因为 FreeTrialPricingTerm 仅限于该产品。提供 MaxQuantity 小于或等于 [x] 的值。有关更多信息,请联系AWS Marketplace托管目录运营团队。
无效补助金 MaxQuantity 为所有补助金提供资金 FixedUpfrontPricingTerm。
无效补助金 MaxQuantity 该产品不支持。 FixedUpfrontPricingTerm
不兼容_转售_授权 确保在中 RateCards 指定的 FixedUpfrontPricingTerm 匹配项中获得补助 ResaleAuthorization。

更新报价的可发现性

您可以使用目录 API 来控制您的商品在中的AWS Marketplace可发现性。

您可以选择将来设定一个特定的日期以限制您的报价的可发现性,也可以选择将您的报价设置为过去的到期日期。UpdateAvailability变更类型不影响现有协议。

注意
  • 您可以对已经发布的私有报价(也称为已发布)使用UpdateAvailability变更类型。如果买家已经接受了私募报价,则这些现有协议不会受到影响。

  • AvailabilityEndDate修改现有私人报价时,必须遵守协议期限的限制。如果不是,请在此变更集中添加其他UpdateValidityTerms更改类型,以修改协议期限以遵守新的到期日期。UpdateValidityTerms变更类型可用于已发布或尚未发布的私人报价。

  • AvailabilityEndDate修改现有私人报价时,必须遵守付款时间表的限制。如果不是,并且私募报价尚未发布,请在此变更集中添加其他UpdatePaymentScheduleTerms变更类型,以修改付款时间表以遵守新的到期日。如果私募报价已经发布,则只有在AvailabilityEndDate新的日期遵守付款时间表限制的前提下,您才能对其进行更改。

要控制您的商品的可发现性,请使用UpdateAvailability更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateAvailability", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "AvailabilityEndDate": "2024-05-31" } } ] }

为要添加UpdateAvailability更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • AvailabilityEndDate(字符串)(必填)— 这是在中发现和购买报价的日期。AWS Marketplace您可以选择将来的特定日期设置为未来以限制可用性,也可以选择将过去的特定日期设置为过期。日期以YYYY-MM-DD格式表示。

已根据您的请求创建更改集。对该请求的响应将为您提供变更集的 ID 和 ARN,如下所示。

响应语法

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

变更请求被添加到队列中并进行处理。它包括验证信息,以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。您可以通过或在目录 API 中使用DescribeChangeSet操作检查请求的状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateAvailabilityAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
AvailabilityEndDate

必填

格式:“YYYY-MM-DD”

422

异步错误

以下错误特定于中的UpdateAvailability操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多详细信息,请参阅使用变更集

错误代码 错误消息
无效的可用性结束日期 AvailabilityEndDate 不支持公开报价。
无效的可用性结束日期 提供未来 AvailabilityEndDate。
无效的可用性结束日期 提供 AvailabilityEndDate 之前的 AgreementEndDate。
缺少可用性结束日期 提供 AvailabilityEndDate 协议结束日期之前的。

定义使用报价创建的协议的到期日期

您可以使用目录 API 来定义使用中的报价创建的协议的到期日期详细信息AWS Marketplace。

此更改类型不影响现有协议。

注意

您可以对已经发布的私有报价(也称为已发布)使用UpdateValidityTerms变更类型。如果买家已经接受了私募报价,则这些现有协议不会受到影响。

对于AMI-based基于容器的产品,如果您的私有报价定价条款包含的期限类型为Duration(例如,术语类型FixedUpfrontPricingTermConfigurableUpfrontPricingTerm),则您在此更改类型中的AgreementDuration设置必须大于以下值:从今天到私募报价到期的天数加上这些期限类型中设置Duration的天数。这是因为在买方接受私募报价并创建协议后,他们可以选择购买这些条款类型中指定的其他权利,直到私募报价到期。此外,所有额外权利都必须在协议终止之前终止。例如,如果买方在第一个可用日接受私募报价,然后在最后一个可用日购买权利,则这些权利不得在协议结束日期之后终止。

要定义使用优惠创建的协议的到期日详细信息,请使用UpdateValidityTerms更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateValidityTerms", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "ValidityTerm", "AgreementDuration": "P12M", "AgreementStartDate": "2021-08-01", "AgreementEndDate": "2022-08-01" } ] } } ] }

为要添加UpdateValidityTerms更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • 术语(结构数组)-要更新的有效性术语列表。支持的有效期条款有:

      • ValidityTerm(object)— 定义使根据此优惠生成的协议保持有效的条件。

        • 类型(字符串)-正在更新的术语的类别。 ValidityTerm

        • AgreementDuration(字符串)-定义协议保持活动状态的持续时间。如果AgreementStartDate未提供,则协议持续时间与协议签署时间相关。持续时间以 ISO_8601 格式表示。

        • AgreementStartDate(字符串)-定义协议的开始日期。 AgreementStartDateYYYY-MM-DD格式表示。协议从所提供日期的世界标准时间 00:00:00.000 开始。如果AgreementStartDate未提供,则根据协议签名时间确定协议开始日期。

        • AgreementEndDate(字符串)-定义协议结束的日期。AgreementEndDateYYYY-MM-DD格式表示。协议在提供的日期世界标准时间 23:59:59 .999 结束。如果AgreementEndDate未提供,则协议结束日期由各个条款的有效性决定。

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

变更请求被添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateValidityTermsAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
术语

必填

422
条款 [] .Type

必填

只能是 "ValidityTerm"

422
条款 []。 AgreementDuration

可选

每种选择器类型的预期格式:ISO 8601 持续时间

可以单独使用,也可以搭配使用 AgreementStartDate

422
条款 []。 AgreementEndDate

可选

日期的格式必须为 "YYYY-MM-DD"

422
条款 []。 AgreementStartDate

可选

日期的格式必须为 "YYYY-MM-DD"

只能与AgreementEndDate和配对 AgreementDuration

422

异步错误

以下错误特定于中的UpdateValidityTerms操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容协议 AgreementStartDate 不可能在将来要取代的当前协议未过时。
不兼容_协议_结束_日期 AgreementEndDate 优惠发布后无法更新。
不兼容_协议_开始_日期 AgreementStartDate 优惠发布后无法更新。
不兼容的产品 AgreementStartDate 不支持 in the future。
不兼容_转售_授权 确保 AgreementStartDate 和 AgreementEndDate 之间的持续时间与兼容 ResaleAuthorization。
不兼容_转售_授权 确保 AgreementStartDate 与. 兼容 ResaleAuthorization。
不兼容_转售_授权 确保 AgreementEndDate 与. 兼容 ResaleAuthorization。
不兼容_转售_授权 确保 AgreementStartDate 和 AgreementEndDate 之间的持续时间与兼容 ResaleAuthorization。
不兼容_转售_授权 确保 AgreementDuration 匹配中指定的持续时间 ResaleAuthorization。
不兼容条款 ValidityTerm 不支持公开报价。
不兼容条款 报价到期后,无法执行所请求的更改。
无效协议持续时间 提供大 AgreementDuration 于或等于 [x] 天。
无效的协议结束日期 提供未来 AgreementEndDate。
无效的协议结束日期 提供等 AgreementEndDate 于 [x] 之后或等于 [x]。
无效的协议开始日期 提供一个 tha AgreementStartDate t is aft AvailabilityEndDate er。
无效的协议开始日期 提供 AgreementStartDate 之前的 AgreementEndDate.
无效的协议开始日期 提供 AgreementStartDate 从今天起 [x] 年内的。
无效协议时间间隔 ValidityTerm 同时使用 AgreementDuration 和 AgreementEndDate 不支持。
无效协议时间间隔 ValidityTerm 两者 AgreementStartDate AgreementDuration 兼而有之,且该产品的报价不支持该产品。
无效协议时间间隔 ValidityTerm 该产品的报价 AgreementStartDate 不支持使用。
无效协议时间间隔 ValidityTerm AgreementStartDate 不支持 “只有”。
无效协议时间间隔 AgreementEndDate 除非它与 future 组合使用 AgreementStartDate 或用于替代报价,否则不支持。
无效协议时间间隔 AgreementEndDate 如果 AgreementStartDate 差异小于或等于 [x] 年,则提供。
缺少协议开始日期 与一起使用 ValidityTerm时请确保 AgreementStartDate 存在 ConfigurableUpfrontPricingTerm。
无效的协议结束日期 提供 AgreementEndDate 从今天起 [x] 年内的。
不兼容_协议_开始_日期 当协议的开始日期 AgreementStartDate 为 future 时,请提供与协议中定义的相同内容。
不兼容协议 AgreementStartDate 当协议不是未来日期时,就不能定为未来日期。

更新付款时间表详情

您可以在中使用目录 API 来更新报价的付款时间表详细信息,例如灵活的付款时间表AWS Marketplace。

注意

您不能对已经发布的报价(也称为已发布)使用UpdatePaymentScheduleTerms变更类型。

私募要约在创建私募要约到期之间的任何一天都可以接受(在中设置AvailabilityEndDate)。付款时间表中只有一个ChargeDate值可以是买方可以接受私募报价的最后一天(私募报价到期日)或之前的日期。的剩余价值ChargeDate必须在私募要约到期之后,但如果私募要约立即被接受,则不得迟于协议结束。协议的终止取决于何时接受私募要约(创建协议)加上协议的期限

要更新报价的付款时间表详情,请使用UpdatePaymentScheduleTerms更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdatePaymentScheduleTerms", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "PaymentScheduleTerm", "Schedule": [ { "ChargeDate": "2021-12-01", "ChargeAmount": "200.00" }, { "ChargeDate": "2022-03-01", "ChargeAmount": "250.00" } ] } ] } } ] }

为要添加UpdatePaymentScheduleTerms更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • 条款(结构数组)-您要更新的付款条件列表。支持的付款条件有:

      • PaymentScheduleTerm(object)— 定义一种基于分期付款的定价模型,在该模型中,在协议有效期内的不同日期向客户收取固定价格。

        • 类型(字符串)-要更新的术语的类型。这是对象的值:"PaymentScheduleTerm"

        • 附表(结构数组)-付款时间表列表,其中每个要素定义一期付款。它包含计算要支付的价格和向客户收取费用的日期所需的信息。

          • ChargeDate(字符串)-客户支付此付款时间表条款中定义的价格的日期。 ChargeDate以 YYYY-MM-DD 格式表示。发票在提供的日期生成。

          • ChargeAmount(字符串)—客户在预定日期要支付的价格(ChargeDate)。

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

变更请求被添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdatePaymentScheduleTermsAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP
术语

必填

PaymentScheduleTerm允许

列表大小必须小于 2

422
条款 [] .Type

必填

只能是 PaymentScheduleTerm

422
条款 []。 PaymentScheduleTerm.CurrencyCode

必填

支持的货币:[“美元”、“澳元”、“欧元”、“英镑”、“日元”]

422
条款 []。 PaymentScheduleTerm.Schedule[]

必填

422
条款 []。 PaymentScheduleTerm.Schedule[]。 ChargeAmount 必填

日期类型为 “字符串”

Non-negative支持最多 2 位小数的小数

422
条款 []。 PaymentScheduleTerm.Schedule[]。 ChargeDate

必填

日期的格式必须像 “YYYY-MM-DD”

422

异步错误

以下错误特定于中的UpdatePaymentScheduleTerms操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
重复充电日期 在中提供唯一的收费日期 PaymentScheduleTerm。
不兼容的货币代码 CurrencyCode 优惠发布后无法更改。
不兼容标记百分比 PaymentScheduleTerm 大于零 (0) 时 MarkupPercentage 不支持。
不兼容的付款设置 更新您的付款设置以使其与兼容 CurrencyCode。
不兼容_转售_授权 提供与. 兼容的术语 ResaleAuthorization。不兼容的术语:[PaymentScheduleTerm]。
不兼容_转售_授权 确保 ChargeAmounts 总输入 PaymentScheduleTerm值与 ResaleAuthorization.
不兼容_卖家_验证 完成所有必需的卖家验证流程。
不兼容条款 报价发布后,无法执行所请求的更改。
不兼容条款 报价到期后,无法执行所请求的更改。
无效的收费日期 提供之前的收费日期 AgreementEndDate。
无效的货币代码 提供支持的 CurrencyCode。
无效的货币代码 CurrencyCode 所有定价和付款条件均相同。
TOO_MANY_BACKDATED_CHARGES 之前最多提供 1 次定期付款 AvailabilityEndDate。
无效的收费日期 请提供上次充电日期之前的日期 AgreementEndDate。
无效的收费日期 请提供不是过去的首次充电日期。
收费太多了 提供最多 [x] 笔定期付款 PaymentScheduleTerm。

修改续订选项

您可以使用目录 API 来控制中使用此优惠创建的协议的续订选项AWS Marketplace。

对于通过 Catalog API 创建的报价,在您调用UpdateRenewalTerms变更类型以允许自动续订之前,自动续订默认处于禁用状态。此变更不影响现有协议。

要控制使用此优惠创建的协议的续订选项,请使用UpdateRenewalTerms更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateRenewalTerms", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "RenewalTerm" } ] } } ] }

为要添加UpdateRenewalTerms更改类型的字段提供信息:

  • 实体(对象)(必填)-您的报价。

    • 类型(字符串)(必填)-始终TypeOffer@1.0

    • 标识符(字符串)(必填)-您的报价编号。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)(必填)-请求细节的 JSON 值。

    • 条款(结构数组)-您要更新的续订条款列表。支持的续订条款有:

      • RenewalTerm(object)— 定义在协议优雅终止(非买方到期或AWS Marketplace取消)时,将使用现有协议中已接受的条款创建新协议。ValidityTerm换句话说,协议将续签。优惠RenewalTerm中存在意味着允许自动续订。买家可以在 acceptance/agreement 创建报价时选择接受或拒绝自动续订。

        • 类型(字符串)-要更新的术语的类型。 RenewalTerm

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

变更请求被添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的UpdateRenewalTermsAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则 HTTP 代码
术语 必填 422
条款 [] .Type 必填

只能是 “RenewalTerm”

422

异步错误

以下错误特定于中的UpdateRenewalTerms操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多详细信息,请参阅使用变更集

错误代码 错误消息
不兼容的产品 RenewalTerm 不支持该产品的私密报价。
不兼容条款 RenewalTerm 不支持与 PaymentScheduleTerm。
不兼容条款 RenewalTerm 不支持 PricingModel。
不兼容条款 报价发布后,无法执行所请求的更改。
不兼容条款 报价到期后,无法执行所请求的更改。

发布报价

您可以使用 Catalog API 合并从所有更新更改类型收集的信息,然后发布选件。

优惠将保持Draft状态,直到被ReleaseOffer叫出为止。优惠发布后,即可在中找到。AWS Marketplace

要发布您的报价,请使用ReleaseOffer更改类型调用 StartChangeSet API 操作,如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "ReleaseOffer", "Entity": { "Type": "Offer@1.0", "Identifier": "offer-123456789" }, "DetailsDocument": {} } ] }

为要添加ReleaseOffer更改类型的字段提供信息:

  • 实体(对象)-正在创建的实体的命名类型。Identifier这是您的报价 ID,始终TypeOffer@1.0。有关更多信息,请参阅 标识符

  • DetailsDocument(对象)-请求细节的 JSON 值。必须为空ReleaseOffer

响应语法

已根据您的请求创建更改集。对该请求的响应为您提供了变更集的和,如下所示。ChangeSetId ChangeSetArn

{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }

变更请求被添加到队列中并进行处理。这包括验证信息以确保其符合AWS Marketplace指导方针。验证过程可能需要几分钟。

您可以通过,也可以使用 API 操作直接通过 Catalog API 检查请求的DescribeChangeSet状态。AWS Marketplace 管理门户

同步验证

以下架构验证特定于中的ReleaseOfferAWS Marketplace Catalog API操作。这些验证是在您致电StartChangeSet时执行的。如果请求不符合以下要求,则会失败,并显示 HTTP 响应。

输入字段 验证规则
DetailsDocument 必须为空 ({})

异步错误

以下错误特定于中的ReleaseOffer操作AWS Marketplace Catalog API。当您在处理更改集DescribeChangeSet之后调用时,会返回这些错误。有关使用DescribeChangeSet获取变更请求状态的更多信息,请参阅使用变更集

错误代码 错误消息
不兼容的付款设置 更新您的付款设置以使其与兼容 CurrencyCode。
不兼容的产品 首先为产品创建公开报价。
不兼容_卖家_验证 完成所有必需的卖家验证流程。
不兼容的定位 PreExistingAgreement 仅支持买家定向报价。
不兼容的定位 OfferSetId 仅支持买家定向报价。
无效的税务信息 您的税务信息不完整。要销售专业服务AWS Marketplace,您必须填写 DAC7 税务问卷。导航至 “付款信息” 部分,然后选择 DAC7 纳税表。更新您的税务信息最多可能需要两个小时。
无效的更新请求 报价发布后,无法执行所请求的更改。
缺少协议结束日期 提供 AgreementEndDate 换货报价。
缺少可用性结束日期 提供私人 AvailabilityEndDate 报价。
缺少买家账户 BuyersAccounts 为 PositiveTargeting 使用创建的报价提供 ResaleAuthorization。
缺少买家账户 该产品的所有报价都必须是私密的。 PositiveTargeting 提供 BuyersAccounts。
缺少描述 在发布优惠之前设置描述。
缺少强制性条款 在报价中添加 [x]。
缺少强制性条款 FixedUpfrontPricingTerm 如果报价包含,则提供 PaymentScheduleTerm。
缺少名字 在发布优惠之前设置名称。
优惠太多了 每种产品只能创建一项公开免费试用优惠。
优惠太多了 每种产品只能创建一个公开报价。
缺少强制性条款 RenewalTerm 提供带有产品合同定价的公开报价。
缺少协议结束日期 提供 AgreementEndDate 换货报价。

描述现有优惠详情

您可以使用目录 API 来描述中的现有商品详情AWS Marketplace。

要描述现有的优惠详情,请使用Offer@1.0实体类型调用 DescribeEntity API 操作,如以下示例所示。

请求语法

GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1

为要添加DescribeEntity更改类型的字段提供信息:

  • 目录(字符串)-与请求相关的目录。固定值:AWSMarketplace.

  • E@@ ntityID(字符串)-要描述的选件的唯一 ID。

响应语法

对该请求的回复将为您提供报价详情,如下所示。

{ "EntityType": "Offer@1.0", "EntityIdentifier": "offer-ad8EXAMPLE51@1", "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/Offer/offer-ad8EXAMPLE51", "LastModifiedDate": "2021-03-10T21:57:16Z", "DetailsDocument": { "Id": "offer-3rEXAMPLErn", "State": "Released", "Name": "Test Offer", "Description": "Worldwide offer for Test Product", "PreExistingAgreement": { "AcquisitionChannel": "External", "PricingModel": "Contract" }, "ProductId": "prod-ad8EXAMPLE51", "OfferSetId": "offerset-b3f9EXAMPLE27", "Terms": [ { "Type": "SupportTerm", "RefundPolicy": "If you need to request a refund for software sold by Amazon Web Services, LLC, please contact AWS Customer Service." }, { "Type": "LegalTerm", "Documents": [ { "Type": "CustomEula", "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt" } ] }, { "Type": "FreeTrialPricingTerm", "Duration": "P30D", "Grants": [ { "DimensionKey": "m3.xlarge", "MaxQuantity": 10 }, { "DimensionKey": "m4.xlarge", "MaxQuantity": 10 } ] }, { "Type": "ConfigurableUpfrontPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "Selector": { "Type": "Duration", "Value": "P365D" }, "RateCard": [ { "DimensionKey": "m3.large", "Price": "300.00" }, { "DimensionKey": "m4.xlarge", "Price": "400.00" } ], "Constraints": { "MultipleDimensionSelection": "Allowed", "QuantityConfiguration": "Allowed" } } ] }, { "Type": "UsageBasedPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "RateCard": [ { "DimensionKey": "m3.large", "Price": "0.10" }, { "DimensionKey": "m4.xlarge", "Price": "0.20" } ] } ] }, { "Type": "FixedUpfrontPricingTerm", "CurrencyCode": "USD", "Price": "200.00", "Grants": [ { "DimensionKey": "Users", "MaxQuantity": 10 } ] }, { "Type": "RecurringPaymentTerm", "CurrencyCode": "USD", "BillingPeriod": "Monthly", "Price": "100.0" }, { "Type": "PaymentScheduleTerm", "CurrencyCode": "USD", "Schedule": [ { "ChargeDate": "2020-12-01T00:00:00.000Z", "ChargeAmount": "1000.00" }, { "ChargeDate": "2021-06-15T00:00:00.000Z", "ChargeAmount": "1250.00" } ] }, { "Type": "ByolPricingTerm" }, { "Type": "RenewalTerm" } ], "Rules": [ { "Type": "TargetingRule", "PositiveTargeting": { "CountryCodes": [ "US", "CA" ], "BuyerAccounts": [ "444455556666" ] }, "NegativeTargeting": { "CountryCodes": [ "XX" ] } }, { "Type": "AvailabilityRule", "AvailabilityEndDate": "2024-08-30T01:56:03.000Z" } ] } }

以下是您在DescribeEntity响应中看到的字段的相关信息。

  • EntityType(字符串)-实体的命名类型,即Offer@1.0

  • EntityIdentifier(字符串)-实体的标识符,格式为EntityId@RevisionId

  • EntityArn(字符串)-与此请求中引用的更改集的唯一标识符关联的 ARN。

  • LastModifiedDate(字符串)-实体的上次修改日期,采用 ISO 8601 格式(例如:2018-02-27T13:45:22Z)。

  • 详细信息(字符串)-此字符串化的 JSON 对象包含实体的以下详细信息:

    • ID(字符串)-AWS Marketplace 和中报价实体的唯一标识符,在创建报价期间生成。

    • (字符串)-报价的状态。

    • 名称(字符串)— 与报价关联的名称,便于您和您的客户阅读。它也将作为协议信息的一部分显示。

    • 描述(字符串)-描述是一种自由格式的文本,仅供您使用,永远不会向买家公开。

    • PreExistingAgreement(字符串)— 确定此优惠是否为与现有客户签订的相同基础产品的现有协议的续订。现有协议可以是内部协议,也可以是外部协议AWS Marketplace。 AWS可能会审核并确认您的报价是否为续订。AWS如果无法验证您的报价,则AWS可以撤销客户的报价和权利。

      • AcquisitionChannel(字符串)-表示现有协议是在外部AWS Marketplace还是内部签署AWS Marketplace。可能的值:ExternalAwsMarketplace

      • PricingModel(字符串)-表示现有协议使用哪种定价模式。可能的值:ContractUsageByolFree

    • ProductId(字符串)-所提供产品的唯一标识符。

    • OfferSetId(字符串)-要与此优惠关联的优惠集的唯一标识符。

    • 术语(结构数组)-术语列表。

    • 规则(结构数组)-规则列表。