Операция GetSearchableMailboxesGetSearchableMailboxes operation

Важно!

Начиная с 1 апреля 2020, операция GetSearchableMailboxes больше не будет доступна в Exchange Online.Starting on April 1, 2020, the GetSearchableMailboxes operation will no longer be available in Exchange Online. Эта операция не будет затронута в локальных версиях Exchange Server.This operation won't be affected in on-premises versions of Exchange Server. Дополнительные сведения см. в статье выбытие средств прежних версий электронных данных в Exchange Online.For more information, see Retirement of legacy eDiscovery tools in Exchange Online.

Поиск сведений о GetSearchableMailboxesной операции EWS.Find information about the GetSearchableMailboxes EWS operation.

Операция GetSearchableMailboxes получает набор почтовых ящиков с возможностью поиска для поиска при обнаружении.The GetSearchableMailboxes operation gets a scoped set of searchable mailboxes for discovery searches. Область получаемых в ответе почтовых ящиков с возможностью поиска определяется фильтром поиска и развернутой группой рассылки.The scope of searchable mailboxes returned in the response is determined by the search filter and whether distribution group membership is expanded.

Примечание

Эта операция предназначена для использования с фильтром поиска и извлечения только первых тысяч; Он не предназначен для получения исчерпывающей информации.This operation is intended to be used with the search filter and to retrieve only the first few thousands; it's not intended for exhaustive retrieval.

Эта операция появилась в Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Использование операции GetSearchableMailboxesUsing the GetSearchableMailboxes operation

Операция GetSearchableMailboxes получает сведения о почтовых ящиках с возможностью поиска.The GetSearchableMailboxes operation gets information about searchable mailboxes. В запросе передаются следующие аргументы:The following arguments can be passed in the request:

  • SearchFilter — принимает один псевдоним электронной почты в качестве аргумента.SearchFilter - Accepts a single email alias as an argument.

  • Експандграупмембершип — указывает, развернута ли членство в группе рассылки в результатах, возвращенных в ответе.ExpandGroupMembership - Indicates whether the distribution group membership is expanded in the results returned in the response.

Если набор псевдонимов электронной почты в фильтре поиска является группой рассылки, а членство в группе рассылки не развернуто, ответ будет содержать сведения о почтовом ящике для группы рассылки.If the email alias set in the search filter is a distribution group and the distribution group membership is not expanded, the response will contain the mailbox information for the distribution group. Если набор псевдонимов электронной почты в фильтре поиска является группой рассылки, а членство в группе рассылки развернуто, ответ будет содержать сведения о почтовом ящике для каждого почтового ящика, который является членом группы рассылки.If the email alias set in the search filter is a distribution group and the distribution group membership is expanded, the response will contain the mailbox information for each mailbox that is a member of the distribution group. Если фильтр поиска содержит псевдоним одного пользователя, ответ будет содержать сведения о почтовом ящике одного пользователя.If the search filter contains a single user's alias, the response will contain the mailbox information for the single user. Ответ будет содержать все почтовые ящики для поиска, если элемент GetSearchableMailboxes пуст.The response will contain all searchable mailboxes if the GetSearchableMailboxes element is empty. Это то же самое, что у пустого элемента SearchFilter , а для элемента експандграупмембершип задано значение false.This is the same as having an empty SearchFilter element and the ExpandGroupMembership element set to false.

Заголовки SOAP операции GetSearchableMailboxesGetSearchableMailboxes operation SOAP headers

Операция GetSearchableMailboxes может использовать заголовки SOAP, указанные в приведенной ниже таблице.The GetSearchableMailboxes operation can use the SOAP headers that are listed in the following table.

Имя заголовкаHeader name ЭлементElement ОписаниеDescription
ManagementRoleManagementRole
ManagementRoleManagementRole
Определяет роли сервера, необходимые для того, чтобы вызывающий абонент мог выполнить запрос.Identifies the server roles that are necessary in order for the caller to make the request. Этот заголовок является применимым для запроса.This header is applicable to a request.
рекуестверсионRequestVersion
рекуестсерверверсионRequestServerVersion
Определяет версию схемы для запроса операции.Identifies the schema version for the operation request. Этот заголовок является применимым для запроса.This header is applicable to a request.
серверверсионServerVersion
серверверсионинфоServerVersionInfo
Определяет версию сервера, который ответил на запрос.Identifies the version of the server that responded to the request. Этот заголовок является применимым для отклика.This header is applicable to a response.

Пример запроса операции GetSearchableMailboxes: запрос сведений о группе рассылкиGetSearchableMailboxes operation request example: Request information about a distribution group

