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

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

使用基于容器的产品AWS MarketplaceAPI

您可以使用 C AWS Marketplace atalog API 自动执行处理基于容器的产品的任务。

有关使用 Catalog API 创建基于容器的产品的信息，请参阅。创建产品

以下主题介绍如何使用目录 API 对基于容器的产品执行操作：

添加新版本

如果您已有基于容器的产品AWS Marketplace，则可以使用AWS Marketplace Catalog API来添加新版本。这要求您已经在中AWS Marketplace为作为产品一部分的每个容器镜像或工件创建了存储库，并且可以从本地Docker和Helm文件中复制它们。

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

容器镜像传送请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKS Container image only delivery option",
            "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"
              }
            }
          }      
        ]
      }
    }
  ]
}

亚马逊 Bedrock AgentCore 运行时配送请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "Amazon Bedrock AgentCore Runtime Delivery Option",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "CompatibleServices":
                [
                  "Bedrock-AgentCore"
                ],
                "AgenticType":
                [
                  "AGENT" 
                ], 
                "Description": "Sample Description",
                "UsageInstructions": "To launch and invoke this agent on Amazon Bedrock AgentCore Runtime",
                "EnvironmentVariables":
                [
                  {
                    "Name": "HTTP_PORT",
                    "Description": "Port of the server",
                    "DefaultValue": "8080"
                  },
                  {
                    "Name": "API_KEY",
                    "Description": "Provide your unique API key here."
                  }
                ]
              }
            }
          }      
        ]
      }
    }
  ]
}

Helm图表交付请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "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}"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ]
}

亚马逊 EKS Add-On 配送请求语法

POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity": {
        "Type": "ContainerProduct@1.0",
        "Identifier": "$CreateProductChange.Entity.Identifier"
      },
      "DetailsDocument": {
        "Version": {
          "VersionTitle": "1.1",
          "ReleaseNotes": "New Add-on Release"
        },
        "DeliveryOptions": [
          {
            "DeliveryOptionTitle": "AWS Marketplace Test AddOn from CAPI 1",
            "Visibility": "Limited",
            "Details": {
              "EksAddOnDeliveryOptionDetails": {
                "ContainerImages": [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
                "Description": "Description for delivery option provided by ISV",
                "UsageInstructions": "Usage instructions with launch instructions",
                "AddOnName": "aws-mp-test",
                "AddOnVersion": "1.2.1",
                "AddOnType": "networking",
                "CompatibleKubernetesVersions": [
                  "1.25",
                  "1.26"
                ],
                "SupportedArchitectures": [
                  "amd64",
                  "arm64"
                ],
                "Namespace": "my-test-namespace",
                "EnvironmentOverrideParameters": [
                  {
                    "Key": "cluster-name",
                    "Value": "${AWS_EKS_CLUSTER_NAME}"
                  },
                  {
                    "Key": "region-name",
                    "Value": "${AWS_REGION}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ChangeName": "PublishAddonNew"
    }
  ]
}

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

响应语法

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

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

变更请求将被添加到队列中并进行处理，包括扫描集装箱图像和其他信息，以确保其符合容器产品AWS Marketplace指南。此过程可能需要几分钟到几小时，具体取决于容器的数量和大小。

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

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

异步错误

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

更新 Amazon EKS 附加组件的可见性

您可以使用目录 API 来更新您的产品版本的 Amazon EKS 附加配送选项的可见性AWS Marketplace。您的集装箱产品的集装箱和Helm配送选项会自动创建，其可见性状态为 “公开”。

默认情况下，当您使用 Amazon EKS 附加组件交付选项创建版本时，该版本将以 “受限” 状态发布。“受限” 状态意味着该产品并非在所有地区公开发售，供您的买家在 Amazon EKS 集群中使用和部署。您可以通过使用UpdateDeliveryOptionsVisibility更改类型调用 StartChangeSet API 操作，将交付选项的可见性从 “受限” 更新为 “公开”。DeliveryOptions Id从您的产品版本中指定与 Amazon EKS 附加配送选项相对应的。

请求语法

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptionsVisibility",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptions":
        [
          {
            "Id": "do-1234567891234567891234",
            "TargetVisibility": "Public"
          }
        ]
      }
    }
  ]
}

要添加UpdateDeliveryOptionsVisibility更改类型，请提供以下字段的信息：

响应语法

已根据您的请求创建更改集。对该请求的回复将为您提供变更集ChangeSetArn的ChangeSetId和。

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

变更请求将被添加到队列中并进行处理，包括扫描集装箱图像和其他信息，以确保其符合容器产品AWS Marketplace指南。此过程可能需要几分钟到几小时，具体取决于容器的数量和大小。

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

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

异步错误

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

创建存储库和资源

要创建基于容器的产品的新版本，您必须在存储库中AWS Marketplace拥有该版本的可用资源。您创建存储库，然后将（和）资源推送Docker（上传Helm）到存储库中。要了解如何通过创建存储库AWS Marketplace 管理门户，请参阅《AWS Marketplace卖家指南》中的添加商品的新版本。

要创建新的存储库，请StartChangeSet使用AddRepositories更改类型调用，如以下示例所示。

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddRepositories",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@1.0"
      },
      "DetailsDocument":
      {
        "Repositories":
        [
          {
            "RepositoryName": "new-repo-1",
            "RepositoryType": "ECR"
          },
          {
            "RepositoryName": "new-repo-2",
            "RepositoryType": "ECR"
          }
        ]
      }
    }
  ]
}

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

