Replicas - List By Server
列出指定伺服器的所有複本。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/replicas?api-version=2023-12-30
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
server
|
path | True |
string |
伺服器的名稱。 Regex 模式: |
subscription
|
path | True |
string uuid |
目標訂用帳戶的標識碼。 此值必須是 UUID。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
List replicas for a server
範例要求
範例回覆
{
"value": [
{
"sku": {
"name": "Standard_D2ds_v4",
"tier": "GeneralPurpose"
},
"properties": {
"administratorLogin": "cloudsa",
"storage": {
"storageSizeGB": 20,
"iops": 360,
"autoGrow": "Enabled",
"storageSku": "Premium_LRS"
},
"version": "5.7",
"state": "Ready",
"fullyQualifiedDomainName": "mysqltestserver-repl.orcabrci-seas1-a.mscds.com",
"sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
"availabilityZone": "1",
"replicationRole": "Replica",
"replicaCapacity": 0,
"network": {
"publicNetworkAccess": "Enabled"
},
"backup": {
"backupRetentionDays": 7,
"geoRedundantBackup": "Disabled",
"earliestRestoreDate": "2021-06-24T08:19:18.00+00:00"
},
"highAvailability": {
"mode": "Disabled",
"state": "NotEnabled"
}
},
"location": "Southeast Asia",
"tags": {
"num": "1"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl",
"name": "mysqltestserver-repl",
"type": "Microsoft.DBforMySQL/flexibleServers"
},
{
"sku": {
"name": "Standard_D2ds_v4",
"tier": "GeneralPurpose"
},
"properties": {
"administratorLogin": "cloudsa",
"storage": {
"storageSizeGB": 20,
"iops": 360,
"autoGrow": "Enabled",
"storageSku": "Premium_LRS"
},
"version": "5.7",
"state": "Ready",
"fullyQualifiedDomainName": "mysqltestserver-repl2.orcabrci-seas1-a.mscds.com",
"sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver",
"availabilityZone": "1",
"replicationRole": "Replica",
"replicaCapacity": 0,
"network": {
"publicNetworkAccess": "Enabled"
},
"backup": {
"backupRetentionDays": 7,
"geoRedundantBackup": "Disabled",
"earliestRestoreDate": "2021-06-23T08:19:18.00+00:00"
},
"highAvailability": {
"mode": "Disabled",
"state": "NotEnabled"
}
},
"location": "Southeast Asia",
"tags": {
"num": "1"
},
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestserver-repl2",
"name": "mysqltestserver-repl",
"type": "Microsoft.DBforMySQL/flexibleServers"
}
]
}
定義
名稱 | Description |
---|---|
Backup |
伺服器的記憶體配置檔屬性 |
created |
建立資源的身分識別類型。 |
Create |
建立新 MySQL 伺服器的模式。 |
Data |
Cmk 的日期加密。 |
Data |
密鑰類型:啟用 cmk 的 AzureKeyVault、停用 cmk 的 SystemManaged。 |
Enable |
列舉,指出值是 'Enabled' 或 'Disabled' |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
High |
伺服器的高可用性屬性 |
High |
伺服器的高可用性模式。 |
High |
伺服器高可用性的狀態。 |
Import |
匯入來源相關屬性。 |
Import |
匯入來源的儲存類型。 |
Maintenance |
伺服器的維護期間。 |
Managed |
受控服務識別的類型。 |
My |
伺服器帳單相關信息屬性。 |
Network |
伺服器的網路相關屬性 |
Private |
私人端點資源。 |
Private |
私人端點聯機資源。 |
Private |
目前的布建狀態。 |
Private |
私人端點連線狀態。 |
Private |
服務取用者與提供者之間連線狀態的相關信息集合。 |
Replication |
複寫角色。 |
Server |
表示伺服器。 |
Server |
伺服器清單。 |
Server |
特定 SKU 的層級,例如 GeneralPurpose。 |
Server |
伺服器的狀態。 |
Server |
伺服器的版本。 |
Storage |
伺服器的記憶體配置檔屬性 |
system |
與建立和上次修改資源相關的元數據。 |
Backup
伺服器的記憶體配置檔屬性
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
backupIntervalHours |
integer |
伺服器的備份間隔時數。 |
|
backupRetentionDays |
integer |
伺服器的備份保留天數。 |
|
earliestRestoreDate |
string |
最早的還原點建立時間 (ISO8601 格式) |
|
geoRedundantBackup | Disabled |
是否啟用異地備援備份。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
建立新 MySQL 伺服器的模式。
名稱 | 類型 | Description |
---|---|---|
Default |
string |
|
GeoRestore |
string |
|
PointInTimeRestore |
string |
|
Replica |
string |
DataEncryption
Cmk 的日期加密。
名稱 | 類型 | Description |
---|---|---|
geoBackupKeyURI |
string |
異地備份密鑰 URI,因為密鑰保存庫無法跨區域,需要在與異地備份相同的區域中使用 Cmk |
geoBackupUserAssignedIdentityId |
string |
異地備份使用者身分識別資源標識符,因為身分識別無法跨區域,需要與異地備份相同的區域中的身分識別 |
primaryKeyURI |
string |
主鍵 URI |
primaryUserAssignedIdentityId |
string |
主要使用者身分識別資源標識碼 |
type |
密鑰類型:適用於 enable cmk 的 AzureKeyVault、適用於停用 cmk 的 SystemManaged。 |
DataEncryptionType
密鑰類型:啟用 cmk 的 AzureKeyVault、停用 cmk 的 SystemManaged。
名稱 | 類型 | Description |
---|---|---|
AzureKeyVault |
string |
|
SystemManaged |
string |
EnableStatusEnum
列舉,指出值是 'Enabled' 或 'Disabled'
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
HighAvailability
伺服器的高可用性屬性
名稱 | 類型 | Description |
---|---|---|
mode |
伺服器的高可用性模式。 |
|
standbyAvailabilityZone |
string |
待命伺服器的可用性區域。 |
state |
伺服器高可用性的狀態。 |
HighAvailabilityMode
伺服器的高可用性模式。
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
SameZone |
string |
|
ZoneRedundant |
string |
HighAvailabilityState
伺服器高可用性的狀態。
名稱 | 類型 | Description |
---|---|---|
CreatingStandby |
string |
|
FailingOver |
string |
|
Healthy |
string |
|
NotEnabled |
string |
|
RemovingStandby |
string |
ImportSourceProperties
匯入來源相關屬性。
名稱 | 類型 | Description |
---|---|---|
dataDirPath |
string |
記憶體中資料目錄的相對路徑。 |
sasToken |
string |
用來存取來源記憶體的 Sas 令牌。 SAS 令牌需要讀取和列出許可權。 |
storageType |
匯入來源的儲存類型。 |
|
storageUrl |
string |
匯入來源記憶體的 URI。 |
ImportSourceStorageType
匯入來源的儲存類型。
名稱 | 類型 | Description |
---|---|---|
AzureBlob |
string |
MaintenanceWindow
伺服器的維護期間。
名稱 | 類型 | Description |
---|---|---|
customWindow |
string |
指出是否啟用或停用自定義視窗 |
dayOfWeek |
integer |
維護時段的星期數 |
startHour |
integer |
維護時段的開始時間 |
startMinute |
integer |
維護時段的開始分鐘 |
ManagedServiceIdentityType
受控服務識別的類型。
名稱 | 類型 | Description |
---|---|---|
UserAssigned |
string |
MySQLServerSku
伺服器帳單相關信息屬性。
名稱 | 類型 | Description |
---|---|---|
name |
string |
sku 的名稱,例如Standard_D32s_v3。 |
tier |
特定 SKU 的層,例如 GeneralPurpose。 |
Network
伺服器的網路相關屬性
名稱 | 類型 | Description |
---|---|---|
delegatedSubnetResourceId |
string |
用來設定伺服器的 vnet 的委派子網資源標識碼。 |
privateDnsZoneResourceId |
string |
私用 DNS 區域資源標識碼。 |
publicNetworkAccess |
是否允許此伺服器的公用網路存取。 當伺服器具有 VNet 整合時,值為 『Disabled』。 |
PrivateEndpoint
私人端點資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點的ARM標識碼。 |
PrivateEndpointConnection
私人端點聯機資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
name |
string |
資源的名稱 |
properties.groupIds |
string[] |
私人端點資源的群組標識碼。 |
properties.privateEndpoint |
私人端點資源。 |
|
properties.privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
properties.provisioningState |
私人端點聯機資源的布建狀態。 |
|
systemData |
Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProvisioningState
目前的布建狀態。
名稱 | 類型 | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
私人端點連線狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
服務取用者與提供者之間連線狀態的相關信息集合。
名稱 | 類型 | Description |
---|---|---|
actionsRequired |
string |
訊息,指出服務提供者上的變更是否需要在取用者上進行任何更新。 |
description |
string |
連接核准/拒絕的原因。 |
status |
指出服務擁有者是否已核准/拒絕/移除連線。 |
ReplicationRole
複寫角色。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
Replica |
string |
|
Source |
string |
Server
表示伺服器。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
identity.principalId |
string |
KeyVault 中的 ObjectId |
identity.tenantId |
string |
KeyVault 中的 TenantId |
identity.type |
受控服務識別的類型。 |
|
identity.userAssignedIdentities |
object |
使用者指派身分識別的元數據。 |
location |
string |
資源所在的地理位置 |
name |
string |
資源的名稱 |
properties.administratorLogin |
string |
伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時才能指定。 |
properties.administratorLoginPassword |
string |
伺服器建立) 所需的系統管理員登入密碼 (。 |
properties.availabilityZone |
string |
伺服器的可用性區域資訊。 |
properties.backup |
備份伺服器的相關屬性。 |
|
properties.createMode |
建立新 MySQL 伺服器的模式。 |
|
properties.dataEncryption |
CMK 的數據加密。 |
|
properties.fullyQualifiedDomainName |
string |
伺服器的完整功能變數名稱。 |
properties.highAvailability |
伺服器的高可用性相關屬性。 |
|
properties.importSourceProperties |
從記憶體匯入的來源屬性。 |
|
properties.maintenanceWindow |
伺服器的維護期間。 |
|
properties.network |
伺服器的網路相關屬性。 |
|
properties.privateEndpointConnections |
伺服器的 PrivateEndpointConnections 相關屬性。 |
|
properties.replicaCapacity |
integer |
主伺服器可以擁有的最大複本數目。 |
properties.replicationRole |
複寫角色。 |
|
properties.restorePointInTime |
string |
還原點建立時間 (ISO8601 格式) ,指定要從中還原的時間。 |
properties.sourceServerResourceId |
string |
來源 MySQL 伺服器識別碼。 |
properties.state |
伺服器的狀態。 |
|
properties.storage |
伺服器的記憶體相關屬性。 |
|
properties.version |
伺服器版本。 |
|
sku |
伺服器的 SKU (定價層) 。 |
|
systemData |
Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。 |
|
tags |
object |
資源標籤。 |
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
ServerListResult
伺服器清單。
名稱 | 類型 | Description |
---|---|---|
nextLink |
string |
用來取得下一頁作業的連結。 |
value |
Server[] |
伺服器清單 |
ServerSkuTier
特定 SKU 的層級,例如 GeneralPurpose。
名稱 | 類型 | Description |
---|---|---|
Burstable |
string |
|
GeneralPurpose |
string |
|
MemoryOptimized |
string |
ServerState
伺服器的狀態。
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Updating |
string |
ServerVersion
伺服器的版本。
名稱 | 類型 | Description |
---|---|---|
5.7 |
string |
|
8.0.21 |
string |
Storage
伺服器的記憶體配置檔屬性
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
autoGrow | Disabled |
啟用記憶體自動成長。 |
|
autoIoScaling | Enabled |
啟用 IO 自動調整。 |
|
iops |
integer |
伺服器的記憶體 IOPS。 |
|
logOnDisk | Disabled |
啟用登入磁碟。 |
|
storageSizeGB |
integer |
伺服器允許的記憶體大小上限。 |
|
storageSku |
string |
伺服器記憶體的 SKU 名稱。 |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |