Freigeben über

Cluster-REST-API in Azure HDInsight

  • Artikel

Erstellen

Erstellt einen Cluster im angegebenen Abonnement.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Das folgende Beispiel zeigt den Anforderungstext zum Erstellen eines Linux-basierten Hadoop-Clusters. Beispiele zum Erstellen von Clustern auf andere Weise finden Sie im Abschnitt Beispiele unten.

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
        "clusterDefinition": {  
            "kind": "hadoop",  
  
            "configurations": {  
                "gateway": {  
                    "restAuthCredential.isEnabled": true,  
                    "restAuthCredential.username": "http-user",  
                    "restAuthCredential.password": "password"  
                },  
  
                "core-site": {  
                    "fs.defaultFS": "wasb://container@storageaccount.blob.core.windows.net",  
                    "fs.azure.account.key.storageaccount.blob.core.windows.net": storage-account-key"  
                }  
            }  
        },
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
  
                    "osProfile": {  
                        "linuxOperatingSystemProfile": {  
                            "username": "username",  
                            "sshProfile": {  
                                "publicKeys": [   
                                    { "certificateData": "ssh-rsa key" }  
                                ]  
                            }  
                        }  
                    }  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
  
                    "osProfile": {  
                        "linuxOperatingSystemProfile": {  
                            "username": "username",  
                            "sshProfile": {  
                                "publicKeys": [  
                                    { "certificateData": " ssh-rsa key" }  
                                ]  
                            }  
                        }  
                    }  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    },  
  
                    "osProfile": {  
                        "linuxOperatingSystemProfile": {  
                            "username": "username",  
                            "sshProfile": {  
                                "publicKeys": [   
                                    { "certificateData": "ssh-rsa key" }  
                                ]  
                            }  
                        }  
                    }  
                }  
            ]  
        }  
    }  
}
Elementname Erforderlich Typ BESCHREIBUNG
id Ja String Gibt den Ressourcenbezeichner des Clusters an.
name Ja String Gibt den Namen des Clusters an.
type Ja String Gibt den Typ des Clusters an.
location Ja String Gibt den unterstützten Azure-Speicherort an, an dem der Cluster erstellt werden soll. Weitere Informationen finden Sie unter Auflisten aller verfügbaren geografischen Standorte.
tags Nein String Gibt die Tags an, die dem Cluster zugewiesen werden. Weitere Informationen zur Verwendung von Tags finden Sie unter Verwenden von Tags zum Organisieren Ihrer Azure-Ressourcen.
Eigenschaften Ja Komplexer Typ Gibt die Eigenschaften des Clusters an.

Eigenschaften

Elementname Erforderlich Typ BESCHREIBUNG
clusterVersion Ja String Gibt die Clusterversion an.
osType Ja String Gibt das Betriebssystem für den Cluster an.

Gültige Werte sind Linux und Windows.
clusterDefinition Yes Komplexer Typ Gibt Informationen zum Clustertyp und zu den Konfigurationen an.
computeProfile Yes Komplexer Typ Gibt Informationen zur Clustertopologie und den zugeordneten Rolleneigenschaften an.

clusterDefinition

Elementname Erforderlich Typ BESCHREIBUNG
kind Ja String Gibt den Clustertyp an.

Gültige Werte sind hadoop, hbase, storm & spark
Konfigurationen Ja Wörterbuch Dieses Element ist ein Wörterbuch des Konfigurationstyps und des zugehörigen Wertwörterbuchs.

Der Gatewaykonfigurationstyp wird verwendet, um den HTTP-Benutzer zu konfigurieren, der für die Verbindung mit Web-APIs und dem Ambari-Portal verwendet wird.

Core-Site-Konfigurationstyp wird verwendet, um das Standardspeicherkonto für den Cluster zu konfigurieren.

computeProfile

Elementname Erforderlich Typ BESCHREIBUNG
clusterVersion Ja String Gibt die Clusterversion an.
role Yes Array des komplexen Typs (Rolle) Gibt Informationen zu Rollen im Cluster an.

Rolle (role)

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Gibt den Rollennamen an.
targetInstanceCount Ja Integer Gibt die Anzahl der Ziel-instance für die Rolle an.
hardwareProfile Yes Komplexer Typ Gibt Informationen zum Hardwareprofil für die Rolle an.
osProfile Yes Komplexer Typ Gibt Informationen zum Betriebssystemprofil für die Rolle an.

hardwareProfile

Elementname Erforderlich Typ BESCHREIBUNG
vmSize Ja String Gibt die Größe des virtuellen Computers an. Gültige Größen finden Sie unter HDInsight-Konfigurationsoptionen (scrollen Sie einmal auf diesem Link nach unten zu Knotentarifen).

osProfile

Elementname Erforderlich Typ BESCHREIBUNG
linuxOperatingSystemProfile No Komplexer Typ Gibt die Linux-Betriebssystem-bezogenen Einstellungen an.
windowsOperatingSystemProfile No Komplexer Typ Gibt Einstellungen für das Windows-Betriebssystem an
virtualNetworkProfile No Komplexer Typ Gibt VNET-bezogene Einstellungen an, wenn der Cluster in einem virtuellen Netzwerk im Abonnement des Benutzers bereitgestellt wird.
scriptActions No Array des komplexen Typs Liste der Skriptaktionen, die im Cluster ausgeführt werden sollen

linuxOperatingSystemProfile

Elementname Erforderlich Typ BESCHREIBUNG
Username Ja String SSH-Benutzername
sshProfile No Komplexer Typ Gibt den SSH-Schlüssel an.

Eines von sshProfile oder Password ist erforderlich.
Kennwort Nein String Gibt das SSH-Kennwort an.

Eines von sshProfile oder Password ist erforderlich.

sshProfile

