Dela via


Clusters - Get

Hämtar information om ett kluster, till exempel beräknings- och lagringskonfiguration och metadata för klusterlivscykeln, till exempel datum och tid för skapande av kluster.

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

URI-parametrar

Name I Obligatorisk Typ Description
clusterName
path True

string

Namnet på klustret.

Reguljärt uttrycksmönster: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

uuid

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

Cluster

OK

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto.

Exempel

Get the cluster

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
AadEnabledEnum

Anger om klustret skapades med AAD-autentisering.

ActiveDirectoryAuth
AuthConfig

Autentiseringskonfiguration för ett kluster.

Cluster

Representerar ett kluster.

createdByType

Den typ av identitet som skapade resursen.

DataEncryption

Datakrypteringsegenskaperna för ett kluster.

DataEncryptionType
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

IdentityProperties

Beskriver klustrets identitet.

IdentityType
MaintenanceWindow

Schemalägg inställningar för regelbundna klusteruppdateringar.

PasswordAuth
PasswordEnabledEnum

Anger om klustret har skapats med ett lösenord eller med AAD-autentisering.

PrivateEndpointProperty

Egenskap som representerar resurs-ID för den privata slutpunkten.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

PrivateLinkServiceConnectionState

En samling information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

ServerNameItem

Namnobjektet för en server.

SimplePrivateEndpointConnection

En privat slutpunktsanslutning.

systemData

Metadata som rör skapande och senaste ändring av resursen.

UserAssignedIdentity

Egenskaper för användartilldelad identitet

AadEnabledEnum

Anger om klustret skapades med AAD-autentisering.

Name Typ Description
disabled

string

enabled

string

ActiveDirectoryAuth

Name Typ Description
disabled

string

enabled

string

AuthConfig

Autentiseringskonfiguration för ett kluster.

Name Typ Description
activeDirectoryAuth

ActiveDirectoryAuth

passwordAuth

PasswordAuth

Cluster

Representerar ett kluster.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

IdentityProperties

Beskriver klustrets identitet.

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.aadAuthEnabled

AadEnabledEnum

Anger om klustret skapades med AAD-autentisering.

properties.administratorLogin

string

Administratörens inloggningsnamn för servrarna i klustret.

properties.administratorLoginPassword

string

Lösenordet för administratörsinloggningen. Krävs för att skapa.

properties.authConfig

AuthConfig

Autentiseringskonfiguration för ett kluster.

properties.citusVersion

string

Citus-tilläggsversionen på alla klusterservrar.

properties.coordinatorEnablePublicIpAccess

boolean

Om offentlig åtkomst är aktiverad på koordinatorn.

properties.coordinatorServerEdition

string

Utgåvan av en koordinatorserver (standard: GeneralPurpose). Krävs för att skapa.

properties.coordinatorStorageQuotaInMb

integer

Lagring av en server i MB. Krävs för att skapa. Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.coordinatorVCores

integer

Antalet virtuella kärnor för en server (max: 96). Krävs för att skapa. Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.dataEncryption

DataEncryption

Datakrypteringsegenskaperna för ett kluster.

properties.databaseName

string

Klustrets databasnamn. Endast en databas per kluster stöds.

properties.earliestRestoreTime

string

Den tidigaste återställningspunkttiden (ISO8601 format) för klustret.

properties.enableGeoBackup

boolean

Om säkerhetskopiering av kluster lagras i en annan Azure-region utöver kopian av säkerhetskopian som lagras i klustrets region. Aktiveras endast när klustret skapas.

properties.enableHa

boolean

Om hög tillgänglighet (HA) är aktiverat eller inte för klustret.

properties.enableShardsOnCoordinator

boolean

Om distribuerade tabeller placeras på koordinatorn eller inte. Ska anges till "true" i kluster med en nod. Kräver horisontell ombalansering efter att värdet har ändrats.

properties.maintenanceWindow

MaintenanceWindow

Underhållsperiod för ett kluster.

properties.nodeCount

integer

Antalet arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på den noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1. Krävs för att skapa.

properties.nodeEnablePublicIpAccess

boolean

Om offentlig åtkomst är aktiverad på arbetsnoder.

