你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

在适用于 FHIR 的 Azure API 中运行重编索引作业

项目
06/08/2023

在某些情况下，你可能在适用于 FHIR 的 Azure API 中有一些尚未建立索引的搜索或排序参数。在定义自己的搜索参数时，这一点很重要。在为搜索参数编制索引之前，它不能用于搜索。本文介绍如何运行重新编制索引作业，为尚未在 FHIR 服务数据库中编制索引的搜索参数编制索引。

警告

在开始之前请务必阅读整篇文章。重编索引作业可能会非常耗用性能。本文包含用于限制和控制重编索引作业的选项。

如何运行重新索引作业

可以针对整个 FHIR 服务数据库和特定的自定义搜索参数执行重新索引作业。

对整个 FHIR 服务数据库运行重新编制索引作业

若要运行重新编制索引作业，请对 POST 请求正文中的 JSON 格式 Parameters 资源使用以下调用：

POST {{FHIR URL}}/$reindex 

{ 

“resourceType”: “Parameters”,  

“parameter”: [] 

}

"parameter": []如果不需要调整分配给重新编制索引作业的资源，请将字段留空 (，如) 所示。

如果请求成功，则除了Parameters响应中的资源外，还会收到“201 已创建”状态代码。

HTTP/1.1 201 Created 
Content-Location: https://{{FHIR URL}}/_operations/reindex/560c7c61-2c70-4c54-b86d-c53a9d29495e 

{
  "resourceType": "Parameters",
  "id": "560c7c61-2c70-4c54-b86d-c53a9d29495e",
  "meta": {
    "versionId": "\"4c0049cd-0000-0100-0000-607dc5a90000\""
  },
  "parameter": [
    {
      "name": "id",
      "valueString": "560c7c61-2c70-4c54-b86d-c53a9d29495e"
    },
    {
       "name": "lastModified",
       "valueDateTime": "2023-06-08T04:52:44.0974408+00:00"
    },
    {
       "name": "queuedTime",
       "valueDateTime": "2023-06-08T04:52:44.0974406+00:00"
    },
    {
       "name": "totalResourcesToReindex",
       "valueDecimal": 0.0
    },
    {
       "name": "resourcesSuccessfullyReindexed",
       "valueDecimal": 0.0
    },
    {
       "name": "progress",
       "valueDecimal": 0.0
    },
    {
       "name": "status",
       "valueString": "Queued"
    },
    {
       "name": "maximumConcurrency",
       "valueDecimal": 3.0
    },
    {
        "name": "queryDelayIntervalInMilliseconds",
        "valueDecimal": 500.0
    },
    {
        "name": "maximumNumberOfResourcesPerQuery",
        "valueDecimal": 100.0
    }
  ]
}

针对特定的自定义搜索参数运行重新编制索引作业

若要针对特定的自定义搜索参数运行重新编制索引作业，请在请求正文中对 JSON 格式Parameters的资源使用以下POST调用：

POST {{FHIR_URL}}/$reindex 
content-type: application/fhir+json
{ 

"resourceType": "Parameters",  

"parameter": [
    {
      "name": "targetSearchParameterTypes",
      "valueString": "{url of custom search parameter. In case of multiple custom search parameters, url list can be comma seperated.}"
    }
] 

}

注意

若要检查重新编制索引作业的状态或取消该作业，需要重新编制索引 ID。这是 "id" 响应中返回的值中 "parameter" 携带的。在上面的示例中，重编索引作业的 ID 为 560c7c61-2c70-4c54-b86d-c53a9d29495e。

如何检查重编索引的状态

启动重编索引作业后，可以使用以下调用检查作业状态：