Elementname Erforderlich Typ BESCHREIBUNG
publicKeys Ja Array Enthält eine Liste der certificateData-Objekte. Der Wert ist ein öffentlicher Ssh-Rsa-Schlüssel.

windowsOperatingSystemProfile

Elementname Erforderlich Typ BESCHREIBUNG
rdpSettings No Komplexer Typ Gibt RDP-Einstellungen für Windows-Cluster an.

rdpSettings

Elementname Erforderlich Typ BESCHREIBUNG
username Ja String Gibt den RDP-Benutzernamen an.
password Ja String Gibt das Kennwort für den RDP-Benutzer an.
expiryDate Ja Date Ablaufdatum für die RDP-Anmeldeinformationen

virtualNetworkProfile

Elementname Erforderlich Typ BESCHREIBUNG
id Ja String Virtual Network-Ressourcen-ID
Subnetz Ja String Gibt den Subnetznamen an.

scriptActions

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Anzeigename für die Skriptaktion
uri Ja String URL zur Skriptaktionsdatei
parameters Nein String Beim Ausführen der Skriptaktionsdatei zu übergebende Argumente

Antwort

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

Statuscode: 200 OK

Der Antworttext für einen Linux-Cluster wird mithilfe des SSH-Schlüssels erstellt:

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
		"provisioningState": "InProgress",  
		"clusterState": "Accepted",  
		"createdDate": "2015-09-23",  
		"quotaInfo": {  
			"coresUsed": 20  
}  
        "clusterDefinition": {  
            "kind": "hadoop"  
        },  
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    }  
                }  
            ]  
        }  
    }  
}
Elementname type BESCHREIBUNG
provisioningState String Gibt den aktuellen Bereitstellungsstatus an.
clusterState String Gibt den ausführlicheren HDInsight-Clusterstatus an, während die Bereitstellung ausgeführt wird.
createdDate Date Datetime, wenn die Anforderung zum Erstellen des Clusters empfangen wurde
quotaInfo Komplexer Typ Gibt die vom Cluster bereitgestellten Kerne an.
errors Array von Fehlermeldungen Enthält die Fehlermeldung if provisioningState = 'failed'
connectivityEndpoints Komplexer Typ Gibt die öffentlichen Endpunkte für den Cluster an.

connectivityEndpoints

Elementname type BESCHREIBUNG
name String Anzeigename für den Konnektivitätsendpunkt
Protokoll String Gibt das zu verwendende Protokoll an (Beispiel: HTTPS, SSH)
location String Gibt die URL an, die eine Verbindung hergestellt werden soll.
port INT Gibt den Port an, für den eine Verbindung hergestellt werden soll.

Erstellen eines premium-, in die Domäne eingebundenen HDInsight-Clusters (nur Linux, Vorschau)

Erstellen Sie mit Apache Ranger einen In die Domäne eingebundenen Premium-Cluster. Der Benutzer muss securityProfile im Anforderungstext angeben, um einen sicheren Cluster zu erstellen.

Anforderung

Informationen zu Headern und Parametern , die von Clustern verwendet werden, finden Sie unter Allgemeine Parameter und Header.

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

Das folgende Beispiel zeigt den Anforderungstext zum Erstellen eines In die Domäne eingebundenen Hadoop-Clusters auf Linux-Basis, Premium.

{
	"id": "/subscriptions/{ subscription-id }/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/ clusters/mycluster ", "
	name "
	: "mycluster",
	"type": "Microsoft.HDInsight/clusters",
	"location": "location-name",
	"tags": {
		"tag1": "value1",
		"tag2": "value2"
	},
	"properties": {
		"clusterVersion": "3.5",
		"osType": "Linux",
		"tier": "premium",
		"clusterDefinition": {
			"kind": "hadoop",
			"configurations": {
				"gateway": {
					"restAuthCredential.isEnabled": true,
					"restAuthCredential.username": "http-user",
					"restAuthCredential.password": "password"
				},
				"core-site": {
					"fs.defaultFS": "wasb://container@storageaccount.blob.core.windows.net",
					"fs.azure.account.key.storageaccount.blob.core.windows.net": "storage-account-key"
				}
			}
		},
		"securityProfile": {
			"directoryType": "ActiveDirectory",
			"domain": "mydomain.com",
			"organizationalUnitDN": "OU=Hadoop,DC=mydomain,DC=COM",
			"ldapsUrls": ["ldaps://mydomain.com:636"],
			"domainUsername": "clusteradmin@mydomain.com",
			"domainUserPassword": "password",
			"clusterUsersGroupDNs": ["ADGroup1", "ADGroup2"]
		},
		"computeProfile": {
			"roles": [
				{
					"name": "headnode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						}
					},
					"virtualNetworkProfile": {
						"id": "/subscriptions/mysubscriptionid/resourceGroups/myrresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork",
						"subnet": "/subscriptions/mysubscriptionid /resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork/subnets/mysubnet"
					}
				},
				{
					"name": "workernode",
					"targetInstanceCount": 1,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": " ssh-rsa key"
									}
								]
							}
						}
					},
					"virtualNetworkProfile": {
						"id": "/subscriptions/mysubscriptionid/resourceGroups/myrresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork",
						"subnet": "/subscriptions/mysubscriptionid /resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork/subnets/mysubnet"
					}
				},
				{
					"name": "zookeepernode",
					"targetInstanceCount": 3,
					"hardwareProfile": {
						"vmSize": "Small"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						},
						"virtualNetworkProfile": {
							"id": "/subscriptions/mysubscriptionid/resourceGroups/myrresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork",
							"subnet": "/subscriptions/mysubscriptionid /resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvirtualnetwork/subnets/mysubnet"
						}
					}
				}
			]
		}
	}
}
Elementname Erforderlich Typ BESCHREIBUNG
id Ja String Gibt den Ressourcenbezeichner des Clusters an.
name Ja String Gibt den Namen des Clusters an.
type Ja String Gibt den Typ des Clusters an.
location Ja String Gibt den unterstützten Azure-Speicherort an, an dem der Cluster erstellt werden soll. Weitere Informationen finden Sie unter Auflisten aller verfügbaren geografischen Standorte.
tags Nein String Gibt die Tags an, die dem Cluster zugewiesen werden. Weitere Informationen zur Verwendung von Tags finden Sie unter Verwenden von Tags zum Organisieren Ihrer Azure-Ressourcen.
Eigenschaften Ja Komplexer Typ Gibt die Eigenschaften des Clusters an.

