Network Status - List By Service

Api Management サービスがクラウド サービス内から依存する外部リソースへの接続ステータスを取得します。 これにより、クラウド サービスに対して可視として DNS サーバーも返されます。

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

URI パラメーター

Name In Required Type Description
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

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用される API のバージョン。

応答

Name Type Description
200 OK

サービスが展開されているすべてのリージョンのネットワーク状態の詳細の一覧を取得します。

Other Status Codes

操作が失敗した理由を示すエラー応答です。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementServiceGetNetworkStatus

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/networkstatus?api-version=2019-12-01

Sample Response

[
  {
    "location": "West Europe",
    "networkStatus": {
      "dnsServers": [
        "100.78.90.70"
      ],
      "connectivityStatus": [
        {
          "name": "apimgmtsttgzqxxxxxcrsc.blob.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:43.6997938Z",
          "lastStatusChange": "2019-01-24T21:47:53.851895Z"
        },
        {
          "name": "apimgmtsttgzqxxxxxcrsc.file.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:44.0439771Z",
          "lastStatusChange": "2019-05-02T21:22:50.6835366Z"
        },
        {
          "name": "apimgmtsttgzqxxxxxcrsc.queue.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:44.8564232Z",
          "lastStatusChange": "2019-05-02T20:53:26.6260794Z"
        },
        {
          "name": "apimgmtsttgzqxxxxxcrsc.table.core.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:44.0439771Z",
          "lastStatusChange": "2019-05-02T20:53:21.6729263Z"
        },
        {
          "name": "ftmrcxxx.database.windows.net",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:44.1845483Z",
          "lastStatusChange": "2019-05-02T21:02:00.9466899Z"
        },
        {
          "name": "https://prod3.metrics.nsatc.net:1886/RecoveryService",
          "status": "failure",
          "error": "Failed to connect to https://prod3.metrics.nsatc.net:1886/RecoveryService with error Unable to connect to the remote server",
          "lastUpdated": "2019-12-18T12:04:30.1214083Z",
          "lastStatusChange": "2019-01-24T22:00:04.2450462Z"
        },
        {
          "name": "https://westeurope.prod.warm.ingestion.msftcloudes.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:43.8251399Z",
          "lastStatusChange": "2019-12-18T11:14:43.3860126Z"
        },
        {
          "name": "LocalGatewayRedis",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:50.6376685Z",
          "lastStatusChange": "2019-12-18T11:14:44.4966742Z"
        },
        {
          "name": "prod.warmpath.msftcloudes.com",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:44.4345454Z",
          "lastStatusChange": "2019-05-08T00:09:58.031766Z"
        },
        {
          "name": "Scm",
          "status": "success",
          "error": "",
          "lastUpdated": "2019-12-18T12:04:58.4815899Z",
          "lastStatusChange": "2019-12-18T11:24:48.4795085Z"
        },
        {
          "name": "smtpi-db3.msn.com:25028",
          "status": "failure",
          "error": "Connection smtpi-db3.msn.com:25028 failed with Error Unable to connect to the remote server",
          "lastUpdated": "2019-12-18T12:04:30.1526431Z",
          "lastStatusChange": "2019-12-18T11:23:05.7709057Z"
        }
      ]
    }
  }
]

定義

ConnectivityStatusContract

リソースへの接続に関する詳細。

ConnectivityStatusType

リソース接続状態の種類識別子。

ErrorFieldContract

エラー フィールド コントラクト。

ErrorResponse

エラー応答。

NetworkStatusContract

ネットワーク状態の詳細。

NetworkStatusContractByLocation

ロケーション内のネットワークステータス

ConnectivityStatusContract

リソースへの接続に関する詳細。

Name Type Description
error
  • string

リソースへの接続のエラーの詳細。

lastStatusChange
  • string

リソース接続状態が最後に変更された成功から失敗、またはその逆の日付。 日付は、ISO 8601yyyy-MM-ddTHH:mm:ssZ規格で指定されている形式に準拠しています。

lastUpdated
  • string

リソース接続状態が最後に更新された日付。 このステータスは 15 分ごとに更新する必要があります。 このステータスが更新されていない場合は、サービスが仮想ネットワークyyyy-MM-ddTHH:mm:ssZ内からリソースへのネットワーク接続を失ったことを意味します。

name
  • string

サービスが依存しているリソースのホスト名。 これは、サービスが依存するデータベース、ストレージ、またはその他の Azure リソースです。

status

リソース接続状態の種類識別子。

ConnectivityStatusType

リソース接続状態の種類識別子。

Name Type Description
failure
  • string
initializing
  • string
success
  • string

ErrorFieldContract

エラー フィールド コントラクト。

Name Type Description
code
  • string

プロパティ レベルのエラー コード。

message
  • string

プロパティ レベルエラーの人間が判読できる表現。

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

検証エラーが発生した場合に、要求で送信される無効なフィールドのリスト。

error.message
  • string

エラーの人間が読み取り可能な表現。

NetworkStatusContract

ネットワーク状態の詳細。

Name Type Description
connectivityStatus

サービスが依存するリソースへの接続状態のリストを取得します。

dnsServers
  • string[]

DNS サーバーの IPV4 アドレスの一覧を取得します。

NetworkStatusContractByLocation

ロケーション内のネットワークステータス

Name Type Description
location
  • string

サービスの場所

networkStatus

ロケーションのネットワークステータス