通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Network Status - List By Location

  • 参考
Service:
API Management
API Version:
2022-08-01

从云服务内部获取 Api 管理服务所依赖的外部资源的连接状态。 这还会返回对 CloudService 可见的 DNS 服务器。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/locations/{locationName}/networkstatus?api-version=2022-08-01

URI 参数

名称 在 必需 类型 说明
locationName
 path True

string

部署API 管理服务的位置。 这是 Azure 区域之一，例如美国西部、美国东部、美国中南部。
resourceGroupName
 path True

string

资源组的名称。 此名称不区分大小写。
serviceName
 path True

string

API 管理服务的名称。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

目标订阅的 ID。
api-version
 query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

NetworkStatusContract

获取网络状态详细信息。
Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementServiceGetNetworkStatusByLocation

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/locations/North Central US/networkstatus?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "dnsServers": [
    "10.82.98.10"
  ],
  "connectivityStatus": [
    {
      "name": "apimgmtst6tnxxxxxxxxxxx.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": "apimgmtst6tnxxxxxxxxxxx.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": "apimgmtst6tnxxxxxxxxxxx.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": "apimgmtst6tnxxxxxxxxxxx.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:03:57.6187917Z",
      "lastStatusChange": "2020-11-20T07:54:57.325384Z",
      "resourceType": "SourceControl",
      "isOptional": true
    },
    {
      "name": "smtpi-xxx.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
    }
  ]
}

定义

名称 说明
ConnectivityStatusContract

有关与资源连接的详细信息。
ConnectivityStatusType

资源连接状态类型标识符。
ErrorFieldContract

错误字段协定。
ErrorResponse

错误响应。
NetworkStatusContract

网络状态详细信息。

ConnectivityStatusContract

有关与资源连接的详细信息。

名称 类型 说明
error

string

与资源连接的错误详细信息。
isOptional

boolean

这是否是可选的。
lastStatusChange

string

资源连接状态上次从成功更改为失败的日期，反之亦然。 日期符合以下格式： yyyy-MM-ddTHH:mm:ssZ 由 ISO 8601 标准指定。
lastUpdated

string

上次更新资源连接状态的日期。 此状态应每 15 分钟更新一次。 如果此状态尚未更新，则表示服务已从虚拟网络失去与资源的网络连接。日期符合以下格式：yyyy-MM-ddTHH:mm:ssZ由 ISO 8601 标准指定。
name

string

服务所依赖的资源的主机名。 这可以是数据库、存储或服务所依赖的任何其他 Azure 资源。
resourceType

string

资源类型。
status

ConnectivityStatusType

资源连接状态类型标识符。

ConnectivityStatusType

资源连接状态类型标识符。

名称 类型 说明
failure

string

initializing

string

success

string

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。
message

string

属性级错误的可读表示形式。
target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。
error.details

ErrorFieldContract[]

在发生验证错误的情况下，在请求中发送的无效字段列表。
error.message

string

错误的用户可读表示形式。

NetworkStatusContract

网络状态详细信息。

名称 类型 说明
connectivityStatus

ConnectivityStatusContract[]

获取服务所依赖的资源的连接状态列表。
dnsServers

string[]

获取 DNS 服务器 IPV4 地址的列表。