你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
server
|
path | True |
string |
服务器的名称。 正则表达式模式: |
subscription
|
path | True |
string uuid |
目标订阅的 ID。 该值必须是 UUID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
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"
}
]
}
定义
名称 | 说明 |
---|---|
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
服务器的存储配置文件属性
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
backupIntervalHours |
integer |
服务器的备份间隔小时数。 |
|
backupRetentionDays |
integer |
服务器的备份保留天数。 |
|
earliestRestoreDate |
string |
最早的还原点创建时间 (ISO8601 格式) |
|
geoRedundantBackup | Disabled |
是否启用异地冗余备份。 |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CreateMode
创建新 MySQL 服务器的模式。
名称 | 类型 | 说明 |
---|---|---|
Default |
string |
|
GeoRestore |
string |
|
PointInTimeRestore |
string |
|
Replica |
string |
DataEncryption
cmk 的日期加密。
名称 | 类型 | 说明 |
---|---|---|
geoBackupKeyURI |
string |
异地备份密钥 URI 作为密钥保管库不能跨区域,需要与异地备份位于同一区域中的 cmk |
geoBackupUserAssignedIdentityId |
string |
异地备份用户标识资源 ID 作为标识不能跨区域,需要标识与异地备份位于同一区域中 |
primaryKeyURI |
string |
主键 URI |
primaryUserAssignedIdentityId |
string |
主要用户标识资源 ID |
type |
密钥类型,启用 cmk 的 AzureKeyVault,禁用 cmk 的 SystemManaged。 |
DataEncryptionType
密钥类型,启用 cmk 的 AzureKeyVault,禁用 cmk 的 SystemManaged。
名称 | 类型 | 说明 |
---|---|---|
AzureKeyVault |
string |
|
SystemManaged |
string |
EnableStatusEnum
用于指示值是“Enabled”还是“Disabled”的枚举
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
HighAvailability
服务器的高可用性属性
名称 | 类型 | 说明 |
---|---|---|
mode |
服务器的高可用性模式。 |
|
standbyAvailabilityZone |
string |
备用服务器的可用性区域。 |
state |
服务器高可用性的状态。 |
HighAvailabilityMode
服务器的高可用性模式。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
SameZone |
string |
|
ZoneRedundant |
string |
HighAvailabilityState
服务器高可用性的状态。
名称 | 类型 | 说明 |
---|---|---|
CreatingStandby |
string |
|
FailingOver |
string |
|
Healthy |
string |
|
NotEnabled |
string |
|
RemovingStandby |
string |
ImportSourceProperties
导入与源相关的属性。
名称 | 类型 | 说明 |
---|---|---|
dataDirPath |
string |
存储中数据目录的相对路径。 |
sasToken |
string |
用于访问源存储的 Sas 令牌。 sas 令牌需要读取和列出权限。 |
storageType |
导入源的存储类型。 |
|
storageUrl |
string |
导入源存储的 URI。 |
ImportSourceStorageType
导入源的存储类型。
名称 | 类型 | 说明 |
---|---|---|
AzureBlob |
string |
MaintenanceWindow
服务器的维护时段。
名称 | 类型 | 说明 |
---|---|---|
customWindow |
string |
指示是启用或禁用自定义窗口 |
dayOfWeek |
integer |
维护时段的星期数 |
startHour |
integer |
维护时段的开始时间 |
startMinute |
integer |
维护时段的开始分钟数 |
ManagedServiceIdentityType
托管服务标识的类型。
名称 | 类型 | 说明 |
---|---|---|
UserAssigned |
string |
MySQLServerSku
服务器的计费信息相关属性。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
SKU 的名称,例如Standard_D32s_v3。 |
tier |
特定 SKU 的层,例如 GeneralPurpose。 |
Network
服务器的网络相关属性
名称 | 类型 | 说明 |
---|---|---|
delegatedSubnetResourceId |
string |
用于为服务器设置 vnet 的委托子网资源 ID。 |
privateDnsZoneResourceId |
string |
专用 DNS区域资源 ID。 |
publicNetworkAccess |
是否允许此服务器访问公用网络。 当服务器具有 VNet 集成时,值为“禁用”。 |
PrivateEndpoint
专用终结点资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
专用终结点的 ARM 标识符。 |
PrivateEndpointConnection
专用终结点连接资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
name |
string |
资源的名称 |
properties.groupIds |
string[] |
专用终结点资源的组 ID。 |
properties.privateEndpoint |
专用终结点资源。 |
|
properties.privateLinkServiceConnectionState |
有关服务使用者与提供程序之间的连接状态的信息集合。 |
|
properties.provisioningState |
专用终结点连接资源的预配状态。 |
|
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
PrivateEndpointConnectionProvisioningState
当前预配状态。
名称 | 类型 | 说明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
专用终结点连接状态。
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
有关服务使用者与提供程序之间的连接状态的信息集合。
名称 | 类型 | 说明 |
---|---|---|
actionsRequired |
string |
一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。 |
description |
string |
批准/拒绝连接的原因。 |
status |
指示连接是否已由服务的所有者批准/拒绝/删除。 |
ReplicationRole
复制角色。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
Replica |
string |
|
Source |
string |
Server
表示服务器。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如“/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 服务器 ID。 |
properties.state |
服务器的状态。 |
|
properties.storage |
服务器的存储相关属性。 |
|
properties.version |
服务器版本。 |
|
sku |
SKU (服务器的定价层) 。 |
|
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
ServerListResult
服务器列表。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
用于获取下一页操作的链接。 |
value |
Server[] |
服务器列表 |
ServerSkuTier
特定 SKU 的层,例如 GeneralPurpose。
名称 | 类型 | 说明 |
---|---|---|
Burstable |
string |
|
GeneralPurpose |
string |
|
MemoryOptimized |
string |
ServerState
服务器的状态。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Updating |
string |
ServerVersion
服务器的版本。
名称 | 类型 | 说明 |
---|---|---|
5.7 |
string |
|
8.0.21 |
string |
Storage
服务器的存储配置文件属性
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
autoGrow | Disabled |
启用存储自动增长与否。 |
|
autoIoScaling | Enabled |
是否启用 IO 自动缩放。 |
|
iops |
integer |
服务器的存储 IOPS。 |
|
logOnDisk | Disabled |
是否启用登录磁盘。 |
|
storageSizeGB |
integer |
服务器允许的最大存储大小。 |
|
storageSku |
string |
服务器存储的 SKU 名称。 |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |