Udostępnij za pośrednictwem

Servers - Get

  • Odwołanie
Usługa:
Cosmos DB for PostgreSQL
Wersja interfejsu API:
2023-03-02-preview

Pobiera informacje o serwerze w klastrze.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}?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.
serverName
 path True

string

Nazwa serwera.

Wzorzec wyrażenia regularnego: ^[-\w\._]+$
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

ClusterServer

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 server of cluster

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
  }
}

Definicje

Nazwa Opis
ClusterServer

Reprezentuje serwer w klastrze.
createdByType

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

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

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
ServerRole

Rola serwera.
systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ClusterServer

Reprezentuje serwer w klastrze.

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.administratorLogin

string

Nazwa logowania administratora serwerów w klastrze.
properties.availabilityZone

string

Informacje o strefie dostępności serwera.
properties.citusVersion

string

Wersja rozszerzenia Citus serwera.
properties.enableHa

boolean

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

boolean

Jeśli dostęp publiczny jest włączony na serwerze.
properties.fullyQualifiedDomainName

string

W pełni kwalifikowana nazwa domeny serwera.
properties.haState

string

Stan funkcji wysokiej dostępności dla klastra.
properties.isReadOnly

boolean

Jeśli baza danych serwera jest ustawiona na tryb tylko do odczytu przez konserwację systemu w zależności od dużego użycia miejsca na dysku.
properties.postgresqlVersion

string

Główna wersja serwera PostgreSQL.
properties.role

ServerRole

Rola serwera w klastrze.
properties.serverEdition

string

Wersja serwera.
properties.state

string

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

integer

Magazyn serwera w MB.
properties.vCores

integer

Liczba rdzeni wirtualnych serwera.
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"

createdByType

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

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

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 error.

ServerRole

Rola serwera.

Nazwa Typ Opis
Coordinator

string

Worker

string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (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.