Udostępnij za pośrednictwem


Clusters - Get

Pobiera informacje o klastrze, takim jak konfiguracja obliczeniowa i magazyn oraz metadane cyklu życia klastra, takie jak data i godzina tworzenia klastra.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
clusterName
path True

string

Nazwa klastra.

Wzorzec wyrażenia regularnego: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True

string

uuid

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

Cluster

OK

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation Personifikuj konto użytkownika.

Przykłady

Get the cluster

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "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": []
  }
}

Definicje

Nazwa Opis
AadEnabledEnum

Wskazuje, czy klaster został utworzony przy użyciu uwierzytelniania usługi AAD.

ActiveDirectoryAuth
AuthConfig

Konfiguracja uwierzytelniania klastra.

Cluster

Reprezentuje klaster.

createdByType

Typ tożsamości, która utworzyła zasób.

DataEncryption

Właściwości szyfrowania danych klastra.

DataEncryptionType
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

IdentityProperties

Opisuje tożsamość klastra.

IdentityType
MaintenanceWindow

Zaplanuj ustawienia regularnych aktualizacji klastra.

PasswordAuth
PasswordEnabledEnum

Wskazuje, czy klaster został utworzony przy użyciu hasła, czy uwierzytelniania usługi AAD.

PrivateEndpointProperty

Właściwość reprezentująca identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

PrivateLinkServiceConnectionState

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

ServerNameItem

Obiekt nazwy serwera.

SimplePrivateEndpointConnection

Połączenie prywatnego punktu końcowego.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

AadEnabledEnum

Wskazuje, czy klaster został utworzony przy użyciu uwierzytelniania usługi AAD.

Nazwa Typ Opis
disabled

string

enabled

string

ActiveDirectoryAuth

Nazwa Typ Opis
disabled

string

enabled

string

AuthConfig

Konfiguracja uwierzytelniania klastra.

Nazwa Typ Opis
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Reprezentuje klaster.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

IdentityProperties

Opisuje tożsamość klastra.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.aadAuthEnabled

AadEnabledEnum

Wskazuje, czy klaster został utworzony przy użyciu uwierzytelniania usługi AAD.

properties.administratorLogin

string

Nazwa logowania administratora serwerów w klastrze.

properties.administratorLoginPassword

string

Hasło logowania administratora. Wymagane do utworzenia.

properties.authConfig

AuthConfig

Konfiguracja uwierzytelniania klastra.

properties.citusVersion

string

Wersja rozszerzenia Citus na wszystkich serwerach klastra.

properties.coordinatorEnablePublicIpAccess

boolean

Jeśli dostęp publiczny jest włączony w koordynatorze.

properties.coordinatorServerEdition

string

Wersja serwera koordynatora (wartość domyślna: OgólnePurpose). Wymagane do utworzenia.

properties.coordinatorStorageQuotaInMb

integer

Magazyn serwera w MB. Wymagane do utworzenia. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.coordinatorVCores

integer

Liczba rdzeni wirtualnych serwera (maksymalnie: 96). Wymagane do utworzenia. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.dataEncryption

DataEncryption

Właściwości szyfrowania danych klastra.

properties.databaseName

string

Nazwa bazy danych klastra. Obsługiwana jest tylko jedna baza danych na klaster.

properties.earliestRestoreTime

string

Najwcześniejszy czas przywracania (format ISO8601) dla klastra.

properties.enableGeoBackup

boolean

Jeśli kopia zapasowa klastra jest przechowywana w innym regionie świadczenia usługi Azure oprócz kopii zapasowej przechowywanej w regionie klastra. Włączone tylko w momencie tworzenia klastra.

properties.enableHa

boolean

Jeśli wysoka dostępność jest włączona lub nie jest włączona dla klastra.

properties.enableShardsOnCoordinator

boolean

Jeśli tabele rozproszone są umieszczane na koordynatorze lub nie. Należy ustawić wartość "true" w klastrach z jednym węzłem. Wymaga ponownego równoważenia fragmentu po zmianie wartości.

properties.maintenanceWindow

MaintenanceWindow

Okno obsługi klastra.

properties.nodeCount

integer

Liczba węzłów procesu roboczego klastra. Gdy liczba węzłów wynosi 0, reprezentuje konfigurację pojedynczego węzła z możliwością tworzenia tabel rozproszonych w tym węźle. Co najmniej 2 węzły robocze reprezentują konfigurację z wieloma węzłami. Wartość liczby węzłów nie może być 1. Wymagane do utworzenia.

properties.nodeEnablePublicIpAccess