properties.nodeServerEdition

string

Utgåvan av en nodserver (standard: MemoryOptimized).

properties.nodeStorageQuotaInMb

integer

Lagringen i MB på varje arbetsnod. Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.nodeVCores

integer

Beräkningen i virtuella kärnor på varje arbetsnod (max: 104). Mer information finns i https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute.

properties.passwordEnabled

PasswordEnabledEnum

Anger om klustret har skapats med ett lösenord eller med AAD-autentisering.

properties.pointInTimeUTC

string

Datum och tid i UTC (ISO8601 format) för klusteråterställning.

properties.postgresqlVersion

string

Den högre PostgreSQL-versionen på alla klusterservrar.

properties.preferredPrimaryZone

string

Önskad primär tillgänglighetszon (AZ) för alla klusterservrar.

properties.privateEndpointConnections

SimplePrivateEndpointConnection[]

Privata slutpunktsanslutningar för ett kluster.

properties.provisioningState

string

Klustrets etableringstillstånd

properties.readReplicas

string[]

Matrisen med skrivskyddade replikkluster.

properties.serverNames

ServerNameItem[]

Listan över servernamn i klustret

properties.sourceLocation

string

Azure-regionen för källklustret för skrivskyddade replikkkluster.

properties.sourceResourceId

string

Resurs-ID för källkluster för skrivskyddade replikkluster.

properties.state

string

Ett tillstånd för ett kluster/en server som är synligt för användaren.

systemData

systemData

Azure Resource Manager metadata som innehåller createdBy och modifiedBy-information.

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DataEncryption

Datakrypteringsegenskaperna för ett kluster.

Name Typ Description
primaryKeyUri

string

URI för nyckeln i nyckelvalvet för datakryptering av den primära servern.

primaryUserAssignedIdentityId

string

Resurs-ID för den användartilldelade identitet som ska användas för datakryptering av den primära servern.

type

DataEncryptionType

DataEncryptionType

Name Typ Description
AzureKeyVault

string

SystemAssigned

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

IdentityProperties

Beskriver klustrets identitet.

Name Typ Description
type

IdentityType

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned identiteter
Den uppsättning användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

IdentityType

Name Typ Description
SystemAssigned

string

UserAssigned

string

MaintenanceWindow

Schemalägg inställningar för regelbundna klusteruppdateringar.

Name Typ Description
customWindow

string

Anger om fönstret för anpassat underhåll är aktiverat eller inte.

dayOfWeek

integer

Önskad veckodag för underhållsperiod.

startHour

integer

Starta timme inom önskad veckodag för underhållsperiod.

startMinute

integer

Startminut inom starttiden för underhållsperioden.

PasswordAuth

Name Typ Description
disabled

string

enabled

string

PasswordEnabledEnum

Anger om klustret har skapats med ett lösenord eller med AAD-autentisering.

Name Typ Description
disabled

string

enabled

string

PrivateEndpointProperty

Egenskap som representerar resurs-ID för den privata slutpunkten.

Name Typ Description
id

string

Resurs-ID för den privata slutpunkten.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name Typ Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

En samling information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name Typ Description
actionsRequired

string

Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.

description

string

Anledningen till att anslutningen godkänns/avvisas.

status

PrivateEndpointServiceConnectionStatus

Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

ServerNameItem

Namnobjektet för en server.

Name Typ Description
fullyQualifiedDomainName

string

Det fullständigt kvalificerade domännamnet för en server.

name

string

Namnet på en server.

SimplePrivateEndpointConnection

En privat slutpunktsanslutning.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Namnet på resursen

properties.groupIds

string[]

Grupp-ID:t för den privata slutpunktsanslutningen.

properties.privateEndpoint

PrivateEndpointProperty

Privat slutpunkt som anslutningen tillhör.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

En samling information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

systemData

systemData

Azure Resource Manager metadata som innehåller createdBy och modifiedBy-information.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

UserAssignedIdentity

Egenskaper för användartilldelad identitet

Name Typ Description
clientId

string

Klient-ID för den tilldelade identiteten.

principalId

string

Huvud-ID för den tilldelade identiteten.