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

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

处理卖家商品

您可以使用自动执行AWS Marketplace Catalog API处理卖家商品的任务。这包括创建、更新、查看、列出和排序产品的功能。这使您能够实现产品管理的自动化。例如，您可以在上提供自助发布功能AWS Marketplace 管理门户。

商品是您打算销售的单位或资源AWS Marketplace，通常称为基础产品。在您添加产品信息、部署属性和账单信息之前，买家无法消费基础产品。

商品描述了您打算销售的商品的商品信息、软件部署属性和计费机制。商品必须与报价配对，才能成为您可以出售且买家可以使用的可交易单位。AWS Marketplace

您也可以AWS Marketplace Catalog API使用：

每种产品类型都有不同的产品实体。实体可以是产品或报价AWS Marketplace。支持以下产品类型和实体：

以下主题假设您有权访问 API 并已完成卖家的所有先决条件，如中所述的访问控制AWS MarketplaceCatalog API。

请参阅以下资源：

以下主题介绍如何使用目录 API 对您的单 AMI 产品、基于容器的产品或 SaaS 产品执行操作。

创建产品

您可以使用目录 API 创建带有标识符（产品代码和产品 ID）的 AMI、容器、机器学习或 SaaS 产品文档AWS Marketplace。

您可以通过使用CreateProduct更改类型调用 StartChangeSet API 操作来创建Draft处于状态的产品。

如果您的请求成功处理，则AWS Marketplace Catalog API会为您生成处于Draft状态的产品。这是一款不完整的商品，买家看不见AWS Marketplace。

然后，您可以使用Update变更类型来完成创建产品流程：UpdateInformationUpdateDimensions、UpdateTargeting、和UpdateVisibility。

商品完成后，您可以使用ReleaseProduct变更类型完成商品创建流程，然后发布报价。此过程验证整个产品并将产品移至Limited状态。

要创建处于Draft状态的产品，请使用CreateProduct更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

为字段提供信息以添加CreateProduct更改类型。此变更类型可以采用ProductTitle属性，但其限制与发送到UpdateInformation变更类型的限制相同。

响应语法

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

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

变更请求被添加到队列中并进行处理。

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

请求完成后（如果Status是SUCCEEDED），则会生成一个新的ProductId请求。

同步验证

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

异步错误

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

更新产品详情

如果您已有产品AWS Marketplace，则可以使用目录 API 更新 AMI、容器、机器学习或 SaaS 产品的产品详细信息。

要更新产品详情，请使用UpdateInformation更改类型和要更改的详细信息调用 StartChangeSet API 操作，如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

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

响应语法

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

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

变更请求被添加到队列中并进行处理。

要检查请求状态，请使用AWS Marketplace 管理门户或调用 DescribeChangeSet API。

同步验证

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

异步错误

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

添加定价维度

您可以使用 AWS Marketplace 目录服务操作来添加可计费的定价维度，使您能够向用户收取 AMI、容器或 SaaS 产品的费用。

定价维度是卖家为向买家收费而定义的计量单位。无论是基于使用量的定价模式还是基于合同的定价模式，卖家都必须设置此信息才能向买家收取使用产品的账单。维度的类型取决于产品的定价模型。

有关产品定价的更多信息，请参阅《AWS Marketplace卖家指南》中的以下主题：

有关使用添加定价维度的更多信息AWS Marketplace 管理门户，请参阅《AWS Marketplace卖家指南》中的以下主题：

要添加定价维度，请使用AddDimensions更改类型调用 StartChangeSet API，如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

为AddDimensions变更类型提供以下字段。

响应语法

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

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

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

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

同步验证

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

异步错误

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

更新定价维度

您可以使用目录 API 更新中 AMI、容器或 SaaS 产品的现有定价维度AWS Marketplace。

每个维度都由执行更新的维度键和维度类型唯一标识。更新维度不会影响原始维度创建的任何在售商品或客户。

要更新定价维度，请使用UpdateDimensions更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

使用以下字段作为UpdateDimensions更改类型：

响应语法

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

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

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

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

同步验证

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

异步错误

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

限制定价维度

您可以使用目录 API 来限制中 AMI 或 SaaS 产品的现有定价维度AWS Marketplace。

每个维度都由执行更新的维度键和维度类型唯一标识。限制维度不会影响原始维度创建的任何在售商品或客户。

要限制定价维度，请使用RestrictDimensions更改类型调用 StartChangeSet API。

以下示例说明如何限制 SaaS 产品的Entitled维度。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

使用以下字段作为RestrictDimensions更改类型：

响应语法

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

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

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

您可以通过或调用 DescribeChangeSet API 来AWS Marketplace 管理门户检查请求的状态。

