Perform Connectivity Check Async - Perform Connectivity Check Async

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Führt eine Verbindungsüberprüfung zwischen dem API-Verwaltungsdienst und einem bestimmten Ziel aus und gibt Metriken für die Verbindung sowie Fehler zurück, die beim Herstellen der Verbindung aufgetreten sind.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/connectivityCheck?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
destination	True	Destination	Das Ziel des Verbindungsüberprüfungsvorgangs.
source	True	Source	Definitionen zum Ursprung der Konnektivitätsprüfung.
preferredIPVersion		PreferredIPVersion	Die zu verwendende IP-Version. Nur IPv4 wird jetzt unterstützt.
protocol		ConnectivityCheckProtocol	Das Protokoll der Anforderung. Spezifische Protokollkonfiguration kann basierend auf dieser Auswahl verfügbar sein. Die angegebene Zieladresse muss mit diesem Wert übereinstimmen.
protocolConfiguration		ProtocolConfiguration	Protokollspezifische Konfiguration.

Antworten

Name	Typ	Beschreibung
200 OK	ConnectivityCheckResponse	Die Verbindungsüberprüfungsanforderung wurde abgeschlossen.
202 Accepted		Die Anforderung wurde angenommen und wird zurzeit ausgeführt. Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft und das Ergebnis schließlich abgerufen werden kann. Header location: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

ConnectivityCheckResponse

Die Verbindungsüberprüfungsanforderung wurde abgeschlossen.

202 Accepted

Die Anforderung wurde angenommen und wird zurzeit ausgeführt. Der Speicherortheader enthält die URL, unter der der Status des vorgangs mit langer Ausführung überprüft und das Ergebnis schließlich abgerufen werden kann.

Header

location: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

HTTP Connectivity Check

TCP Connectivity Check

HTTP Connectivity Check

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck?api-version=2024-05-01