Eigenschaften

Elementname Erforderlich Typ BESCHREIBUNG
clusterVersion Ja String Gibt die Clusterversion an.
osType Ja String Gibt das Betriebssystem für den Cluster an.

Der gültige Wert ist Linux , da nur Linux-Clustertypen einer Azure AD-Domäne beitreten können.
Ebene Nein String Der Standardwert ist Standard. Gültige Werte sind Standard und Premium. Wenn kein Wert angegeben wird, wird davon ausgegangen, dass er Standard ist. Gibt die Ebene für den Cluster an. In die Domäne eingebundene Cluster werden nur im Premium-Tarif unterstützt.
clusterDefinition Yes Komplexer Typ Gibt Informationen zum Clustertyp und zu den Konfigurationen an.
computeProfile Yes Komplexer Typ Gibt Informationen zur Clustertopologie und den zugeordneten Rolleneigenschaften an.
securityProfile No Komplexer Typ Wenn ein sicherer, in die Domäne eingebundener Cluster erstellt wird, gibt dieses Element die Active Directory-bezogenen Einstellungen an.

clusterDefinition

Elementname Erforderlich Typ BESCHREIBUNG
kind Ja String Gibt den Clustertyp an.

Gültige Werte sind hadoop, hbase, storm & spark
Konfigurationen Ja Wörterbuch Dieses Element ist ein Wörterbuch des Konfigurationstyps und des zugehörigen Wertwörterbuchs.

Der Gatewaykonfigurationstyp wird verwendet, um den HTTP-Benutzer zu konfigurieren, der für die Verbindung mit Web-APIs und dem Ambari-Portal verwendet wird.

Core-Site-Konfigurationstyp wird verwendet, um das Standardspeicherkonto für den Cluster zu konfigurieren.

computeProfile

Elementname Erforderlich Typ BESCHREIBUNG
clusterVersion Ja String Gibt die Clusterversion an.
role Yes Array des komplexen Typs (Rolle) Gibt Informationen zu Rollen im Cluster an.

securityProfile

Elementname Erforderlich Typ BESCHREIBUNG
directoryType Ja String Typ des verwendeten LDAP-Verzeichnisses. Derzeit ist "ActiveDirectory" der einzige unterstützte Wert.
Domäne Ja String Active Directory-Domäne für den Cluster
organizationalUnitDN Ja String Distinguished Name der Organisationseinheit im Active Directory, in dem Benutzer- und Computerkonten erstellt werden
ldapsUrls Yes Ein Zeichenfolgenarray. URLs eines oder mehrerer LDAPS-Server für Active Directory
domainUserName Ja String Ein Domänenbenutzerkonto mit ausreichenden Berechtigungen zum Erstellen des Clusters. Es sollte in user@domain Format vorliegen.
domainUserPassword Ja String Kennwort für das Domänenbenutzerkonto
clusterUsersGroupDNS No Ein Zeichenfolgenarray. Distinguished names of the Active Directory groups that will be available in Ambari and Apache Ranger

Rolle (role)

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Gibt den Rollennamen an.
targetInstanceCount Ja Integer Gibt die Zielanzahl instance für die Rolle an.
hardwareProfile Yes Komplexer Typ Gibt Informationen zum Hardwareprofil für die Rolle an.
osProfile Yes Komplexer Typ Gibt Informationen zum Betriebssystemprofil für die Rolle an.

hardwareProfile

Elementname Erforderlich Typ BESCHREIBUNG
vmSize Ja String Gibt die Größe des virtuellen Computers an. Gültige Größen finden Sie unter HDInsight-Konfigurationsoptionen (scrollen Sie nach unten zu Knotentarifen).

osProfile

Elementname Erforderlich Typ BESCHREIBUNG
linuxOperatingSystemProfile No Komplexer Typ Gibt die Einstellungen für das Linux-Betriebssystem an.
virtualNetworkProfile No Komplexer Typ Gibt Einstellungen für virtuelle Netzwerke an, wenn der Cluster in einem virtuellen Netzwerk im Abonnement des Benutzers bereitgestellt wird.
scriptActions No Array des komplexen Typs Liste der Skriptaktionen, die auf dem Cluster ausgeführt werden sollen

linuxOperatingSystemProfile

Elementname Erforderlich Typ BESCHREIBUNG
Username Ja String SSH-Benutzername
sshProfile No Komplexer Typ Gibt den SSH-Schlüssel an.

Eines von sshProfile oder Password ist erforderlich.
Kennwort Nein String Gibt das SSH-Kennwort an.

Eines von sshProfile oder Password ist erforderlich.

sshProfile

Elementname Erforderlich Typ BESCHREIBUNG
publicKeys Ja Array Enthält eine Liste der certificateData-Objekte. Der Wert ist ein öffentlicher SSH-RSA-Schlüssel.

virtualNetworkProfile

Elementname Erforderlich Typ BESCHREIBUNG
id Ja String Virtual Network Ressourcen-ID
Subnetz Ja String Gibt den Subnetznamen an.

scriptActions

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Anzeigename für die Skriptaktion
uri Ja String URL zur Skriptaktionsdatei
parameters Nein String Beim Ausführen der Skriptaktionsdatei zu übergebende Argumente

Antwort

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

Statuscode: 200 OK