同步验证

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

异步错误

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

更新定位配置

您可以使用目录 API 来添加允许在 AMI、容器、机器学习或 SaaS 产品进入Public状态AWS Marketplace之前通过调用UpdateTargeting更改类型来查看 AMI、容器、机器学习或 SaaS 产品的 AWS 账户 ID。

创建新产品时，托管目录操作 (MCO) 帐户会自动添加到允许的帐户列表中。卖家在查看允许的账户时可以在AWS Marketplace管理门户 (AMMP) 和 DescribeEntity API 响应Targeting部分看到这些 MCO 账户。

要添加允许查看 AMI、容器、机器学习或 SaaS 产品的 AWS 账户 ID，请使用UpdateTargeting更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateTargeting",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

将以下字段与UpdateTargeting更改类型一起使用。

响应语法

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

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

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

要检查请求状态，请使用AWS Marketplace 管理门户或调用 DescribeChangeSet API。

请求完成后（如果Status是SUCCEEDED），则会生成一个新的ProductId请求。

同步验证

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

异步错误

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

更新产品知名度

您可以使用目录 API 更新中 AMI、容器、机器学习或 SaaS 产品的可见性（也称为生命周期状态）AWS Marketplace。

允许的目标生命周期状态为LimitedPublic、或Restricted。

要更新产品的可见性，请使用UpdateVisibility更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

什么时候TargetVisibility是Public或Limited。

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

因为什么时候TargetVisibility是Restricted。

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

为字段提供信息以添加UpdateVisibility更改类型。

同步验证

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

触发此更改类型后，最多可能需要 37 天才能完成。这包括AWS Marketplace卖家运营团队需要审查、审计和批准的时间。限制商品时，在AWS Marketplace卖家运营团队开始审计之前CancelChangeSet，您有 24 小时的时间通过致电来改变主意。有关更多信息，请参阅 CancelChangeSet。

响应语法

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

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

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

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

请求完成后（如果Status是SUCCEEDED），则会生成一个新的ProductId请求。

异步错误

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

发布产品

您可以使用目录 API 将 Draft AMI、容器、机器学习或 SaaS 产品发布到Limited状态AWS Marketplace。

要发布产品，请使用ReleaseProduct更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

为要添加到ReleaseProduct更改类型的字段提供信息。此更改类型不使用任何参数负载。

响应语法

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

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

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

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

请求完成后（如果Status是SUCCEEDED），则会生成一个新的ProductId请求。

异步错误

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

查找您的产品编号

您必须先获取产品的产品编码，然后才能使用AWS Marketplace目录 API 对其进行修改。有两种方法可以找到服务器产品的产品 ID：

以下主题说明了如何通过筛选实体 ID、产品标题、上次修改日期或可见性来查找产品。

根据产品标题查找产品

请求

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

响应

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

根据上次修改日期查找产品

请求

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

响应

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

根据产品知名度查找产品

请求

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

响应

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

根据产品标题、上次修改日期和产品知名度查找产品

请求

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

响应

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

获取有关产品的更多详细信息

您可以使用带有DescribeEntity操作的实体 ID 来获取有关产品的更多详细信息。

请求

GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

响应

HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

更改集合状态和错误

在AWS Marketplace目录 API 中对卖家商品进行更改需要创建描述您要进行的更改的变更集，然后使用StartChangeSet操作开始更改。根据请求的不同，对请求的更改可能需要几分钟、几小时或更长时间才能完成。对此请求的响应如下所示。

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

变更请求将被添加到队列中并进行处理，包括扫描文件和信息以确保其符合产品AWS Marketplace指南。根据变更请求，此过程可能需要几分钟到几天的时间。您可以通过或在目录 API 中使用DescribeChangeSet操作检查请求的状态。AWS Marketplace 管理门户有关更改集的更多信息，请参阅使用变更集。

要查看您的请求状态，请使用DescribeChangeSet操作。

POST /DescribeChangeSet HTTP/1.1
Content-type: application/json

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

此调用的结果如下所示（在本例中，用于向容器产品添加新版本）。

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

该Status字段显示请求的当前状态，在本例中为SUCCEEDED。

如果出现故障，则结果可能包括两种类型的错误。对于大多数错误，直接包含错误消息。但是，在扫描产品是否存在安全漏洞时发现的错误会包含一个文件的 URL，该文件列出了该ErrorMessage字段中发现的所有错误。扫描时发现的错误有 ErrorCode “SCAN_ERROR”。

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

在此示例中，直接报告了一个错误 (DUPLICATE_VERSION_TITLE)。另一个错误有一个包含错误消息的文件（在链接的文件中，单个错误SCAN_ERROR可能存在多个已发现的错误）。