boolean

Jeśli dostęp publiczny jest włączony w węzłach roboczych.

properties.nodeServerEdition

string

Wersja serwera węzła (wartość domyślna: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

Magazyn w MB w każdym węźle roboczym. Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.nodeVCores

integer

Obliczenia w rdzeniach wirtualnych w każdym węźle roboczym (maks. 104). Aby uzyskać więcej informacji, zobacz https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.passwordEnabled

PasswordEnabledEnum

Wskazuje, czy klaster został utworzony przy użyciu hasła, czy uwierzytelniania usługi AAD.

properties.pointInTimeUTC

string

Data i godzina w formacie UTC (format ISO8601) na potrzeby przywracania klastra.

properties.postgresqlVersion

string

Główna wersja bazy danych PostgreSQL na wszystkich serwerach klastra.

properties.preferredPrimaryZone

string

Preferowana podstawowa strefa dostępności (AZ) dla wszystkich serwerów klastra.

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Połączenia prywatnego punktu końcowego dla klastra.

properties.provisioningState

string

Stan aprowizacji klastra

properties.readReplicas

string[]

Tablica klastrów replik do odczytu.

properties.serverNames

ServerNameItem[]

Lista nazw serwerów w klastrze

properties.sourceLocation

string

Region źródłowy klastra platformy Azure dla klastrów replik do odczytu.

properties.sourceResourceId

string

Identyfikator zasobu klastra źródłowego dla klastrów replik do odczytu.

properties.state

string

Stan klastra/serwera, który jest widoczny dla użytkownika.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Właściwości szyfrowania danych klastra.

Nazwa Typ Opis
primaryKeyUri

string

Identyfikator URI klucza w usłudze keyvault na potrzeby szyfrowania danych serwera podstawowego.

primaryUserAssignedIdentityId

string

Identyfikator zasobu tożsamości przypisanej przez użytkownika do użycia na potrzeby szyfrowania danych serwera podstawowego.

type

DataEncryptionType

DataEncryptionType

Nazwa Typ Opis
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

IdentityProperties

Opisuje tożsamość klastra.

Nazwa Typ Opis
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

tożsamości User-Assigned
Zestaw tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Klucze słownika userAssignedIdentities będą identyfikatorami zasobów usługi ARM w postaci: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Wartości słownika mogą być pustymi obiektami ({}) w żądaniach.

IdentityType

Nazwa Typ Opis
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Zaplanuj ustawienia regularnych aktualizacji klastra.

Nazwa Typ Opis
customWindow

string

Wskazuje, czy niestandardowe okno obsługi jest włączone, czy nie.

dayOfWeek

integer

Preferowany dzień tygodnia dla okna obsługi.

startHour

integer

Godzina rozpoczęcia w preferowanym dniu tygodnia dla okna obsługi.

startMinute

integer

Minuta początkowa w ciągu godziny rozpoczęcia okna obsługi.

PasswordAuth

Nazwa Typ Opis
disabled

string

enabled

string

PasswordEnabledEnum

Wskazuje, czy klaster został utworzony przy użyciu hasła, czy uwierzytelniania usługi AAD.

Nazwa Typ Opis
disabled

string

enabled

string

PrivateEndpointProperty

Właściwość reprezentująca identyfikator zasobu prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

Identyfikator zasobu prywatnego punktu końcowego.

PrivateEndpointServiceConnectionStatus

Stan połączenia prywatnego punktu końcowego.

Nazwa Typ Opis
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

Nazwa Typ Opis
actionsRequired

string

Komunikat wskazujący, czy zmiany dostawcy usług wymagają aktualizacji dla konsumenta.

description

string

Przyczyna zatwierdzenia/odrzucenia połączenia.

status

PrivateEndpointServiceConnectionStatus

Wskazuje, czy połączenie zostało zatwierdzone/odrzucone/usunięte przez właściciela usługi.

ServerNameItem

Obiekt nazwy serwera.

Nazwa Typ Opis
fullyQualifiedDomainName

string

W pełni kwalifikowana nazwa domeny serwera.

name

string

Nazwa serwera.

SimplePrivateEndpointConnection

Połączenie prywatnego punktu końcowego.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Nazwa zasobu

properties.groupIds

string[]

Identyfikatory grupy połączenia prywatnego punktu końcowego.

properties.privateEndpoint

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą.

systemData

systemData

Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobu (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Nazwa Typ Opis
clientId

string

Identyfikator klienta przypisanej tożsamości.

principalId

string

Identyfikator podmiotu zabezpieczeń przypisanej tożsamości.