Der Antworttext für einen Linux-Cluster wird mithilfe des SSH-Schlüssels erstellt:

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
		"provisioningState": "InProgress",  
		"clusterState": "Accepted",  
		"createdDate": "2015-09-23",  
		"quotaInfo": {  
			"coresUsed": 20  
}  
        "clusterDefinition": {  
            "kind": "hadoop"  
        },  
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    }  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    }  
                }  
            ]  
        }  
    }  
}
Elementname type BESCHREIBUNG
provisioningState String Gibt den aktuellen Bereitstellungsstatus an.
clusterState String Gibt den ausführlicheren HDInsight-Clusterstatus an, während die Bereitstellung ausgeführt wird.
createdDate Date Datetime, wenn die Anforderung zum Erstellen des Clusters empfangen wurde
quotaInfo Komplexer Typ Gibt die vom Cluster bereitgestellten Kerne an.
errors Array von Fehlermeldungen Enthält die Fehlermeldung if provisioningState = 'failed'
connectivityEndpoints Komplexer Typ Gibt die öffentlichen Endpunkte für den Cluster an.

connectivityEndpoints

Elementname type BESCHREIBUNG
name String Anzeigename für den Konnektivitätsendpunkt
Protokoll String Gibt das zu verwendende Protokoll an (Beispiel: HTTPS, SSH)
location String Gibt die URL an, die eine Verbindung hergestellt werden soll.
port INT Gibt den Port an, für den eine Verbindung hergestellt werden soll.

Erstellen eines Clusters mit Azure Data Lake Store als Standarddateisystem

Erstellt einen Cluster im angegebenen Abonnement mit Azure Data Lake Store als Standarddateisystem. Geben Sie im Anforderungstext ein ClusterIdentity-Objekt an, und konfigurieren Sie die Eigenschaft default-filesystem mit der entsprechenden Data Lake Store-URL.

Azure Data Lake kann als Standarddateisystem für Clusterversionen ab Version 3.5 konfiguriert werden.

Anforderung

Informationen zu Headern und Parametern , die von Clustern verwendet werden, finden Sie unter Allgemeine Parameter und Header.

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

Das folgende Beispiel zeigt den Anforderungstext zum Erstellen eines Linux-basierten Hadoop-Clusters mit Azure Data Lake Store als Standarddateisystem für den Cluster.

{
	"id": "/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",
	"name": "mycluster",
	"type": "Microsoft.HDInsight/clusters",
	"location": "location-name",
	"tags": {
		"tag1": "value1",
		"tag2": "value2"
	},
	"properties": {
		"clusterVersion": "3.5",
		"osType": "Linux",
		"tier": "Standard",
		"clusterDefinition": {
			"kind": "hadoop",
			"configurations": {
				"gateway": {
					"restAuthCredential.isEnabled": true,
					"restAuthCredential.username": "http-user",
					"restAuthCredential.password": "password"
				},
				"clusterIdentity": {
					"clusterIdentity.applicationId": "applicationId",
					"clusterIdentity.certificate": "certificate-contents-in-base64-encoding",
					"clusterIdentity.aadTenantId": "aad-tenant-id",
					"clusterIdentity.resourceUri": "https://KonaCompute.net/",
					"clusterIdentity.certificatePassword": "certificate-password"
				},
				"core-site": {
					"fs.defaultFS": "adl://home",
					"dfs.adls.home.hostname": "yourstorageaccount.azuredatalakestore.net",
					"dfs.adls.home.mountpoint": "/path/to/cluster/root"
				}
			}
		},
		"computeProfile": {
			"roles": [
				{
					"name": "headnode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						}
					}
				},
				{
					"name": "workernode",
					"targetInstanceCount": 1,
					"hardwareProfile": {
						"vmSize": "Large"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": " ssh-rsa key"
									}
								]
							}
						}
					}
				},
				{
					"name": "zookeepernode",
					"targetInstanceCount": 3,
					"hardwareProfile": {
						"vmSize": "Small"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "username",
							"sshProfile": {
								"publicKeys": [
									{
										"certificateData": "ssh-rsa key"
									}
								]
							}
						}
					}
				}
			]
		}
	}
}
Elementname Erforderlich Typ BESCHREIBUNG
id Ja String Gibt den Ressourcenbezeichner des Clusters an.
name Ja String Gibt den Namen des Clusters an.
type Ja String Gibt den Typ des Clusters an.
location Ja String Gibt den unterstützten Azure-Speicherort an, an dem der Cluster erstellt werden soll. Weitere Informationen finden Sie unter Auflisten aller verfügbaren geografischen Standorte.
tags Nein String Gibt die Tags an, die dem Cluster zugewiesen werden. Weitere Informationen zur Verwendung von Tags finden Sie unter Verwenden von Tags zum Organisieren Ihrer Azure-Ressourcen.
Eigenschaften Ja Komplexer Typ Gibt die Eigenschaften des Clusters an.

Eigenschaften

Elementname Erforderlich Typ BESCHREIBUNG
clusterVersion Ja String Gibt die Clusterversion an.
osType Ja String Gibt das Betriebssystem für den Cluster an.

Gültiger Wert ist Linux.
Ebene Nein String Gibt die Ebene für den Cluster an. Gültige Werte sind Standard und Premium. Wenn die Ebene nicht angegeben ist, hat der Cluster die Standardebene.
clusterDefinition Yes Komplexer Typ Gibt Informationen zum Clustertyp und zu den Konfigurationen an.
computeProfile Yes Komplexer Typ Gibt Informationen zur Clustertopologie und den zugeordneten Rolleneigenschaften an.

clusterDefinition

Elementname Erforderlich Typ BESCHREIBUNG
kind Ja String Gibt den Clustertyp an.

Gültige Werte sind hadoop, hbase, storm & spark
Konfigurationen Ja Wörterbuch Dieses Element ist ein Wörterbuch des Konfigurationstyps und des zugehörigen Wertwörterbuchs.

