Dela via

Servers - Get

Tjänst:
Cosmos DB for PostgreSQL
API-version:
2023-03-02-preview

Hämtar information om en server i klustret.

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

URI-parametrar

Name I Obligatorisk Typ Description
clusterName
 path True

string

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

Namnet på klustret.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName
 path True

string

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

Namnet på servern.
subscriptionId
 path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.
api-version
 query True

string

minLength: 1

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

Svar

Name Typ Description
200 OK

ClusterServer

Azure-åtgärden har slutförts.
Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

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

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Get the server of cluster

Exempelbegäran

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

Exempelsvar

Statuskod:
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
  }
}

Definitioner

Name Description
ClusterServer

Representerar en server i ett kluster.
createdByType

Den typ av identitet som skapade resursen.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
ServerRole

Rollen för en server.
systemData

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

ClusterServer

Objekt

Representerar en server i ett kluster.

Name Typ Description
id

string (arm-id)

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

string

Namnet på resursen
properties.administratorLogin

string

Administratörens inloggningsnamn för servrarna i klustret.
properties.availabilityZone

string

Information om tillgänglighetszon för servern.
properties.citusVersion

string

Citus-tilläggsversionen av servern.
properties.enableHa

boolean

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

boolean

Om offentlig åtkomst är aktiverad på servern.
properties.fullyQualifiedDomainName

string

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

string

Ett tillstånd för HA-funktionen för klustret.
properties.isReadOnly

boolean

Om serverdatabasen är inställd på skrivskyddad av systemunderhåll beroende på hög diskutrymmesanvändning.
properties.postgresqlVersion

string

Den större PostgreSQL-versionen av servern.
properties.role

ServerRole

Serverns roll i klustret.
properties.serverEdition

string

Utgåvan av en server.
properties.state

string

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

integer (int32)

Lagring av en server i MB.
properties.vCores

integer (int32)

Antalet virtuella kärnor för en server.
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"

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ServerRole

Uppräkning

Rollen för en server.

Värde Description
Coordinator
Worker

systemData

Objekt

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

Name Typ Description
createdAt

string (date-time)

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string (date-time)

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.