В следующем примере запроса операции GetSearchableMailboxes показано, как получить сведения о почтовом ящике для группы рассылки лолграуп.The following example of a GetSearchableMailboxes operation request shows how to get the mailbox information for the lolgroup distribution group.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
      <t:RequestServerVersion Version="Exchange2013" />
   </soap:Header>
   <soap:Body >
      <m:GetSearchableMailboxes>
         <m:SearchFilter>lolgroup</m:SearchFilter>
         <m:ExpandGroupMembership>false</m:ExpandGroupMembership>
      </m:GetSearchableMailboxes>
   </soap:Body>
</soap:Envelope>

Текст SOAP Request содержит следующие элементы:The request SOAP body contains the following elements:

Успешный отклик операции GetSearchableMailboxes: получение сведений о группе рассылкиSuccessful GetSearchableMailboxes operation response: Get information about a distribution group

В следующем примере показан успешный ответ на запрос операции GetSearchableMailboxes для получения сведений об обнаружении для группы рассылки лолграуп.The following example shows a successful response to a GetSearchableMailboxes operation request to get the discovery information for the lolgroup distribution group.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="526" 
                           MinorBuildNumber="0" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetSearchableMailboxesResponse ResponseClass="Success" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         <SearchableMailboxes>
            <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <Guid>33a408fe-2574-4e3b-49f5-5e1e000a3035</Guid>
               <PrimarySmtpAddress>LOLgroup@contoso.com</PrimarySmtpAddress>
               <IsExternalMailbox>false</IsExternalMailbox>
               <ExternalEmailAddress/>
               <DisplayName>LOLgroup</DisplayName>
               <IsMembershipGroup>true</IsMembershipGroup>
               <ReferenceId>/o=First/ou=Exchange(FYLT)/cn=Recipients/cn=81213b958a0b5295b13b3f02b812bf1bc-LOLgroup</ReferenceId>
            </SearchableMailbox>
         </SearchableMailboxes>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

Тело SOAP отклика содержит следующие элементы:The response SOAP body contains the following elements:

Успешный отклик операции GetSearchableMailboxes: получение сведений о расширенной группе рассылкиSuccessful GetSearchableMailboxes operation response: Get information about an expanded distribution group

В следующем примере показан успешный ответ на запрос операции GetSearchableMailboxes для получения сведений об обнаружении членов развернутой группы рассылки лолграуп.The following example shows a successful response to a GetSearchableMailboxes operation request to get the discovery information about members of the expanded lolgroup distribution group.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="526" MinorBuildNumber="0" Version="Exchange2013" xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" xmlns="https://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetSearchableMailboxesResponse ResponseClass="Success" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <SearchableMailboxes>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>e2d42cdf-a227-1ec3-486b-6fa0ebaadb9f5</Guid>
          <PrimarySmtpAddress>JSmith@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Julia Smith</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=0a1fc86f883846152405d60956dd02e7-Julia</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>45d0fff1-6541-459a-a343-52453b30e12ca</Guid>
          <PrimarySmtpAddress>LMoore@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Laura Moore</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=2910d8f8316f4378bbf9338d8f9d714b-Laura</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>3c620d04-8b33-435a-95be-5b939375576</Guid>
          <PrimarySmtpAddress>SBrown@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Steven Brown</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=90312341a742f0e47e392c80a60d13ecf-Steve</ReferenceId>
        </SearchableMailbox>
      </SearchableMailboxes>
    </GetSearchableMailboxesResponse>
  </s:Body>
</s:Envelope>

Тело SOAP отклика содержит следующие элементы:The response SOAP body contains the following elements:

Ответ об ошибке операции GetSearchableMailboxesGetSearchableMailboxes operation error response

В следующем примере показан ответ об ошибке для запроса операции GetSearchableMailboxes .The following example shows an error response to a GetSearchableMailboxes operation request. Это ответ на запрос на получение всех почтовых ящиков, для которых выполняется поиск, если для аргумента експандграупмембершип задано значение true.This is a response to a request to get all searchable mailboxes when the ExpandGroupMembership argument is set to true.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="526"
                           MinorBuildNumber="0" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetSearchableMailboxesResponse ResponseClass="Error" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <MessageText>Cannot use wildcard or empty query when auto group expansion is enabled.</MessageText>
         <ResponseCode>ErrorInvalidArgument</ResponseCode>
         <DescriptiveLinkKey>0</DescriptiveLinkKey>
         <SearchableMailboxes/>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

Основной текст сообщения об ошибке SOAP содержит следующие элементы:The error response SOAP body contains the following elements:

Дополнительные коды ошибок, которые являются общими для EWS и специфичными для этой операции, можно найти в разделе респонсекоде.For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.

См. такжеSee also