Sdílet prostřednictvím

Servers - Get

  • Reference
Služba:
Cosmos DB for PostgreSQL
Verze rozhraní API:
2023-03-02-preview

Získá informace o serveru v clusteru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
clusterName
 path True

string

Název clusteru.

Vzor regulárního výrazu: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$
resourceGroupName
 path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serverName
 path True

string

Název serveru.

Vzor regulárního výrazu: ^[-\w\._]+$
subscriptionId
 path True

string

uuid

ID cílového předplatného. Hodnota musí být UUID.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

ClusterServer

OK
Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Zosobněte svůj uživatelský účet.

Příklady

Get the server of cluster

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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
  }
}

Definice

Name Description
ClusterServer

Představuje server v clusteru.
createdByType

Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorDetail

Podrobnosti o chybě
ErrorResponse

Chybová odpověď
ServerRole

Role serveru.
systemData

Metadata týkající se vytvoření a poslední změny prostředku.

ClusterServer

Představuje server v clusteru.

Name Typ Description
id

string

Plně kvalifikované ID prostředku Například /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{název_poskytovatele_prostředku}/{typ_prostředku}/{název_prostředku}.
name

string

Název prostředku
properties.administratorLogin

string

Přihlašovací jméno správce serverů v clusteru.
properties.availabilityZone

string

Informace o zóně dostupnosti serveru.
properties.citusVersion

string

Verze serveru rozšíření Citus.
properties.enableHa

boolean

Jestli je pro server povolená vysoká dostupnost nebo ne.
properties.enablePublicIpAccess

boolean

Pokud je na serveru povolený veřejný přístup.
properties.fullyQualifiedDomainName

string

Plně kvalifikovaný název domény serveru.
properties.haState

string

Stav funkce vysoké dostupnosti pro cluster.
properties.isReadOnly

boolean

Pokud je serverová databáze nastavená na jen pro čtení údržbou systému v závislosti na vysokém využití místa na disku.
properties.postgresqlVersion

string

Hlavní verze serveru PostgreSQL.
properties.role

ServerRole

Role serveru v clusteru.
properties.serverEdition

string

Edice serveru.
properties.state

string

Stav clusteru nebo serveru, který je viditelný pro uživatele.
properties.storageQuotaInMb

integer

Úložiště serveru v MB.
properties.vCores

integer

Počet virtuálních jader serveru.
systemData

systemData

Azure Resource Manager metadata obsahující informace createdBy a modifiedBy.
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby
details

ErrorDetail[]

Podrobnosti o chybě.
message

string

Chybová zpráva
target

string

Cíl chyby.

ErrorResponse

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.

ServerRole

Role serveru.

Name Typ Description
Coordinator

string

Worker

string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)
createdBy

string

Identita, která vytvořila prostředek.
createdByType

createdByType

Typ identity, která prostředek vytvořila.
lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)
lastModifiedBy

string

Identita, která naposledy změnila prostředek.
lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.