次の方法で共有

Servers - Get

サービス:
Cosmos DB for PostgreSQL
API バージョン:
2023-03-02-preview

クラスター内のサーバーに関する情報を取得します。

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

URI パラメーター

名前 / 必須 型 説明
clusterName
 path True

string

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

クラスターの名前です。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前では大文字と小文字が区別されません。
serverName
 path True

string

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

サーバーの名前。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

応答

名前 型 説明
200 OK

ClusterServer

Azure 操作は正常に完了しました。
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

Get the server of cluster

要求のサンプル

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

応答のサンプル

状態コード:
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
  }
}

定義

名前 説明
ClusterServer

クラスター内のサーバーを表します。
createdByType

リソースを作成した ID の種類。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
ServerRole

サーバーの役割。
systemData

リソースの作成と最後の変更に関連するメタデータ。

ClusterServer

Object

クラスター内のサーバーを表します。

名前 型 説明
id

string (arm-id)

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

リソースの名前
properties.administratorLogin

string

クラスター内のサーバーの管理者のログイン名。
properties.availabilityZone

string

サーバーの可用性ゾーン情報。
properties.citusVersion

string

サーバーの Citus 拡張機能バージョン。
properties.enableHa

boolean

サーバーに対して高可用性 (HA) が有効になっているかどうか。
properties.enablePublicIpAccess

boolean

サーバーでパブリック アクセスが有効になっている場合。
properties.fullyQualifiedDomainName

string

サーバーの完全修飾ドメイン名。
properties.haState

string

クラスターの HA 機能の状態。
properties.isReadOnly

boolean

高いディスク領域の使用量に応じて、システム メンテナンスによってサーバー データベースが読み取り専用に設定されている場合。
properties.postgresqlVersion

string

サーバーの PostgreSQL のメジャー バージョン。
properties.role

ServerRole

クラスター内のサーバーの役割。
properties.serverEdition

string

サーバーのエディション。
properties.state

string

ユーザーに表示されるクラスター/サーバーの状態。
properties.storageQuotaInMb

integer (int32)

サーバーのストレージ (MB 単位)。
properties.vCores

integer (int32)

サーバーの仮想コア数。
systemData

systemData

createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
type

string

リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

ServerRole

列挙

サーバーの役割。

値 説明
Coordinator
Worker

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。