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

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

使用 AMI-based 产品

您可以使用自动执行处理基于亚马逊系统映像 (AMI) 的产品的任务。AWS Marketplace Catalog API

有关使用目录 API 创建 AMI-based 产品的信息，请参阅创建产品。

以下主题介绍如何使用目录 API 对您的 AMI-based 产品执行操作：

添加新版本

您可以使用目录 API 向中的现有 AMI-based 产品添加新版本AWS Marketplace。有关使用向产品添加新 AMI 版本的更多信息AWS Marketplace 管理门户，请参阅《AWS Marketplace卖家指南》中的添加新版本。

当您创建包含向 AWS Marketplace 添加新 AMI 的请求时，必须将该 AMI 复制到 AWS Marketplace 系统中，然后扫描是否存在安全问题。您必须通过创建有权对您的 AMI 执行操作的 AWS 身份和访问管理 (IAM) 角色来授予 AWS Marketplace 访问 AMI 的权限。有关所需权限的更多信息，请参阅AWS Marketplace卖家指南中的授予 AWS Marktplace 访问您的 AMI 的权限。

要添加新版本，请使用 AMI-based 产品的AddDeliveryOptions更改类型调用 StartChangeSet API 操作，如以下示例所示。要在不实际创建新版本的情况下测试 API 调用，请将Intent参数设置为VALIDATE。有关更多信息，请参阅意图。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "AmiProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "My new title",
          "ReleaseNotes": "My new Release notes"
        },
        "DeliveryOptions":
        [
          {
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "AmiSource":
                {
                  "AmiId": "ami-1234567890abcdef",
                  "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                  "UserName": "ec2-user",
                  "OperatingSystemName": "AMAZONLINUX",
                  "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2",
                  "AfiIds": ["afi-1234567890abcdefg", "afi-abcdefg1234567890"] //Optional (Required only for FPGA products)
                },
                "UsageInstructions": "Easy to use AMI",
                "RecommendedInstanceType": "m4.xlarge",
                "SecurityGroups":
                [
                  {
                    "IpProtocol": "tcp",
                    "FromPort": 443,
                    "ToPort": 443,
                    "IpRanges":
                    [
                      "0.0.0.0/0"
                    ]
                  }
                ]
              }
            }
          },
          {
            "DeliveryOptionTitle": "My new AMI with CFTdelivery option",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {
                "ShortDescription": "My new short description",
                "LongDescription": "My new long description",
                "UsageInstructions": "My new usage instructions",
                "RecommendedInstanceType": "m4.xlarge",
                "ArchitectureDiagram": "https://my-bucket.s3.amazonaws.com/my-folder/diagram.png",
                "Template": "https://my-bucket.s3.amazonaws.com/my-folder/cft.template",
                "TemplateSources":
                [
                  {
                    "ParameterName": "MyAmiParam",
                    "AmiSource":
                    {
                      "AmiId": "ami-1234567890abcdef",
                      "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceAmiIngestion",
                      "UserName": "ec2-user",
                      "OperatingSystemName": "AMAZONLINUX",
                      "OperatingSystemVersion": "Amazon Linux 2 AMI 2.0.20210126.0 x86_64 HVM gp2"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "Intent": "APPLY"
}

以下列表提供了有关您在AddDeliveryOptions更改类型中使用的输入字段的信息。除非另有说明，否则所有字段均为必填字段。有关这些字段的更多信息，请参阅《AWS Marketplace卖家指南》中的添加新版本。

响应语法

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

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

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

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

有关卖家商品变更集错误的更多信息，请参阅更改集合状态和错误。

请求完成后，将添加版本，任何现有订阅者都将收到一封电子邮件，告知他们有关新版本的信息。有关添加新版本流程的更多信息，请参阅《AWS Marketplace卖家指南》中的添加新版本。

异步错误

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

您也可以使用创建 AMI-based 产品AWS Marketplace 管理门户。有关更多信息，请参阅《AWS Marketplace卖家指南》中的 AMI 产品。

有关如何自动更新 AMI-based 商品的演练，您也可以参阅视频 “AWS Marketplace使用目录 API 自动更新您的产品清单” (5: 08)。

更新版本信息

您可以使用目录 API 更新中现有 AMI-based 产品版本的详细信息AWS Marketplace。

您无法更新该版本的 AMI。如果您需要更新 AMI，请改为创建一个新版本。

要添加新版本，请使用UpdateDeliveryOptions更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "ReleaseNotes": "*My new Release notes*"
        },
        "DeliveryOptions":
        [
          {
            "Id": "example1-2222-cccc-2222-cccccccccccc",
            "Details":
            {
              "AmiDeliveryOptionDetails":
              {
                "UsageInstructions": "Easy to use AMI"
              }
            }
          },
          {
            "Id": "example1-2222-dddd-2222-dddddddddddd",
            "Details":
            {
              "DeploymentTemplateDeliveryOptionDetails":
              {work with ami
                "DeliveryOptionTitle": "My updated delivery option title",
                "UsageInstructions": "Updated usage instructions here."
              }
            }
          }
        ]
      }
    }
  ]
}