Der Gatewaykonfigurationstyp wird verwendet, um den HTTP-Benutzer zu konfigurieren, der für die Verbindung mit Web-APIs und dem Ambari-Portal verwendet wird.

Core-Site-Konfigurationstyp wird verwendet, um das Standardspeicherkonto für den Cluster zu konfigurieren.

computeProfile

Elementname Erforderlich Typ BESCHREIBUNG
clusterVersion Ja String Gibt die Clusterversion an.
role Yes Array des komplexen Typs (Rolle) Gibt Informationen zu Rollen im Cluster an.

Rolle (role)

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Gibt den Rollennamen an.
targetInstanceCount Ja Integer Gibt die Zielanzahl instance für die Rolle an.
hardwareProfile Yes Komplexer Typ Gibt Informationen zum Hardwareprofil für die Rolle an.
osProfile Yes Komplexer Typ Gibt Informationen zum Betriebssystemprofil für die Rolle an.

hardwareProfile

Elementname Erforderlich Typ BESCHREIBUNG
vmSize Ja String Gibt die Größe des virtuellen Computers an. Gültige Größen finden Sie unter HDInsight-Konfigurationsoptionen (scrollen Sie nach unten zu Knotentarifen).

osProfile

Elementname Erforderlich Typ BESCHREIBUNG
linuxOperatingSystemProfile No Komplexer Typ Gibt die Einstellungen für das Linux-Betriebssystem an.
virtualNetworkProfile No Komplexer Typ Gibt Einstellungen für virtuelle Netzwerke an, wenn der Cluster in einem virtuellen Netzwerk im Abonnement des Benutzers bereitgestellt wird.
scriptActions No Array des komplexen Typs Liste der Skriptaktionen, die im Cluster ausgeführt werden sollen

linuxOperatingSystemProfile

Elementname Erforderlich Typ BESCHREIBUNG
Username Ja String SSH-Benutzername
sshProfile No Komplexer Typ Gibt den SSH-Schlüssel an.

Eines von sshProfile oder Password ist erforderlich.
Kennwort Nein String Gibt das SSH-Kennwort an.

Eines von sshProfile oder Password ist erforderlich.

sshProfile

Elementname Erforderlich Typ BESCHREIBUNG
publicKeys Ja Array Enthält eine Liste der certificateData-Objekte. Der Wert ist ein öffentlicher Ssh-Rsa-Schlüssel.

virtualNetworkProfile

Elementname Erforderlich Typ BESCHREIBUNG
id Ja String Virtual Network-Ressourcen-ID
Subnetz Ja String Gibt den Subnetznamen an.

scriptActions

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Anzeigename für die Skriptaktion
uri Ja String URL zur Skriptaktionsdatei
parameters Nein String Beim Ausführen der Skriptaktionsdatei zu übergebende Argumente

Antwort

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

Statuscode: 200 OK

Der Antworttext für einen Linux-Cluster wird mithilfe des SSH-Schlüssels erstellt:

{
	"id": "/subscriptions/{subscription ID}/resourceGroups/rg1/providers/Microsoft.HDInsightCurrent/clusters/mycluster",
	"name": "mycluster",
	"type": "Microsoft.HDInsightCurrent/clusters",
	"location": "East Asia",
	"etag": "{value}",
	"tags": null,
	"properties": {
		"clusterVersion": "3.5.1000.0",
		"osType": "Linux",
		"clusterDefinition": {
			"kind": "hadoop"
		},
		"computeProfile": {
			"roles": [
				{
					"name": "headnode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Standard_D3"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "myuser"
						}
					}
				},
				{
					"name": "workernode",
					"targetInstanceCount": 2,
					"hardwareProfile": {
						"vmSize": "Standard_D3"
					},
					"osProfile": {
						"linuxOperatingSystemProfile": {
							"username": "myuser"
						}
					}
				}
			]
		},
		"provisioningState": "InProgress",
		"clusterState": "Accepted",
		"createdDate": "2016-11-15T09:21:47.61",
		"quotaInfo": {
			"coresUsed": 16
		},
		"tier": "standard"
	}
}
Elementname type BESCHREIBUNG
provisioningState String Gibt den aktuellen Bereitstellungsstatus an.
clusterState String Gibt den ausführlicheren HDInsight-Clusterstatus an, während die Bereitstellung ausgeführt wird.
createdDate Date Datetime, wenn die Anforderung zum Erstellen des Clusters empfangen wurde
quotaInfo Komplexer Typ Gibt die vom Cluster bereitgestellten Kerne an.
errors Array von Fehlermeldungen Enthält die Fehlermeldung if provisioningState = 'failed'
connectivityEndpoints Komplexer Typ Gibt die öffentlichen Endpunkte für den Cluster an.

connectivityEndpoints

Elementname type BESCHREIBUNG
name String Anzeigename für den Konnektivitätsendpunkt
Protokoll String Gibt das zu verwendende Protokoll an (Beispiel: HTTPS, SSH)
location String Gibt die URL an, die eine Verbindung hergestellt werden soll.
port INT Gibt den Port an, für den eine Verbindung hergestellt werden soll.

Löschen

Löscht einen HDInsight-Cluster.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

HTTP 202 (Akzeptiert), um anzugeben, dass der Vorgang asynchron abgeschlossen wird. Die asynchrone Abfrage gibt den Wert 204 (NoContent) zurück, sobald der Vorgang erfolgreich abgeschlossen wurde.

Hinweise

Informationen zum Nachverfolgen des Fortschritts einer Löschclusteranforderung finden Sie unter Asynchrone Vorgänge (202 Accepted und Location header)

Get

Ruft die Details/Eigenschaften des angegebenen Clusters ab.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

Der Vorgang gibt 200 (OK) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde.

Statuscode: 200 OK

Der Antworttext ist identisch mit dem Erstellen eines Clusters.