{
  "source": {
    "region": "northeurope"
  },
  "destination": {
    "address": "https://microsoft.com",
    "port": 3306
  },
  "protocol": "HTTPS",
  "protocolConfiguration": {
    "HTTPConfiguration": {
      "method": "GET",
      "validStatusCodes": [
        200,
        204
      ],
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer myPreciousToken"
        }
      ]
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-05-01

Statuscode:: 200

{
  "hops": [
    {
      "type": "Source",
      "id": "c60e2296-5ebc-48cc-80e8-7e6d2981e7b2",
      "address": "20.82.216.48",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
      "nextHopIds": [
        "26aa44e7-04f1-462f-aa5d-5951957b5650"
      ],
      "issues": []
    },
    {
      "type": "Internet",
      "id": "26aa44e7-04f1-462f-aa5d-5951957b5650",
      "address": "40.113.200.201",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Reachable",
  "avgLatencyInMs": 260,
  "minLatencyInMs": 250,
  "maxLatencyInMs": 281,
  "probesSent": 3,
  "probesFailed": 0
}

TCP Connectivity Check

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck?api-version=2024-05-01

{
  "source": {
    "region": "northeurope"
  },
  "destination": {
    "address": "8.8.8.8",
    "port": 53
  },
  "preferredIPVersion": "IPv4"
}

Beispiel für eine Antwort

Statuscode:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/connectivityCheck/operationresults/bmljb2xhLW5ldHdvcmt3YXRjaGVyNF9Db25uZWN0aXRpdml0eUNoZWNrXzE2MmExNmZl?api-version=2024-05-01

Statuscode:: 200

{
  "hops": [
    {
      "type": "Source",
      "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e",
      "address": "10.1.1.4",
      "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
      "nextHopIds": [
        "75c8d819-b208-4584-a311-1aa45ce753f9"
      ],
      "issues": []
    },
    {
      "type": "Internet",
      "id": "75c8d819-b208-4584-a311-1aa45ce753f9",
      "address": "8.8.8.8",
      "nextHopIds": [],
      "issues": []
    }
  ],
  "connectionStatus": "Connected",
  "avgLatencyInMs": 1,
  "minLatencyInMs": 1,
  "maxLatencyInMs": 4,
  "probesSent": 100,
  "probesFailed": 0
}

Definitionen

Name	Beschreibung
ConnectionStatus	Der Verbindungsstatus.
ConnectivityCheckProtocol	Das Protokoll der Anforderung. Spezifische Protokollkonfiguration kann basierend auf dieser Auswahl verfügbar sein. Die angegebene Zieladresse muss mit diesem Wert übereinstimmen.
ConnectivityCheckRequest	Eine Anforderung zum Ausführen des Verbindungsüberprüfungsvorgangs für einen API-Verwaltungsdienst.
ConnectivityCheckResponse	Informationen zum Verbindungsstatus.
ConnectivityHop	Informationen zu einem Hop zwischen der Quelle und dem Ziel.
ConnectivityIssue	Informationen zu einem Problem, das beim Überprüfen auf Konnektivität aufgetreten ist.
Destination	Das Ziel des Verbindungsüberprüfungsvorgangs.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HTTPConfiguration	Konfiguration für HTTP- oder HTTPS-Anforderungen.
HTTPHeader	HTTP-Header und wert.
IssueType	Der Typ des Problems.
Method	Die zu verwendende HTTP-Methode.
Origin	Der Ursprung des Problems.
PreferredIPVersion	Die zu verwendende IP-Version. Nur IPv4 wird jetzt unterstützt.
ProtocolConfiguration	Protokollspezifische Konfiguration.
Severity	Der Schweregrad des Problems.
Source	Definitionen zum Ursprung der Konnektivitätsprüfung.

ConnectionStatus

Enumeration

Der Verbindungsstatus.

Wert	Beschreibung
Connected
Degraded
Disconnected
Unknown

ConnectivityCheckProtocol

Enumeration

Das Protokoll der Anforderung. Spezifische Protokollkonfiguration kann basierend auf dieser Auswahl verfügbar sein. Die angegebene Zieladresse muss mit diesem Wert übereinstimmen.

Wert	Beschreibung
HTTP
HTTPS
TCP

ConnectivityCheckRequest

Objekt

Eine Anforderung zum Ausführen des Verbindungsüberprüfungsvorgangs für einen API-Verwaltungsdienst.

Name	Typ	Beschreibung
destination	Destination	Das Ziel des Verbindungsüberprüfungsvorgangs.
preferredIPVersion	PreferredIPVersion	Die zu verwendende IP-Version. Nur IPv4 wird jetzt unterstützt.
protocol	ConnectivityCheckProtocol	Das Protokoll der Anforderung. Spezifische Protokollkonfiguration kann basierend auf dieser Auswahl verfügbar sein. Die angegebene Zieladresse muss mit diesem Wert übereinstimmen.
protocolConfiguration	ProtocolConfiguration	Protokollspezifische Konfiguration.
source	Source	Definitionen zum Ursprung der Konnektivitätsprüfung.

ConnectivityCheckResponse

Objekt

Informationen zum Verbindungsstatus.

Name	Typ	Beschreibung
avgLatencyInMs	integer (int64)	Durchschnittliche Latenz in Millisekunden.
connectionStatus	ConnectionStatus	Der Verbindungsstatus.
hops	ConnectivityHop[]	Liste der Hops zwischen der Quelle und dem Ziel.
maxLatencyInMs	integer (int64)	Maximale Latenz in Millisekunden.
minLatencyInMs	integer (int64)	Minimale Latenz in Millisekunden.
probesFailed	integer (int64)	Anzahl der fehlgeschlagenen Probes.
probesSent	integer (int64)	Gesamtanzahl der gesendeten Probes.

ConnectivityHop

Objekt

Informationen zu einem Hop zwischen der Quelle und dem Ziel.

Name	Typ	Beschreibung
address	string	Die IP-Adresse des Hops.
id	string	Die ID des Hops.
issues	ConnectivityIssue[]	Liste der Probleme.
nextHopIds	string[]	Liste der nächsten Hop-IDs.
resourceId	string	Die ID der Ressource, die diesem Hop entspricht.
type	string	Der Typ des Hops.

ConnectivityIssue

Objekt

Informationen zu einem Problem, das beim Überprüfen auf Konnektivität aufgetreten ist.

Name	Typ	Beschreibung
context	object[]	Stellt zusätzlichen Kontext für das Problem bereit.
origin	Origin	Der Ursprung des Problems.
severity	Severity	Der Schweregrad des Problems.
type	IssueType	Der Typ des Problems.

Destination

Objekt

Das Ziel des Verbindungsüberprüfungsvorgangs.

Name	Typ	Beschreibung
address	string	Zieladresse. Kann entweder eine IP-Adresse oder ein FQDN sein.
port	integer (int64)	Zielport.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HTTPConfiguration

Objekt

Konfiguration für HTTP- oder HTTPS-Anforderungen.

Name	Typ	Beschreibung
headers	HTTPHeader[]	Liste der Kopfzeilen, die in die Anforderung aufgenommen werden sollen.
method	Method	Die zu verwendende HTTP-Methode.
validStatusCodes	integer[] (int64)	Liste der HTTP-Statuscodes, die als gültig für die Anforderungsantwort gelten.

HTTPHeader

Objekt

HTTP-Header und wert.

Name	Typ	Beschreibung
name	string	Kopfzeilenname.
value	string	Headerwert.

IssueType

Enumeration

Der Typ des Problems.

Wert	Beschreibung
AgentStopped
DnsResolution
GuestFirewall
NetworkSecurityRule
Platform
PortThrottled
SocketBind
Unknown
UserDefinedRoute

Method

Enumeration

Die zu verwendende HTTP-Methode.

Wert	Beschreibung
GET
POST

Origin

Enumeration

Der Ursprung des Problems.

Wert	Beschreibung
Inbound
Local
Outbound

PreferredIPVersion

Enumeration

Die zu verwendende IP-Version. Nur IPv4 wird jetzt unterstützt.

Wert	Beschreibung
IPv4

ProtocolConfiguration

Objekt

Protokollspezifische Konfiguration.

Name	Typ	Beschreibung
HTTPConfiguration	HTTPConfiguration	Konfiguration für HTTP- oder HTTPS-Anforderungen.

Severity

Enumeration

Der Schweregrad des Problems.

Wert	Beschreibung
Error
Warning

Source

Objekt

Definitionen zum Ursprung der Konnektivitätsprüfung.

Name	Typ	Beschreibung
instance	integer (int64)	Die bestimmte VMSS-Instanz, aus der die Anforderung ausgelöst werden soll.
region	string	Der API-Verwaltungsdienstbereich, aus dem der Verbindungsüberprüfungsvorgang gestartet werden soll.

Freigeben über

Perform Connectivity Check Async - Perform Connectivity Check Async

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

HTTP Connectivity Check

Beispielanforderung

Beispiel für eine Antwort

TCP Connectivity Check

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConnectionStatus

ConnectivityCheckProtocol

ConnectivityCheckRequest

ConnectivityCheckResponse

ConnectivityHop

ConnectivityIssue

Destination

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HTTPConfiguration

HTTPHeader

IssueType

Method

Origin

PreferredIPVersion

ProtocolConfiguration

Severity

Source

Zusätzliche Ressourcen