有关创建存储库的更多信息，请参阅《AWS Marketplace卖家指南》中的添加新版本。

创建一个或多个存储库后，您可以将资源添加到存储库中。有关如何将资源推送到存储库的信息，请参阅 Amazon Elastic Container Registry 用户指南中的推送镜像。有关您的一个仓库所需的特定推送命令的信息，请参阅《AWS Marketplace卖家指南》中的添加新版本。

异步错误

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

更新版本信息

您可以在中使用目录 API 更新基于容器的产品的现有版本的详细信息。AWS Marketplace

要更新基于容器的产品的现有版本，请使用UpdateDeliveryOptions更改类型调用 StartChangeSet API 操作，如以下示例所示。这会更新您指定的交付选项的详细信息以及关联的版本。您必须至少包括一个配送选项。

容器镜像传送请求语法

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

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example4-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "EcrDeliveryOptionDetails":{
                        "DeliveryOptionTitle":"New Delivery Option Title",
                        "Description":"New description",
                        "UsageInstructions":"New usage instructions",
                        "CompatibleServices":[
                           "EKS"
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

Helm图表交付请求语法

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

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example5-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "HelmDeliveryOptionDetails":{
                        "DeliveryOptionTitle":"New Delivery Option Title",
                        "ContainerImages":[
                           "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/imagename:1.0"
                        ],
                        "HelmChartUri":"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/helmname:1.0",
                        "CompatibleServices":[
                           "EKS-Anywhere"
                        ],
                        "Description":"New description",
                        "UsageInstructions":"New usage instructions",
                        "MarketplaceServiceAccountName":"new-service-account-name",
                        "ReleaseName":"new-release-name",
                        "Namespace":"new-cluster-namespace",
                        "OverrideParameters":[
                           {
                              "Key":"new.parameter.key",
                              "DefaultValue":"New parameter default value"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

亚马逊 EKS Add-On 配送请求语法

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

{
   "Catalog":"AWSMarketplace",
   "ChangeSet":[
      {
         "ChangeType":"UpdateDeliveryOptions",
         "Entity":{
            "Identifier":"example1-abcd-1234-5ef6-7890abcdef12",
            "Type":"ContainerProduct@1.0"
         },
         "DetailsDocument":{
            "Version":{
               "ReleaseNotes":"New release notes",
               "VersionTitle":"Version 1.2"
            },
            "DeliveryOptions":[
               {
                  "Id":"example4-2222-cccc-2222-cccccccccccc",
                  "Details":{
                     "EksAddOnDeliveryOptionDetails":{
                        "ContainerImages":[
                           "709825985650.dkr.ecr.us-east-1.amazonaws.com/test-seller/canary-test-repo-product-6:mongo"
                        ],
                        "Description":"Description for delivery option provided by ISV",
                        "UsageInstructions":"Usage instructions with launch instructions",
                        "HelmChartUri":"709825985650.dkr.ecr.us-east-1.amazonaws.com/rocket/rocket-product-helm:1.0",
                        "AddOnName":"aws-mp-test",
                        "AddOnVersion":"1.2.1",
                        "AddOnType":"networking",
                        "CompatibleKubernetesVersions":[
                           "1.19",
                           "1.20"
                        ],
                        "SupportedArchitectures":[
                           "amd64",
                           "arm64"
                        ],
                        "Namespace":"my-test-namespace",
                        "EnvironmentOverrideParameters":[
                           {
                              "Key":"my-field",
                              "Value":"${AWS_EKS_CLUSTER_NAME}"
                           }
                        ]
                     }
                  }
               }
            ]
         }
      }
   ]
}

为要添加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获取变更请求状态的更多信息，请参阅使用变更集。

限制版本

您可以使用目录 API 在中限制基于容器的产品的某个版本。AWS Marketplace这会阻止新买家使用该版本。产品中必须至少有一个公开版本。您不能限制产品唯一剩余的公开可用版本。

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

请求语法

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12",
        "Type": "ContainerProduct@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"
}

变更请求被添加到队列中并进行处理。此过程可能需要几分钟到几小时。

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

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

异步错误

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