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 Marketplace目錄 API 的存取控制。

請參閱下列資源：

下列主題說明如何使用目錄 API 對單一 AMI 產品、容器型產品或 SaaS 產品執行動作。

建立產品

您可以使用目錄 API，在其中建立具有識別符 （產品代碼和產品 ID) 的 AMI、容器、機器學習或 SaaS 產品文件AWS Marketplace。

您可以透過使用CreateProduct變更類型呼叫 StartChangeSet API 操作來建立處於 Draft 狀態的產品。

如果您的請求處理成功， 會為您AWS Marketplace Catalog API產生處於 Draft 狀態的產品。這是不完整的產品，買方看不到AWS Marketplace。

然後，您可以使用Update變更類型來完成建立產品程序：UpdateInformation、UpdateDimensions、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變更類型的相同限制。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

當請求完成時 （如果 Status是 SUCCEEDED)，ProductId會產生新的 。

同步驗證

下列結構描述驗證專屬於 中的CreateProduct動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的CreateProduct動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新產品詳細資訊

如果您已有產品AWS Marketplace，您可以使用目錄 API 來更新 AMI、容器、ML 或 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變更類型的欄位資訊：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。

若要檢查請求狀態，請使用 AWS Marketplace 管理入口網站或呼叫 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateInformation動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的UpdateInformation動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

新增定價維度

您可以使用 AWS Marketplace Catalog Service Actions 來新增計費定價維度，讓您能夠向使用者收取 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類型的下列欄位。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的AddDimensions動作AWS 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變更類型的下列欄位：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

同步驗證

下列結構描述驗證專屬於 中的UpdateDimensions動作AWS 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變更類型的下列欄位：

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 或呼叫 DescribeChangeSet API AWS Marketplace 管理入口網站來檢查請求的狀態。

同步驗證

下列結構描述驗證專屬於 中的RestrictDimensions動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的RestrictDimensions動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet時呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新目標組態

您可以使用目錄 API 來新增允許在 中檢視 AMI、容器、ML 或 SaaS 產品的 AWS 帳戶IDs，AWS Marketplace然後再呼叫UpdateTargeting變更類型以移至 Public 狀態。

建立新產品時，受管目錄操作 (MCO) 帳戶會自動新增至允許的帳戶清單。檢視允許的帳戶時， AWS Marketplace管理入口網站 (AMMP) 中的賣方可以看到這些 MCO 帳戶，並在 DescribeEntity API 回應的 Targeting區段中看到這些 MCO 帳戶。

若要允許檢視 AMI、容器、ML 或 SaaS 產品的 AWS 帳戶IDs，請使用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變更類型的欄位。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。

若要檢查請求狀態，請使用 AWS Marketplace 管理入口網站或呼叫 DescribeChangeSet API。

當請求完成時 （如果 Status是 SUCCEEDED)，ProductId會產生新的 。

同步驗證

下列結構描述驗證專屬於 中的UpdateTargeting動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

非同步錯誤

下列錯誤專屬於 中的DescribeChangeSet動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

更新產品可見性

您可以使用目錄 API 來更新 AMI、容器、ML 或 SaaS 產品的可見性 （也稱為生命週期狀態）AWS Marketplace。

允許的目標生命週期狀態為 Limited、 Public或 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變更類型的欄位資訊。

同步驗證

下列結構描述驗證專屬於 中的UpdateVisibility動作AWS Marketplace Catalog API。這些驗證會在您呼叫 時執行StartChangeSet。如果請求不符合下列要求，它會失敗並顯示 HTTP 回應。

觸發此變更類型後，最多可能需要 37 天才能完成。這包括AWS Marketplace賣方操作團隊需要檢閱、稽核和核准的時間。限制產品時，在AWS Marketplace賣方操作團隊開始稽核CancelChangeSet之前，您有 24 小時可以藉由呼叫 來改變主意。如需詳細資訊，請參閱CancelChangeSet。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

當請求完成時 （如果 Status是 SUCCEEDED)，ProductId會產生新的 。

非同步錯誤

下列錯誤專屬於 中的UpdateVisibility動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

發佈產品

您可以使用目錄 API 將 Draft AMI、容器、ML 或 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變更類型的欄位資訊。此變更類型不會接受任何參數承載。

回應語法

為您的請求建立變更集。對此請求的回應為您提供變更集ChangeSetIdChangeSetArn的 和 ，如下所示。

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

變更請求會新增至佇列並進行處理。這包括驗證資訊，以確保其符合AWS Marketplace準則。驗證程序可能需要幾分鐘到幾個小時。

您可以透過 檢查請求的狀態AWS Marketplace 管理入口網站，或使用 API 操作直接透過目錄 DescribeChangeSet API。

當請求完成時 （如果 Status是 SUCCEEDED)，ProductId會產生新的 。

非同步錯誤

下列錯誤專屬於 中的ReleaseProduct動作AWS Marketplace Catalog API。當您在處理變更集DescribeChangeSet之後呼叫 時，會傳回這些錯誤。如需使用 DescribeChangeSet 取得變更請求狀態的詳細資訊，請參閱 使用變更集。

尋找您的產品 ID

您必須取得產品的產品 ID，才能使用目錄 API 進行AWS Marketplace修改。有兩種方式可以尋找伺服器產品的產品 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": "" 
}

取得有關產品的其他詳細資訊

您可以使用實體 ID 搭配 DescribeEntity動作來取得產品的其他詳細資訊。

請求

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準則。視變更請求而定，此程序可能需要幾分鐘到幾天的時間。您可以透過 AWS Marketplace 管理入口網站或在目錄 API 中使用 DescribeChangeSet動作來檢查請求的狀態。如需變更集的詳細資訊，請參閱使用變更集。

若要檢查請求的狀態，請使用 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。

如果有失敗，結果可以包含兩種類型的錯誤。對於大多數錯誤，錯誤訊息會直接包含在內。不過，掃描產品是否有安全漏洞時發現錯誤，而是在 ErrorMessage 欄位中包含列出所有發現錯誤的檔案 URL。掃描時發現的錯誤具有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 可在連結的檔案中有多個找到的錯誤）。