Antworttext für Linux-Clusterdetails

{  
    "id":"/subscriptions/{subscription-id}/resourceGroups/myresourcegroup1/providers/Microsoft.HDInsight/clusters/mycluster",  
  "name":"mycluster",   
  "type":"Microsoft.HDInsight/clusters",  
  
    "location": "location-name",  
    "tags": { "tag1": "value1", "tag2": "value2" },  
    "properties": {  
        "clusterVersion": "3.2",  
        "osType": "Linux",  
		"provisioningState": "InProgress",  
		"clusterState": "Accepted",  
		"createdDate": "2015-09-23",  
		"quotaInfo": {  
			"coresUsed": 20  
}  
        "clusterDefinition": {  
            "kind": "hadoop"  
        },  
  
        "computeProfile": {  
            "roles": [  
                {  
                    "name": "headnode",  
  
                    "targetInstanceCount": 2,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
                    "osProfile": {  
                       "linuxOperatingSystemProfile": {  
                          "username": "sshuser"  
                       }  
                     }  
  
                },  
                {  
                    "name": "workernode",  
  
                    "targetInstanceCount": 1,  
  
                    "hardwareProfile": {  
                        "vmSize": "Large"  
                    },  
  
                    "osProfile": {  
                       "linuxOperatingSystemProfile": {  
                          "username": "sshuser"  
                       }  
                     }  
  
                },  
                {  
                    "name": "zookeepernode",  
  
                    "targetInstanceCount": 3,  
  
                    "hardwareProfile": {  
                        "vmSize": "Small"  
                    },  
  
                    "osProfile": {  
                       "linuxOperatingSystemProfile": {  
                          "username": "sshuser"  
                       }  
                     }  
                }  
            ]  
        }  
    }  
}
Elementname type BESCHREIBUNG
provisioningState String Gibt den aktuellen Bereitstellungsstatus an.
clusterState String Gibt den ausführlicheren HDInsight-Clusterstatus an, während die Bereitstellung ausgeführt wird.
createdDate Date Datetime, zu dem die Clustererstellungsanforderung empfangen wurde
quotaInfo Komplexer Typ Gibt die vom Cluster bereitgestellten Kerne an.
errors Array von Fehlermeldungen Enthält die Fehlermeldung if provisioningState = 'failed'
connectivityEndpoints Komplexer Typ Gibt die öffentlichen Endpunkte für den Cluster an.

connectivityEndpoints

Elementname type BESCHREIBUNG
name String Anzeigename für den Konnektivitätsendpunkt
Protokoll String Gibt das zu verwendende Protokoll an (Beispiel: HTTPS, SSH)
location String Gibt die URL für die Verbindung an.
port INT Gibt den Port an, für den eine Verbindung hergestellt werden soll.

Listenkonfigurationen

Ruft alle Clusterkonfigurationsdetails ab (einschließlich vertraulicher Informationen).

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

HTTP 200 (OK) nach erfolgreichem Abschluss des Vorgangs.

Beispielantwort:

"configurations":   
{  
     "gateway": {  
          "restAuthCredential.isEnabled": true,  
          "restAuthCredential.username": "username",  
          "restAuthCredential.password": "Password123!"     
      },  
  
      "core-site": {  
           "fs.defaultFS": "wasbs://mycontainter@mystorageaccount.blob.core.windows.net",
	   "fs.azure.account.key.mystorageaccount.blob.core.windows.net": "storagekey1value"  
      }  
}
Elementname type BESCHREIBUNG
Konfigurationen Wörterbuch Dieses Element ist ein Wörterbuch des Konfigurationstyps und des zugehörigen Wertwörterbuchs.
Der Gatewaykonfigurationstyp wird verwendet, um den HTTP-Benutzer zu konfigurieren, der für die Verbindung mit Web-APIs und dem Ambari-Portal verwendet wird.
Core-Site-Konfigurationstyp wird verwendet, um das Standardspeicherkonto für den Cluster zu konfigurieren.

Abrufen der Konfiguration

Ruft Details zu einem einzelnen Konfigurationstyp ab (ohne vertrauliche Werte).

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

HTTP 200 (OK) nach erfolgreichem Abschluss des Vorgangs.

Beispielantwort:

{
     "core-site": {  
          "fs.defaultFS": "wasbs://mycontainter@mystorageaccount.blob.core.windows.net",
	  "fs.azure.account.key.mystorageaccount.blob.core.windows.net": ""
     }
}

Gatewayeinstellungen abrufen

Dieser Vorgang ruft HTTP-Anmeldeinformationen des Clustergateways ab.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

HTTP 200 (OK) nach erfolgreichem Abschluss des Vorgangs.

Beispielantwort:

{  
     "restAuthCredential.isEnabled": true,  
     "restAuthCredential.username": "username",  
     "restAuthCredential.password": "Password123!"  
}

Aktualisieren der Gatewayeinstellungen

Mit diesem Vorgang können Benutzer die HTTP-Anmeldeinformationen des Clustergateways ändern.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
POST https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/updateGatewaySettings?api-version={api-version} 
{  
     "restAuthCredential.isEnabled": true,  
     "restAuthCredential.username": "username",  
     "restAuthCredential.password": "Password123!"  
}

Antwort

HTTP 202 (Akzeptiert) nach erfolgreichem Abschluss des Vorgangs.

Ändern der Konnektivitätseinstellungen (VERALTET)

Mit diesem Vorgang können Benutzer die HTTPS-Konnektivität mit dem Cluster aktivieren/deaktivieren.

Verwenden Sie stattdessen updateGatewaySettings .

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

So aktivieren Sie die Konnektivität

{  	
   "restAuthCredential.isEnabled": true,  	
   "restAuthCredential.username": "user",  	
   "restAuthCredential.password": "password here"  
}

Auflisten nach Ressourcengruppe