GET {{FHIR URL}}/_operations/reindex/{{reindexJobId}

示例响应：

{
    "resourceType": "Parameters",
    "id": "560c7c61-2c70-4c54-b86d-c53a9d29495e",
    "meta": {
        "versionId": "138087"
    },
    "parameter": [
        {
            "name": "id",
            "valueString": "560c7c61-2c70-4c54-b86d-c53a9d29495e"
        },
        {
            "name": "startTime",
            "valueDateTime": "2023-06-08T04:54:53.2943069+00:00"
        },
        {
            "name": "endTime",
            "valueDateTime": "2023-06-08T04:54:54.4052272+00:00"
        },
        {
            "name": "lastModified",
            "valueDateTime": "2023-06-08T04:54:54.4053002+00:00"
        },
        {
            "name": "queuedTime",
            "valueDateTime": "2023-06-08T04:52:44.0974406+00:00"
        },
        {
            "name": "totalResourcesToReindex",
            "valueDecimal": 2.0
        },
        {
            "name": "resourcesSuccessfullyReindexed",
            "valueDecimal": 2.0
        },
        {
            "name": "progress",
            "valueDecimal": 100.0
        },
        {
            "name": "status",
            "valueString": "Completed"
        },
        {
            "name": "maximumConcurrency",
            "valueDecimal": 3.0
        },
        {
            "name": "resources",
            "valueString": "{{LIST_OF_IMPACTED_RESOURCES}}"
        },
        {
            "name": "resourceReindexProgressByResource (CountReindexed of Count)",
            "valueString": "{{RESOURCE_TYPE:REINDEXED_COUNT OF TOTAL_COUNT}}"
        },
        {
            "name": "searchParams",
            "valueString": "{{LIST_OF_SEARCHPARAM_URLS}}h"
        },
        {
            "name": "queryDelayIntervalInMilliseconds",
            "valueDecimal": 500.0
        },
        {
            "name": "maximumNumberOfResourcesPerQuery",
            "valueDecimal": 100.0
        }
    ]
}

上述响应中显示了以下信息：

totalResourcesToReindex：包括在此作业中重新编制索引的资源总数。
resourcesSuccessfullyReindexed：已在此作业中重新编制索引的资源总数。
progress：重新编制作业完成百分比索引。等于 resourcesSuccessfullyReindexed/totalResourcesToReindex x 100。
status：表示重新编制索引作业是排队、正在运行、完成、失败还是已取消。
resources：列出受重新编制索引作业影响的所有资源类型。
“resourceReindexProgressByResource (CountReindexed of Count) ”：按资源类型提供总计数的重新索引计数。如果特定资源类型的重新编制索引已排队，则仅提供 Count。
“searchParams”：列出受重新索引作业影响的搜索参数的 URL。

删除重编索引作业

如果需要取消重编索引作业，请使用删除调用并指定重编索引作业 ID：

Delete {{FHIR URL}}/_operations/reindex/{{reindexJobId}

性能注意事项

重编索引作业可能会非常耗用性能。我们实现了一些限制控件，帮助你管理重编索引作业在数据库上的运行方式。

注意

重编索引作业在大型数据集上运行数天的情况并不少见。对于拥有 30 万亿个资源的数据库，我们注意到在有 10 万个 RU 的情况下为整个数据库重新编制索引需要 4-5 天的时间。

下表列出了可用参数、默认值和建议范围。可以使用这些参数加快进程（使用更多的计算）或减缓进程（使用更少的计算）。例如，可以在流量较低的时候运行重编索引作业，并增加计算以更快地完成该作业。相反，可以使用设置来确保计算的使用率非常低，并让它在后台运行几天。

参数	说明	Default	可用范围
QueryDelayIntervalInMilliseconds	重编索引作业期间启动每批资源之间的延迟。数字越小，作业速度越快，而数字越大，作业速度就越慢。	500 MS（0.5 秒）	50-500000
MaximumResourcesPerQuery	要重编索引的一批资源中包含的最大资源数。	100	1-5000
MaximumConcurrency	一次完成的批数。	1	1-10
targetDataStoreUsagePercentage	可以指定用于重编索引作业的数据存储的百分比。例如，可以指定 50%，这将确保重编索引作业最多使用 Azure Cosmos DB 上可用 RU 的 50%。	如果没有指定，则意味着最多可以使用 100%。	0-100

如果要使用上述任何参数，可以在启动重索引作业时将它们传递到参数资源。

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "maximumConcurrency",
      "valueInteger": "3"
    },
    {
      "name": "targetDataStoreUsagePercentage",
      "valueInteger": "20"
    },
    {
      "name": "queryDelayIntervalInMilliseconds",
      "valueInteger": "1000"
    },
    {
      "name": "maximumNumberOfResourcesPerQuery",
      "valueInteger": "1"
    }
  ]
}

后续步骤

在本文中，你已了解如何启动重编索引作业。要了解如何定义需要重编索引作业的新搜索参数，请参阅

定义自定义搜索参数

FHIR® 是 HL7 的注册商标，经 HL7 许可使用。