通过

作业状态并通过 API 检索专用产品/服务详细信息

  • 项目

本文包含通过合作伙伴中心 API 检查状态和检索专用产品/服务详细信息的方法。

查询现有作业的状态

使用此方法查询现有作业的状态。 可以按最大频率为每分钟一个请求的轮询间隔轮询现有作业的状态。

请求

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>/status?$version=2022-07-01

请求头

标头 类型 说明
授权 字符串 必需。 表单中的 Bearer <token>Microsoft Entra 访问令牌。

请求参数

  • jobId - 必需。 这是要查询其状态的作业的 ID。 它在先前请求创建、删除、撤销或升级专属套餐期间生成的响应数据中提供。
  • $version - 必需。 这是请求中使用的架构的版本。

请求正文

此方法没有可用的请求正文。

响应

已完成的作业有三个可能的响应：

jobResult 说明
正在运行 作业尚未完成。
成功 作业已成功完成。 这还会返回一个 resourceURI，该资源引用与作业相关的产品/服务。 使用此 resourceURI 获取产品/服务的完整详细信息。
已失败 作业失败。 这也将返回任何相关错误，以帮助确定故障原因。

示例输出

正在运行

JSON
{
    "$schema": "https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "running",
    "jobResult": "pending",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "2021-12-21T21:30:10.3649551Z",
    "errors": []
}

已成功

{
    "$schema": " https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "b3f49dff-381f-480d-a10e-17f4ce49b65f",
    "jobStatus": "completed",
    "jobResult": "succeeded",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "2021-12-21T21:30:10.3649551Z",
    "resourceUri": "https://product-ingestion.mp.microsoft.com/configure/b3f49dff-381f-480d-a10e-17f4ce49b65f",
    "errors": []
}

注意

如果作业是由删除专属套餐的请求创建的，则响应中不会有 resourceURI。

失败

{
    "$schema": " https://schema.mp.microsoft.com/schema/configure-status/2022-07-01",
    "jobId": "c32dd7e8-8619-462d-a96b-0ac1974bace5",
    "jobStatus": "completed",
    "jobResult": "failed",
    "jobStart": "2021-12-21T21:29:54.9702903Z",
    "jobEnd": "2021-12-21T21:30:10.3649551Z",
    "errors": [
        {
            "code": "Conflict",
            "message": "The start date should be defined"
        }
    ]
}

错误代码

错误代码 说明
401 身份验证错误：确保使用有效的Microsoft Entra 访问令牌。

获取现有专用产品/服务的详细信息

有两种方法可以执行此操作，具体取决于是拥有 resourceURI 还是专属套餐 ID。

请求

GET https://graph.microsoft.com/rp/product-ingestion/private-offer/<id>?$ version=2023-07-15

或

GET https://graph.microsoft.com/rp/product-ingestion/configure/<jobId>?$version=2023-07-15

请求头

标头 类型 说明
授权 字符串 必需。 表单中的 Bearer <token>Microsoft Entra 访问令牌。

请求参数

  • ID - 必需。 这是你希望获取其完整详细信息的专属套餐的 ID。 此 ID 在上一个请求期间生成的响应数据中可用，以使用 jobId 获取现有多方专用产品/服务的详细信息。

  • jobId - 必需。 这是需要其完整详细信息的作业的 ID。 此 ID 在先前请求创建、删除、撤销或升级专属套餐期间生成的响应数据中提供。

  • $version - 必需。 这是请求中使用的架构的版本

请求正文

请勿为此方法提供请求正文。

响应

你将收到专属套餐的完整详细信息。 下面是在查询多方专用产品/服务时频道合作伙伴调用方的示例。

{
    "id": "private-offer/30b90a6a-df19-43cc-a107-b0c62057da6d",
    "name": "mpo_api_test",
    "privateOfferType": "multiPartyPromotionChannelPartner",
    "offerPricingType": "editExistingOfferPricingOnly",
    "variableStartDate": true,
    "end": "2023-01-31",
    "acceptBy": "2023-01-21",
    "notificationContacts": [],
    "state": "draft",
    "originatorTermsAndConditionsDocs": [
        {
            "sasUrl": "https://promotionpmeprod.blob.core.windows.net/promotionsblobdata/44c2b38a-fa64-4861-806c-6c486ec19b6d-769f3960-45af-42db-ab3b-6391841683d6",
            "fileName": "test.pdf",
            "customerFacingDocumentName": "test1"}],
    "termsAndConditionsDocs": [],
    "beneficiaries": [
        {
            "id": "ac357579-e860-54a6-80b3-66958aea67fe:7471d04e-f696-4d20-af34-fa78d51e419c_2019-05-31",
            "description": "beneficiary Id"}],
    "partners": [
        {
            "id": "12345678",
            "partnerName": "Market Place Test",
            "location": "United States" }],
    "originatorPricing": [
        {
            "product": "product/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03",
            "productName": "mpo_test_saas_site_1",
            "plan": "plan/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03/570ebda0-467b-4ac3-a0d8-069131afd7ee",
            "planName": "MPO Site 1 - LTS 2",
            "discountType": "absolute",
            "priceDetails": "price-and-availability-private-offer-plan/11775d67-fb2b-46bf-ad0f-0e1d5e74ba03/2152924500014081860"},
        {
            "product": "product/6c73a19b-ba11-496c-b38b-1d4a3cc64d91",
            "productName": "mpo_test_vmsr",
            "plan": "plan/6c73a19b-ba11-496c-b38b-1d4a3cc64d91/24f34f12-df93-4a7b-93d7-d9336e02d44e",
            "planName": "MPO VMSR 4",
            "discountType": "percentage",
            "discountPercentage": 2.0 }],
    "lastModified": "2023-01-19",
    "eTag": "\"7d02cb1b-0000-0800-0000-63c9aee80000\"",
    "$schema": "https://schema.mp.microsoft.com/schema/private-offer/2023-07-15"
}

错误代码

HTTP 状态代码 说明
401 身份验证错误：确保使用有效的Microsoft Entra 访问令牌。
404 找不到资源。 确保在请求中使用正确的 ID。

相关内容