以下是有关您为添加UpdateDeliveryOptions更改类型而提供的输入字段的信息。有关这些字段的更多信息，请参阅《AWS Marketplace卖家指南》中的更新版本信息。

响应语法

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

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

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

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

有关更改集的更多信息，请参阅使用变更集。有关卖家商品变更集错误的更多信息，请参阅更改集合状态和错误。

异步错误

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

在更改集开始处理后，您可以使用该DescribeChangeSet操作来检索UpdatePricingTerms操作。有关错误详情和疑难解答的更多信息更改集合状态和错误，请参阅本指南前面的。

限制版本

您可以使用目录 API 来限制 AMI-based 产品的某个版本。这可以防止新买家使用该版本，但仍可供现有买家使用。限制某个版本的所有交付选项会限制该版本。限制一个版本中的一个或多个（但不是全部）交付选项只会限制该版本中的交付选项。您必须始终拥有至少一个不受限制的产品版本，这样您就无法限制产品的最新公开发售版本。

要限制版本，请使用RestrictDeliveryOptions更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "example1-2222-cccc-2222-cccccccccccc"
        ]
      }
    }
  ]
}

以下是有关您为添加RestrictDeliveryOptions更改类型而提供的输入字段的信息：

响应语法

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

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

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

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

异步错误

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

更新 futureAWS 区域  支持

您可以使用目录 API 在中更改 AMI-based 产品的 future AWS 区域 支持偏好AWS Marketplace。

要更改 fut AWS 区域 ure 支持首选项，请使用UpdateFutureRegionSupport更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateFutureRegionSupport",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "FutureRegionSupport":
        {
          "SupportedRegions":
          [
            "All"
          ]
        }
      }
    }
  ]
}

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

响应语法

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

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

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

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

异步错误

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

添加支持的AWS 区域

您可以使用目录 API 在中AWS 区域为您的 AMI-based产品添加新的支持AWS Marketplace。

要添加新的支持区域，请使用AddRegions更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

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

响应语法

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

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

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

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

异步错误

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

限制AWS 区域

您可以使用目录 API 来限制以前AWS 区域对您的 AMI-based 产品的支持AWS Marketplace。

要限制以前支持的区域，请使用RestrictRegions更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "RestrictRegions",
      "DetailsDocument": {
        "Regions": [
          "us-east-1",
          "ap-northeast-2"
        ]
      },
      "Entity": {
        "Identifier": "prod-123456@1",
        "Type": "AmiProduct@1.0"
      }
    }
  ]
}

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

响应语法

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

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

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

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

异步错误

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

添加新的实例类型

您可以在中使用目录 API 为您的 AMI-based 产品添加新的实例类型AWS Marketplace。

AddInstanceTypes将在创建产品时向现有产品和新创建的产品添加新的实例类型。更改类型将使用新的实例类型更新产品文档中的所有版本。

添加受限实例类型时，可以将该实例类型从限制列表中移除并添加到可用实例类型列表中。这为卖家提供了更改商品限制的更多控制权。实例类型列表是可互换的，而不是产品的永久受限状态。

对于内部计量的产品，卖家需要调用单独的变更类型AddDimensionsUpdatePricingTerms并更新实例类型的定价。

要添加新的实例类型，请使用RestrictRegions更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

仅AddInstanceTypes更改类型如下所示。尽管按内部计量的 AMI，但卖家需要致电AddInstanceTypes并UpdatePricingTerms更改其 AMI 的类型。

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

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

响应语法

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

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

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

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

同步验证

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

异步错误

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

限制实例类型

您可以在中使用目录 API 来限制或限制您的 AMI-based 产品可用的实例类型AWS Marketplace。

现有订阅者不会受到此变更的影响，他们可以使用受限实例类型。但是，任何新购买者都无法使用受限实例类型。要停止当前的实例类型订阅（一旦实例类型受到限制），您必须联系AWS Marketplace卖家运营团队。

RestrictInstanctTypes将实例类型限制为产品文档中的所有版本。在AddInstanceTypes更改类型中，您正在更新产品的所有版本。您将无法限制推荐的实例类型。推荐的实例类型为版本级别，因此卖家可能无法限制多个实例类型。

对于内部计量的产品，您需要在调用时调RestrictDimensions用单独的变更类型。这样可以防止为受限实例类型创建新的报价。

要限制或限制您的 AMI-based 产品可用的实例类型，请使用RestrictInstanceTypes更改类型调用 StartChangeSet API 操作，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictInstanceTypes",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "InstanceTypes":
        [
          "m1.medium"
        ]
      }
    }
  ]
}

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

响应语法

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

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

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

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

同步验证

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

异步错误

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