Delen via

Servers - Get

Service:
Cosmos DB for PostgreSQL
API-versie:
2023-03-02-preview

Hiermee haalt u informatie op over een server in het cluster.

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

URI-parameters

Name In Vereist Type Description
clusterName
 path True

string

minLength: 3
maxLength: 40
pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?

De naam van het cluster.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serverName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

De naam van de server.
subscriptionId
 path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

ClusterServer

Azure-bewerking is voltooid.
Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Get the server of cluster

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/testcluster1/servers/testcluster1-c",
  "name": "testcluster1-c",
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/servers",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "fullyQualifiedDomainName": "testcluster1-c.postgres.database.azure.com",
    "postgresqlVersion": "12",
    "citusVersion": "9.5",
    "availabilityZone": "1",
    "role": "Coordinator",
    "serverEdition": "MemoryOptimized",
    "storageQuotaInMb": 10000,
    "vCores": 4,
    "enableHa": true,
    "enablePublicIpAccess": true,
    "state": "Ready",
    "haState": "Healthy",
    "administratorLogin": "citus",
    "isReadOnly": false
  }
}

Definities

Name Description
ClusterServer

Vertegenwoordigt een server in een cluster.
createdByType

Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
ServerRole

De rol van een server.
systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

ClusterServer

Object

Vertegenwoordigt een server in een cluster.

Name Type Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name

string

De naam van de resource
properties.administratorLogin

string

De aanmeldingsnaam van de beheerder van de servers in het cluster.
properties.availabilityZone

string

Informatie over de beschikbaarheidszone van de server.
properties.citusVersion

string

De Citus-extensieversie van de server.
properties.enableHa

boolean

Als hoge beschikbaarheid (HA) is ingeschakeld of niet voor de server.
properties.enablePublicIpAccess

boolean

Als openbare toegang is ingeschakeld op de server.
properties.fullyQualifiedDomainName

string

De volledig gekwalificeerde domeinnaam van een server.
properties.haState

string

Een hoge beschikbaarheidsfunctie voor het cluster.
properties.isReadOnly

boolean

Als de serverdatabase is ingesteld op alleen-lezen door systeemonderhoud, afhankelijk van het hoge schijfruimtegebruik.
properties.postgresqlVersion

string

De primaire PostgreSQL-versie van de server.
properties.role

ServerRole

De rol van de server in het cluster.
properties.serverEdition

string

De editie van een server.
properties.state

string

Een status van een cluster/server die zichtbaar is voor de gebruiker.
properties.storageQuotaInMb

integer (int32)

De opslag van een server in MB.
properties.vCores

integer (int32)

Het aantal vCores van een server.
systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

ServerRole

Inventarisatie

De rol van een server.

Waarde Description
Coordinator
Worker

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.