Listen alle Cluster im Abonnement des Benutzers in der angegebenen Ressourcengruppe.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
GET https://management.azure.com/subscriptions/{subscription Id}/resourcegroups/{resourceGroup Id}/providers/Microsoft.HDInsight/clusters?api-version={api-version}

Antwort

Der Vorgang gibt 200 (OK) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde.

Statuscode: 200 OK

Antworttext ist ein Array von Clusterdetails. Weitere Informationen finden Sie unter Abrufen von Clustereigenschaften.

{  
  "value": [  
		{ Cluster details }  
    ]  
}

Liste nach Abonnement

Listen alle Cluster im Abonnement des Benutzers.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
GET https://management.azure.com/subscriptions/{subscription Id}/providers/Microsoft.HDInsight/clusters?api-version={api-version}

Antwort

Der Vorgang gibt 200 (OK) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde.

Statuscode: 200 OK

Antworttext ist ein Array von Clusterdetails.

{  
  "value": [  
		{ Cluster details }  
    ]  
}

So deaktivieren Sie die Konnektivität

{  
   "restAuthCredential.isEnabled": false  
}
Elementname Erforderlich Typ BESCHREIBUNG
restAuthCredential.isEnabled Ja Boolean Gibt an, ob die Konnektivität aktiviert oder deaktiviert werden soll.
restAuthCredential.username Nein String Erforderlich, wenn isEnabled=true
Gibt den Benutzernamen für Konnektivitätseinstellungen an.
restAuthCredential.password Nein String Erforderlich, wenn isEnabled=true
Gibt das Kennwort für Konnektivitätseinstellungen an.

Antwort

HTTP 202 (Akzeptiert), um anzugeben, dass der Vorgang asynchron abgeschlossen wird. Die asynchrone Abfrage gibt den Wert 204 (NoContent) zurück, sobald der Vorgang erfolgreich abgeschlossen wurde.

Hinweise

Informationen zum Nachverfolgen des Fortschritts einer Löschclusteranforderung finden Sie unter Asynchrone Vorgänge (202 Accepted und Location header)

Ändern von RDP-Einstellungen (nur Windows-Cluster)

Mit diesem Vorgang kann ein Benutzer RDP aktivieren/deaktivieren. Sie gilt für Windows-basierte Cluster.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Anforderungstext

So aktivieren Sie RDP

{  
	"osProfile": {  
        "windowsOperatingSystemProfile": {  
        	"rdpSettings": {  
        	      "username": "username",  
            	      "password": "password here",  
            	      "expiryDate": "YYYY-MM-DD"  
        	}  
        }  
    }  
}

So deaktivieren Sie RDP

{  
	"osProfile": {  
        "windowsOperatingSystemProfile": {  
        	"rdpSettings": null  
        }  
    }  
}

osProfile

Elementname Erforderlich Typ BESCHREIBUNG
windowsOperatingSystemProfile No Komplexer Typ Gibt Windows-betriebssystembezogene Einstellungen an

windowsOperatingSystemProfile

Elementname Erforderlich Typ BESCHREIBUNG
rdpSettings No Komplexer Typ Gibt RDP-Einstellungen für Windows-Cluster an

rdpSettings

Elementname Erforderlich Typ BESCHREIBUNG
username Ja String Gibt den RDP-Benutzernamen an.
password Ja String Gibt das Kennwort für den RDP-Benutzer an.
expiryDate Ja Date Ablaufdatum für die RDP-Anmeldeinformationen

Antwort

Der Vorgang gibt 200 (OK) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde.

Statuscode: 200 OK

Der Antworttext ist mit dem Erstellen eines Clusters identisch.

Ausführen von Skriptaktionen in einem ausgeführten Cluster (nur Linux-Cluster)

Führen Sie die Skriptaktion für einen ausgeführten Cluster aus.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Anforderungstext

{  
  "scriptActions": [  
    {  
      "name": "script-name",  
      "uri": "script-uri",  
      "parameters": "script-parameters",  
      "roles": [  
        "headnode",  
        "workernode"  
      ]  
    },  
    ...  
  ],  
  "persistOnSuccess": true  
}

scriptActions

Elementname Erforderlich Typ BESCHREIBUNG
name Ja String Gibt den Namen der Skriptaktion an.
uri Ja String Gibt den URI der Skriptaktion an.
parameters Ja String Gibt die parameter an, die für die Skriptaktion erforderlich sind.
roles Yes Ein Zeichenfolgenarray. Gibt die Zielrollen an, für die die Skriptaktion ausgeführt wird.
persistOnSuccess Ja Boolean Gibt an, ob die Skriptaktionen nach erfolgreichen Ausführungen beibehalten werden.

Antwort

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

Statuscode: 202 (Akzeptiert)

Auflisten aller persistenten Skriptaktionen für einen Cluster (nur Linux-Cluster)

Dieser Vorgang gibt alle persistenten Skriptaktionen des angegebenen Clusters zurück.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

HTTP 200 (OK) nach erfolgreichem Abschluss des Vorgangs.

Statuscode: 200 OK

Beispielantwort:

{  
"value":  
[  
  {  
    "name":"script-name",  
    "uri":"script-uri",  
    "parameters":"script-parameters",  
    "roles":["headnode","workernode"],  
    "applicationName":null  
  },  
  ...  
]  
}
Elementname type BESCHREIBUNG
name String Gibt den Namen der Skriptaktion an.
uri String Gibt den URI der Skriptaktion an.
parameters String Gibt die parameter an, die für die Skriptaktion erforderlich sind.
roles Ein Zeichenfolgenarray. Gibt die Zielrollen an, für die die Skriptaktion ausgeführt wird.
applicationName String Gibt die entsprechende Anwendung an, der das Skript zugeordnet ist. applicationName ist NULL, wenn das Skript von Benutzern bereitgestellt wird.

