Freigeben über

Anwendungs-REST-API in Azure HDInsight

Erstellen

Erstellt einen neuen Knoten auf dem Cluster (der als Edge-Knoten bezeichnet wird) und installiert eine Anwendung auf diesem Knoten.

Anfrage

Unter Allgemeine Parameter und Header finden Sie Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
PLATZIEREN https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/applications/{application Name}?api-version={api-version}

Das folgende Beispiel zeigt den Anforderungstext für die Installation von Anwendungen in einem Linux-basierten HDInsight-Cluster.

{  
  
	"name": "clusterName / applicationName"  
		"type": "Microsoft.HDInsight/clusters/applications",  
	"properties": {  
		"computeProfile": {  
			"roles": [  
				{  
					"name": "edgenode",  
					"targetInstanceCount": 1,  
					"hardwareProfile": {  
						"vmSize": "Standard_D3"  
					}  
				}  
			]  
		},  
		"installScriptActions": [  
			{  
				"name": "hue-install",  
				"uri": "https://publicEndpoint-bash-file.sh",  
				"parameters": "",  
				"roles": ["edgenode"]  
			}  
		],  
		"uninstallScriptActions": [  
			{  
				"name": "hue-uninstall",  
				"uri": "https://publicEndpoint-bash-file.sh",  
				"parameters": "",  
				"roles": ["edgenode"]  
			}  
		],  
		"httpsEndpoints": [  
			{  
				"subDomainSuffix": "abc",  
				"destinationPort": 8888,  
				"accessModes": ["WebPage"]  
			},  
			{  
				"subDomainSuffix": "was",  
				"destinationPort": 50073,  
				"accessModes": ["WebPage"]  
			}  
		],  
		"applicationType": "CustomApplication"  
	}  
}
Elementname Erforderlich Typ BESCHREIBUNG
Name Ja Schnur Gibt den Namen der Anwendung an. Der Name muss als clusterName/applicationName angegeben werden. Der Anwendungsname muss pro Cluster eindeutig sein.
Typ Ja Schnur Gibt den Typ der Ressource an.
Eigenschaften Ja Komplexer Typ Gibt die Eigenschaften des Clusters an.

Eigenschaften

Elementname Erforderlich Typ BESCHREIBUNG
computeProfile Ja Komplexer Typ Beschreibt den virtuellen Computer, auf dem die Anwendung ausgeführt wird
InstallScriptActions Ja Komplexer Typ Beschreibt die Aktionen des Installationsskripts für die Anwendung. Mindestens ein Skript muss angegeben werden, und die Skripte müssen idempotent sein, was bedeutet, dass die Skripte wiederholt aufgerufen werden können, während das gleiche Ergebnis erzeugt wird.
UninstallScriptActions Nein Komplexer Typ Beschreibt die Aktionen des Deinstallationsskripts für die Anwendung. Dieser Parameter ist optional, aber alle angegebenen Deinstallationsskriptaktionen müssen idempotent sein (was bedeutet, dass die Skripts wiederholt aufgerufen werden können, während das gleiche Ergebnis erzeugt wird).
HttpEndpunkt Nein Komplexer Typ Beschreibt, welche Endpunkte in der Anwendung über das Internet adressierbar sein sollen.
applicationType Ja Schnur Dieses Element ist immer der Wert "CustomApplication"

computeProfile

Dieses Element sollte genau eine Rolle enthalten

Elementname Erforderlich Typ BESCHREIBUNG
role Ja Komplexer Typ Gibt Informationen zu Rollen im Cluster an
Rolle
Elementname Erforderlich Typ BESCHREIBUNG
Name Ja Schnur Der Name muss als "edgenode" angegeben werden
targetInstanceCount Ja Integer Dieses Element muss auf 1 gesetzt werden
HardwareProfil Ja Komplexer Typ Gibt Informationen über das Hardwareprofil für den Edgenode an
HardwareProfil
Elementname Erforderlich Typ BESCHREIBUNG
vmSize Ja Schnur Gibt die Größe des virtuellen Computers an. Gültige Größen finden Sie unter HDInsight-Konfigurationsoptionen (scrollen Sie unter diesem Link nach unten zu den Knotentarifen)

InstallScriptActions

Elementname Erforderlich Typ BESCHREIBUNG
Name Ja Schnur Gibt den Namen der Skriptaktion an. Muss für alle persistenten Skriptaktionen im Cluster eindeutig sein
Uri Ja Schnur Öffentlich zugänglicher Speicherort des Skripts. Alle angegebenen Skripts müssen idempotent sein, was bedeutet, dass die Skripts wiederholt aufgerufen werden können, während sie das gleiche Ergebnis erzeugen.
Die Parameter Nein Schnur Optionaler Satz von Parametern, die an das Skript übergeben werden sollen
Rollen Ja Array von Zeichenfolgen Beschreibt die Rolle, unter der das Skript ausgeführt werden soll. Gültige Werte sind: headnode, workernode, zookeepernode und edgenode. EdgeNode ist die Rolle, die die Anwendung hostet und in der Ihre Anwendung ausgeführt wird.

