Domains - List Domains

Служба:
Admin
Версия API:
v1

Возвращает сведения для всех доменов.

Note

Этот API является версией предварительной версии предварительной версии из-за нерекомендуемой 31 марта 2026 г. При вызове этого API вызывающие должны задать параметр preview запроса значением. false

Permissions

Вызывающий объект должен быть администратором Fabric.

Обязательные делегированные области

Tenant.Read.All или Tenant.ReadWrite.All.

Limitations

Не более 25 запросов в одну минуту на участника.

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Identity Support
User Yes
Представитель службы и управляемые удостоверения Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}
С использованием необязательных параметров: 
GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly={nonEmptyOnly}&preview={preview}

Параметры URI

Имя В Обязательно Тип Описание
preview
 query True

boolean

Этот параметр задает используемую версию API. Установите для false использования версии выпуска.
nonEmptyOnly
 query

boolean

Если задано значение true, возвращаются только домены с хотя бы одной рабочей областью, содержащей элемент. По умолчанию: false.

Ответы

Имя Тип Описание
200 OK

DomainsResponse

Запрос успешно завершен.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • UnknownError — произошла ошибка.

Примеры

Get all non-empty domains example
Get info for all domains example

Get all non-empty domains example

Образец запроса

GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly=True&preview=false

Пример ответа

Код состояния:
200 
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "defaultLabelId": "95c04e91-79d3-4287-b282-dbd62e11f566"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null
    }
  ]
}

Get info for all domains example

Образец запроса

GET https://api.fabric.microsoft.com/v1/admin/domains?preview=false

Пример ответа

Код состояния:
200 
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "defaultLabelId": "e9d82d27-a651-49e6-a000-068f4c40dd30"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null
    },
    {
      "id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
      "displayName": "AdminsOnly",
      "description": "Admins only",
      "parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529"
    },
    {
      "id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
      "displayName": "Root",
      "description": "",
      "parentDomainId": null
    },
    {
      "id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
      "displayName": "Legal",
      "description": "This domain is used for identifying legal data and reports.",
      "parentDomainId": null
    }
  ]
}

Определения

Имя Описание
Domain
DomainsResponse

Это оболочка ответа для списка всех доменов.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.

Domain

Объект
Имя Тип Описание
defaultLabelId

string (uuid)

Метка конфиденциальности домена по умолчанию.
description

string

Описание домена.
displayName

string

Имя домена.
id

string (uuid)

Идентификатор объекта домена.
parentDomainId

string (uuid)

Идентификатор родительского объекта домена.

DomainsResponse

Объект

Это оболочка ответа для списка всех доменов.

Имя Тип Описание
domains

Domain[]

Список доменов.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.