Поделиться через


Clusters - Get

Получает сведения о кластере, такие как конфигурация вычислений и хранилища, а также метаданные жизненного цикла кластера, такие как дата и время создания кластера.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}?api-version=2023-03-02-preview

Параметры URI

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

string

Имя кластера.

Шаблон регулярного выражения: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

uuid

Идентификатор целевой подписки. Значение должно быть UUID.

api-version
query True

string

Версия API, используемая для данной операции.

Ответы

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

Cluster

ОК

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Олицетворите учетную запись пользователя.

Примеры

Get the cluster

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

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1?api-version=2023-03-02-preview

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

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1",
  "name": "testcluster1",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "tags": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "location": "eastus",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "state": "Ready",
    "postgresqlVersion": "14",
    "citusVersion": "11.1",
    "maintenanceWindow": {
      "dayOfWeek": 0,
      "startHour": 0,
      "startMinute": 0,
      "customWindow": "Disabled"
    },
    "aadAuthEnabled": "disabled",
    "administratorLogin": "citus",
    "dataEncryption": {
      "type": "SystemManaged"
    },
    "passwordEnabled": "enabled",
    "preferredPrimaryZone": "1",
    "enableHa": false,
    "enableShardsOnCoordinator": false,
    "coordinatorServerEdition": "GeneralPurpose",
    "coordinatorStorageQuotaInMb": 2097152,
    "coordinatorVCores": 4,
    "coordinatorEnablePublicIpAccess": true,
    "databaseName": "citus",
    "nodeServerEdition": "MemoryOptimized",
    "nodeCount": 2,
    "nodeStorageQuotaInMb": 2097152,
    "nodeVCores": 8,
    "nodeEnablePublicIpAccess": false,
    "serverNames": [
      {
        "name": "testcluster1-c",
        "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w0",
        "fullyQualifiedDomainName": "testcluster1-w0.postgres.database.azure.com"
      },
      {
        "name": "testcluster1-w1",
        "fullyQualifiedDomainName": "testcluster1-w1.postgres.database.azure.com"
      }
    ],
    "sourceResourceId": null,
    "readReplicas": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-01",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSQL/serverGroupsv2/testreadreplica-02"
    ],
    "earliestRestoreTime": "2020-09-14T00:00:37.467Z",
    "privateEndpointConnections": []
  }
}

Определения

Имя Описание
AadEnabledEnum

Указывает, был ли кластер создан с использованием проверки подлинности AAD.

ActiveDirectoryAuth
AuthConfig

Конфигурация проверки подлинности кластера.

Cluster

Представляет кластер.

createdByType

Тип удостоверения, создавшего ресурс.

DataEncryption

Свойства шифрования данных кластера.

DataEncryptionType
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

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

ErrorResponse

Сообщение об ошибке

IdentityProperties

Описывает удостоверение кластера.

IdentityType
MaintenanceWindow

Планирование параметров для регулярных обновлений кластера.

PasswordAuth
PasswordEnabledEnum

Указывает, был ли кластер создан с помощью пароля или с использованием проверки подлинности AAD.

PrivateEndpointProperty

Свойство , представляющее идентификатор ресурса частной конечной точки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

ServerNameItem

Объект имени для сервера.

SimplePrivateEndpointConnection

Подключение к частной конечной точке.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

UserAssignedIdentity

Свойства удостоверения, назначаемого пользователем

AadEnabledEnum

Указывает, был ли кластер создан с использованием проверки подлинности AAD.

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

string

enabled

string

ActiveDirectoryAuth

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

string

enabled

string

AuthConfig

Конфигурация проверки подлинности кластера.

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

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Представляет кластер.

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

string

Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

IdentityProperties

Описывает удостоверение кластера.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.aadAuthEnabled

AadEnabledEnum

Указывает, был ли кластер создан с использованием проверки подлинности AAD.

properties.administratorLogin

string

Имя входа администратора для серверов в кластере.

properties.administratorLoginPassword

string

Пароль для входа администратора. Требуется для создания.

properties.authConfig

AuthConfig

Конфигурация проверки подлинности кластера.

properties.citusVersion

string

Версия расширения Citus на всех серверах кластера.

properties.coordinatorEnablePublicIpAccess

boolean

Если общий доступ включен в координаторе.

properties.coordinatorServerEdition

string

Выпуск сервера-координатора (по умолчанию: GeneralPurpose). Требуется для создания.

properties.coordinatorStorageQuotaInMb

integer

Хранилище сервера в МБ. Требуется для создания. Подробнее см. в разделе https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.coordinatorVCores

integer

Число виртуальных ядер сервера (максимум: 96). Требуется для создания. Подробнее см. в разделе https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.dataEncryption

DataEncryption

Свойства шифрования данных кластера.

properties.databaseName

string

