Network Status - List By Service
取得 Api 管理服務從雲端服務內部相依的外部資源連線狀態。 這也會將 DNS 伺服器傳回為 CloudService 可見。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/networkstatus?api-version=2022-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex 模式: |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
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 | 模擬您的用戶帳戶 |
範例
ApiManagementServiceGetNetworkStatus
範例要求
範例回覆
[
{
"location": "West US",
"networkStatus": {
"dnsServers": [
"10.82.98.10"
],
"connectivityStatus": [
{
"name": "apimgmtst6xxxxxxxxxxx.blob.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:14.7035899Z",
"lastStatusChange": "2020-11-20T07:54:55.9365931Z",
"resourceType": "BlobStorage",
"isOptional": false
},
{
"name": "apimgmtst6xxxxxxxxxxx.file.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:41.5322463Z",
"lastStatusChange": "2020-11-20T07:54:55.9265938Z",
"resourceType": "FileStorage",
"isOptional": true
},
{
"name": "apimgmtst6xxxxxxxxxxx.queue.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:30.645994Z",
"lastStatusChange": "2020-11-20T07:54:55.8410477Z",
"resourceType": "Queue",
"isOptional": true
},
{
"name": "apimgmtst6xxxxxxxxxxx.table.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:23.8789171Z",
"lastStatusChange": "2020-11-20T07:54:55.9365931Z",
"resourceType": "TableStorage",
"isOptional": false
},
{
"name": "gcs.prod.monitoring.core.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:57:34.8666833Z",
"lastStatusChange": "2020-11-20T08:07:37.5486932Z",
"resourceType": "Monitoring",
"isOptional": true
},
{
"name": "https://gcs.ppe.warm.ingestion.monitoring.azure.com",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:26.1870188Z",
"lastStatusChange": "2020-11-20T07:54:56.1060523Z",
"resourceType": "Monitoring",
"isOptional": true
},
{
"name": "https://global.metrics.nsatc.net/",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:35.9620612Z",
"lastStatusChange": "2020-11-20T07:54:56.0510519Z",
"resourceType": "Monitoring",
"isOptional": true
},
{
"name": "https://login.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:30.8047708Z",
"lastStatusChange": "2020-11-20T07:54:56.1060523Z",
"resourceType": "AzureActiveDirectory",
"isOptional": true
},
{
"name": "https://prod2.metrics.nsatc.net:1886/RecoveryService",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:56:45.2095302Z",
"lastStatusChange": "2020-11-20T07:54:56.2796235Z",
"resourceType": "Metrics",
"isOptional": true
},
{
"name": "LocalGatewayRedis",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:15.1345836Z",
"lastStatusChange": "2020-11-20T07:54:55.9365931Z",
"resourceType": "InternalCache",
"isOptional": true
},
{
"name": "prod.warmpath.msftcloudes.com",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:57.8992141Z",
"lastStatusChange": "2020-11-20T07:54:55.8410477Z",
"resourceType": "Monitoring",
"isOptional": false
},
{
"name": "Scm",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T23:01:24.0553684Z",
"lastStatusChange": "2019-07-20T02:25:48.7066996Z",
"resourceType": "SourceControl",
"isOptional": true
},
{
"name": "smtpi-ch1.msn.com:25028",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:58:22.2430074Z",
"lastStatusChange": "2020-11-20T07:54:56.3510577Z",
"resourceType": "Email",
"isOptional": true
},
{
"name": "zwcvuxxxx.database.windows.net",
"status": "success",
"error": "",
"lastUpdated": "2020-11-24T22:55:44.3582171Z",
"lastStatusChange": "2020-11-20T07:54:56.0410467Z",
"resourceType": "SQLDatabase",
"isOptional": false
}
]
}
}
]
定義
名稱 | Description |
---|---|
Connectivity |
資源連線的詳細數據。 |
Connectivity |
資源連線狀態類型標識碼。 |
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
Network |
網路狀態詳細數據。 |
Network |
位置中的網路狀態 |
ConnectivityStatusContract
資源連線的詳細數據。
名稱 | 類型 | Description |
---|---|---|
error |
string |
資源連線的錯誤詳細數據。 |
isOptional |
boolean |
這是否為選擇性。 |
lastStatusChange |
string |
資源連線狀態上次從成功變更為失敗的日期,反之亦然。 日期符合下列格式: |
lastUpdated |
string |
上次更新資源連線狀態的日期。 此狀態應該每隔 15 分鐘更新一次。 如果此狀態尚未更新,則表示服務已從 虛擬網路 內遺失與資源的網路連線。日期符合下列格式: |
name |
string |
服務相依之資源的主機名。 這可以是資料庫、記憶體或任何其他服務相依的 Azure 資源。 |
resourceType |
string |
資源類型。 |
status |
資源連線狀態類型標識碼。 |
ConnectivityStatusType
資源連線狀態類型標識碼。
名稱 | 類型 | Description |
---|---|---|
failure |
string |
|
initializing |
string |
|
success |
string |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
要求中傳送無效欄位的清單,以防發生驗證錯誤。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |
NetworkStatusContract
網路狀態詳細數據。
名稱 | 類型 | Description |
---|---|---|
connectivityStatus |
取得服務相依之資源的連線狀態清單。 |
|
dnsServers |
string[] |
取得 DNS 伺服器 IPV4 位址的清單。 |
NetworkStatusContractByLocation
位置中的網路狀態
名稱 | 類型 | Description |
---|---|---|
location |
string |
服務的位置 |
networkStatus |
位置中的網路狀態 |