UninstallScriptActions

Elementname Erforderlich Typ BESCHREIBUNG
Name Ja Schnur Gibt den Namen der Skriptaktion an.
Uri Ja Schnur Öffentlich zugänglicher Speicherort des Skripts. Alle angegebenen Skripts müssen idempotent sein, d. h. die Skripts können wiederholt aufgerufen werden, während das gleiche Ergebnis erzielt wird.
Die Parameter Nein Schnur Optionaler Satz von Parametern, die an das Skript übergeben werden sollen
Rollen Ja Array von Zeichenfolgen Beschreibt die Rolle, unter der das Skript ausgeführt werden soll. Gültige Werte sind: headnode, workernode, zookeepernode und edgenode. EdgeNode ist die Rolle, die die Anwendung hostet und in der Ihre Anwendung ausgeführt wird.

HttpEndpunkt

Elementname Erforderlich Typ BESCHREIBUNG
subDomainSuffix Ja Schnur Eine dreistellige alphanumerische Zeichenfolge, die zum Erstellen des DNS-Namens für den Zugriff auf die Anwendung verwendet wird. Der DNS-Name hat das Format: *.apps.azurehdinsight.net. Dieser Name muss pro Cluster eindeutig sein.
destinationPort Ja Integer Der Port, an den HTTP-Datenverkehr auf dem Edgenode, der Ihre Anwendung hostet, weitergeleitet werden soll.
accessModes Nein Array von Zeichenfolgen Metadaten über den Endpunkt. Wenn der Endpunkt eine Webseite hostet, geben Sie Webseite als Zugriffsmodus an. Andernfalls sollte das Array leer sein oder nicht in der Nutzlast vorhanden sein. Dieses Element ermöglicht es dem Azure-Portal, direkte Links zu Ihrer Anwendung anzuzeigen.

Antwort

Wenn die Überprüfung abgeschlossen ist und die Anforderung akzeptiert wird, gibt der Vorgang 200 (OK) zurück.

Statuscode: 200 OK

Herunterladen

Ruft Details zu einer HDInsight-Anwendung ab.

Anfrage

Unter Allgemeine Parameter und Header finden Sie Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
ERHALTEN/Bekommen https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/applications/{application Name}?api-version={api-version}

Antwort

Der Antworttext ist ein Array von HDInsight-Anwendungsdetails oder ein einzelnes HDInsight-Anwendungsdetail, wenn applicationName angegeben wird. Nachfolgend finden Sie ein Beispiel für Anwendungsdetails.

Antwortcode: HTTP 200 (OK) nach erfolgreichem Abschluss des Vorgangs.

Beispielantwort:

{  
	"value": [  
		{  
			"id": "resourceId",
			"name": "clusterName / applicationName",
			"type": "Microsoft.HDInsight/clusters/applications",  
			"etag": "etagValue",
			"tags": null,  
			"properties": {  
				"computeProfile": {  
					"roles": [  
						{  
							"name": "edgenode",  
							"targetInstanceCount": 1,  
							"hardwareProfile": {  
								"vmSize": "Standard_D3"  
							}  
						}  
					]  
				},  
				"installScriptActions": [  
					{  
						"name": "hue-install",  
						"uri": "https://publicEndpoint-bash-file.sh",  
						"parameters": "",  
						"roles": ["edgenode"]  
					}  
				],  
				"uninstallScriptActions": [  
					{  
						"name": "hue-uninstall",  
						"uri": "https://publicEndpoint-bash-file.sh",  
						"parameters": "",  
						"roles": ["edgenode"]  
					}  
				],  
				"httpsEndpoints": [  
					{  
						"subDomainSuffix": "abc",  
						"destinationPort": 8888,  
						"accessModes": ["WebPage"]  
					},  
					{  
						"subDomainSuffix": "was",  
						"destinationPort": 50073,  
						"accessModes": ["WebPage"]  
					}  
				],  
				"provisioningState": "Succeeded",  
				"applicationState": "Running",  
				"createdDate": "CreatedDate",  
				"applicationType": "CustomApplication",  
				"marketplaceIdentifier": "HueV1"  
			}  
		]  
	}

Entfernen

Entfernt eine HDInsight-Anwendung aus dem Cluster.

Anfrage

Unter Allgemeine Parameter und Header finden Sie Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
Löschen https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/applications/{application Name}?api-version={api-version}

Antwort

Der Vorgang gibt 202 (Akzeptiert) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde

Statuscode: 202 Akzeptiert.

  • Last updated on