Имя базы данных кластера. Поддерживается только одна база данных на кластер.

properties.earliestRestoreTime

string

Самая ранняя точка восстановления (ISO8601 формате) для кластера.

properties.enableGeoBackup

boolean

Если резервная копия кластера хранится в другом регионе Azure в дополнение к копии резервной копии, хранящейся в регионе кластера. Включен только во время создания кластера.

properties.enableHa

boolean

Если высокий уровень доступности (HA) включен или не включен для кластера.

properties.enableShardsOnCoordinator

boolean

Если распределенные таблицы размещены в координаторе или нет. Для кластеров с одним узлом должно быть задано значение true. Требуется перебалансировать сегменты после изменения значения.

properties.maintenanceWindow

MaintenanceWindow

Период обслуживания кластера.

properties.nodeCount

integer

Количество рабочих узлов кластера. Если число узлов равно 0, он представляет конфигурацию одного узла с возможностью создания распределенных таблиц на этом узле. 2 или более рабочих узлов представляют конфигурацию с несколькими узлами. Значение счетчика узлов не может быть равно 1. Требуется для создания.

properties.nodeEnablePublicIpAccess

boolean

Если общий доступ включен на рабочих узлах.

properties.nodeServerEdition

string

Выпуск сервера узла (по умолчанию: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

Хранилище в МБ на каждом рабочем узле. Подробнее см. в разделе https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.nodeVCores

integer

Вычислительные ресурсы в виртуальных ядрах на каждом рабочем узле (максимум: 104). Подробнее см. в разделе https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.passwordEnabled

PasswordEnabledEnum

Указывает, был ли кластер создан с помощью пароля или с использованием проверки подлинности AAD.

properties.pointInTimeUTC

string

Дата и время в формате UTC (ISO8601 формате) для восстановления кластера.

properties.postgresqlVersion

string

Основная версия PostgreSQL на всех серверах кластера.

properties.preferredPrimaryZone

string

Предпочтительная первичная зона доступности (AZ) для всех серверов кластера.

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Подключения к частной конечной точке для кластера.

properties.provisioningState

string

Состояние подготовки кластера

properties.readReplicas

string[]

Массив кластеров реплика чтения.

properties.serverNames

ServerNameItem[]

Список имен серверов в кластере

properties.sourceLocation

string

Регион Azure исходного кластера для кластеров реплика чтения.

properties.sourceResourceId

string

Идентификатор ресурса исходного кластера для кластеров реплика чтения.

properties.state

string

Состояние кластера или сервера, видимое пользователю.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

createdByType

Тип удостоверения, создавшего ресурс.

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

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Свойства шифрования данных кластера.

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

string

URI для ключа в хранилище ключей для шифрования данных сервера-источника.

primaryUserAssignedIdentityId

string

Идентификатор ресурса для удостоверения, назначаемого пользователем, который будет использоваться для шифрования данных сервера-источника.

type

DataEncryptionType

DataEncryptionType

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

string

SystemAssigned

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

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

ErrorDetail

Объект error.

IdentityProperties

Описывает удостоверение кластера.

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

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

Удостоверения User-Assigned
Набор удостоверений, назначаемых пользователем, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

IdentityType

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

string

UserAssigned

string

MaintenanceWindow

Планирование параметров для регулярных обновлений кластера.

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

string

Указывает, включен ли пользовательский период обслуживания.

dayOfWeek

integer

Предпочтительный день недели для периода обслуживания.

startHour

integer

Время начала в течение предпочтительного дня недели для периода обслуживания.

startMinute

integer

Начальная минута в пределах часа начала периода обслуживания.

PasswordAuth

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

string

enabled

string

PasswordEnabledEnum

Указывает, был ли кластер создан с помощью пароля или с использованием проверки подлинности AAD.

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

string

enabled

string

PrivateEndpointProperty

Свойство , представляющее идентификатор ресурса частной конечной точки.

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

string

Идентификатор ресурса частной конечной точки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

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

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

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

string

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе.

description

string

Причина утверждения или отклонения подключения.

status

PrivateEndpointServiceConnectionStatus

Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы.

ServerNameItem

Объект имени для сервера.

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

string

Полное доменное имя сервера.

name

string

Имя сервера.

SimplePrivateEndpointConnection

Подключение к частной конечной точке.

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

string

Полный идентификатор ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Имя ресурса.

properties.groupIds

string[]

Идентификаторы групп подключения к частной конечной точке.

properties.privateEndpoint

PrivateEndpointProperty

Частная конечная точка, к которой принадлежит подключение.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения createdBy и modifiedBy.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

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

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.

UserAssignedIdentity

Свойства удостоверения, назначаемого пользователем

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

string

Идентификатор клиента назначенного удостоверения.

principalId

string

Идентификатор субъекта назначенного удостоверения.