Entfernen einer persistenten Skriptaktion für einen Cluster (nur Linux-Cluster)

Durch diesen Vorgang wird eine persistente HDInsight-Skriptaktion für einen Cluster entfernt.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

  • HTTP 200 (OK), um anzugeben, dass die Skriptaktion aus der Liste der persistenten Skriptaktionen entfernt wurde.

  • HTTP 404 (NotFound), um anzugeben, dass keine persistente Skriptaktion mit dem entsprechenden scriptName vorhanden ist.

Abrufen der Skriptaktionsausführung aus dem Verlauf (nur Linux-Cluster)

Dieser Vorgang gibt die neueste Skriptaktionsausführung des angegebenen Clusters oder der Ausführungsdetails für eine einzelne Skriptausführung zurück.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Antwort

Der Vorgang gibt 200 (OK) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde. Antworttext ist ein Array von Skriptausführungsdetails oder einzelne Skriptausführungsdetails, wenn scriptExecutionId bereitgestellt wird. Im Folgenden finden Sie ein Beispiel für ein Skriptausführungsdetail.

Statuscode: 200 (OK)

Beispielantwort:

{  
  "scriptExecutionId":script-execution-id,  
  "name":"script-name",  
  "applicationName":null,  
  "uri":"script-uri",  
  "parameters":"script-parameters",  
  "roles":["headnode","workernode"],  
  "startTime":"2016-02-26T23:49:13.0773637Z",  
  "endTime":"2016-02-26T23:49:33.4964725Z",  
  "status":"Succeeded",  
  "operation":"PostClusterCreateScriptActionRequest",  
  "executionSummary":  
	[{"status":"COMPLETED",  
	 "instanceCount":4}],  
  "debugInformation": "debug-information"  
}
Elementname type BESCHREIBUNG
scriptExecutionId Long Gibt die Ausführungs-ID der Skriptaktion an.
name String Gibt den Namen der Skriptaktion an.
applicationName String Gibt die entsprechende Anwendung an, der das Skript zugeordnet ist. applicationName ist NULL, wenn das Skript von Benutzern bereitgestellt wird.
uri String Gibt den URI der Skriptaktion an.
parameters String Gibt die parameter an, die für die Skriptaktion erforderlich sind.
roles Ein Zeichenfolgenarray. Gibt die Zielrollen an, für die die Skriptaktion ausgeführt wird.
startTime Datetime Gibt die Startzeit der Skriptaktionsausführung an.
endTime Datetime Gibt die Endzeit der Ausführung der Skriptaktion an.
status String Gibt die status der Ausführung der Skriptaktion an.
operation String Gibt den Grund an, warum die Skriptaktion ausgeführt wurde. ScaleUp bedeutet beispielsweise, dass die Skriptaktion während der Clusterskalierung ausgeführt wurde.
executionSummary Array des komplexen Typs Gibt die Zusammenfassung der Ausführung in Bezug darauf an, wie viele Hosts erfolgreich waren und wie viele Hosts das Skript nicht ausführen konnten.
debugInformation String Gibt detaillierte Debuginformationen für das Skript an. debugInformation wird nur zurückgegeben, wenn eine scriptExecutionId in der Anforderung bereitgestellt wird.

executionSummary

Elementname type BESCHREIBUNG
status String Gibt die status der Ausführung auf einzelnen Hosts an.
instanceCount Int Gibt die Anzahl der Ausführungen mit entsprechenden status an.

Heraufstufen eines Skripts aus dem Skriptaktionsausführungsverlauf, um beibehalten zu werden (nur Linux-Cluster)

Bei diesem Vorgang wird ein HDInsight-Skript aus dem Skriptausführungsverlauf beibehalten.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

Methode Anforderungs-URI
POST https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/scriptExecutionHistory/{script Execution Id}/promote?api-version={api-version}

Antwort

  • HTTP 200 (OK), um anzugeben, dass die Skriptaktion höhergestuft wurde.

  • HTTP 404 (NotFound), um anzugeben, dass keine Skriptaktionsausführung mit der entsprechenden scriptExecutionId vorhanden ist.

Größe ändern

Ändert die Größe eines vorhandenen HDInsight-Clusters.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Im Folgenden sehen Sie eine Beispielanforderung zum Aktualisieren von Tags für einen Cluster.

{  
    "targetInstanceCount": 10  
}
Elementname Erforderlich Typ BESCHREIBUNG
targetInstanceCount Yes Int Gibt die anzahl der neuen instance für die Rolle an.

Antwort

HTTP 202 (Akzeptiert), um anzugeben, dass der Vorgang asynchron abgeschlossen wird. Die asynchrone Abfrage gibt den Wert 204 (NoContent) zurück, sobald der Vorgang erfolgreich abgeschlossen wurde.

Hinweise

Informationen zum Nachverfolgen des Fortschritts einer Löschclusteranforderung finden Sie unter Asynchrone Vorgänge (202 Accepted und Location header)

Aktualisieren

Updates Tags für einen Cluster.

Alle anderen Updates sind separate Aktionen, die separat beschrieben werden.

Anforderung

Weitere Informationen finden Sie unter Allgemeine Parameter und Header für Header und Parameter, die von Clustern verwendet werden.

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

Im Folgenden sehen Sie eine Beispielanforderung zum Aktualisieren von Tags für einen Cluster.

{   
    "tags": {"department": "finance"}  
}
Elementname Erforderlich Typ BESCHREIBUNG
tags Ja String Gibt die Tags an, die dem Cluster zugewiesen werden. Weitere Informationen zur Verwendung von Tags finden Sie unter Verwenden von Tags zum Organisieren Ihrer Azure-Ressourcen.

Antwort

Der Vorgang gibt 200 (OK) zurück, wenn die Anforderung erfolgreich abgeschlossen wurde.

Statuscode: 200 OK

Der Antworttext ist mit dem Erstellen eines Clusters identisch.