API de REST de aplicación en Azure HDInsight

Crear

Crea un nuevo nodo en el clúster (denominado nodo perimetral) e instala una aplicación en ese nodo.

Solicitud

Consulte Parámetros y encabezados comunes para conocer los encabezados y parámetros que usan los clústeres.

Método Solicitud de URI
PON https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/applications/{application Name}?api-version={api-version}

En el ejemplo siguiente se muestra el cuerpo de la solicitud para instalar aplicaciones en un clúster de HDInsight basado en Linux.

{  
  
	"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"  
	}  
}
Nombre del elemento Obligatorio Tipo Descripción
nombre Sí Cuerda Especifica el nombre de la aplicación. El nombre debe especificarse como clusterName/applicationName. El nombre de la aplicación debe ser único por clúster.
tipo Sí Cuerda Especifica el tipo del recurso.
Propiedades Sí Tipo complejo Especifica las propiedades del clúster.

Propiedades

Nombre del elemento Obligatorio Tipo Descripción
computeProfile Sí Tipo complejo Describe la máquina virtual en la que se ejecutará la aplicación
Acciones de InstallScriptActions Sí Tipo complejo Describe las acciones de script de instalación para la aplicación. Se debe especificar al menos un script y los scripts deben ser idempotentes, lo que significa que los scripts se pueden llamar repetidamente mientras producen el mismo resultado.
UninstallScriptActions No Tipo complejo Describe las acciones de script de desinstalación de la aplicación. Este parámetro es opcional, pero cualquier acción de script de desinstalación especificada debe ser idempotente (lo que significa que se puede llamar a los scripts repetidamente mientras se produce el mismo resultado).
HttpEndpoint No Tipo complejo Describe qué extremos de la aplicación deben ser direccionables a Internet.
applicationType Sí Cuerda Este elemento siempre tiene el valor "CustomApplication"

computeProfile

Este elemento debe contener exactamente un rol

Nombre del elemento Obligatorio Tipo Descripción
role Sí Tipo complejo Especifica información sobre los roles en el clúster
rol
Nombre del elemento Obligatorio Tipo Descripción
nombre Sí Cuerda El nombre debe especificarse como "edgenode"
targetInstanceCount Sí Entero Este elemento debe establecerse en 1
hardwareProfile Sí Tipo complejo Especifica información sobre el perfil de hardware para el edgenode
hardwareProfile
Nombre del elemento Obligatorio Tipo Descripción
vmSize Sí Cuerda Especifica el tamaño de la máquina virtual. Consulte Opciones de configuración de HDInsight (una vez en este vínculo, desplácese hacia abajo hasta Planes de tarifa de Node) para conocer los tamaños válidos

Acciones de InstallScriptActions

Nombre del elemento Obligatorio Tipo Descripción
Nombre Sí Cuerda Especifica el nombre de la acción de script. Debe ser único en todas las acciones de script persistentes en el clúster
Uri Sí Cuerda Ubicación de acceso público del script. Todos los scripts especificados deben ser idempotentes, lo que significa que se puede llamar a los scripts repetidamente mientras producen el mismo resultado.
Parámetros No Cuerda Conjunto opcional de parámetros para pasar al script
Funciones Sí Matriz de cadenas Describe el rol en el que se ejecutará el script. Los valores válidos son: headnode, workernode, zookeepernode y edgenode. edgenode es el rol que aloja la aplicación y donde se ejecutará su aplicación.

UninstallScriptActions

Nombre del elemento Obligatorio Tipo Descripción
Nombre Sí Cuerda Especifica el nombre de la acción de script.
Uri Sí Cuerda Ubicación de acceso público del script. Cualquier script especificado debe ser idempotente, lo que significa que los scripts se pueden llamar repetidamente mientras producen el mismo resultado.
Parámetros No Cuerda Conjunto opcional de parámetros para pasar al script
Funciones Sí Matriz de cadenas Describe el rol en el que se ejecutará el script. Los valores válidos son: headnode, workernode, zookeepernode y edgenode. edgenode es el rol que aloja la aplicación y donde se ejecutará su aplicación.

HttpEndpoint

Nombre del elemento Obligatorio Tipo Descripción
subDomainSuffix Sí Cuerda Una cadena alfanumérica de tres caracteres que se usa para crear el nombre DNS que se usa para acceder a la aplicación. El nombre DNS tendrá el formato: *.apps.azurehdinsight.net. Este nombre debe ser único por clúster.
destinationPort Sí Entero El puerto al que se va a reenviar el tráfico HTTP en el edgenode que aloja la aplicación.
accessModes No Matriz de cadenas Metadatos sobre el punto final. Si el extremo hospeda una página web, especifique la página web como modo de acceso. De lo contrario, la matriz debe estar vacía o no estar presente en la carga útil. Este elemento permite a Azure Portal mostrar vínculos directos a la aplicación.

Respuesta

Si se completa la validación y se acepta la solicitud, la operación devolverá 200 (OK).

Código de estado: 200 OK

Obtener

Obtiene detalles sobre una aplicación de HDInsight.

Solicitud

Consulte Parámetros y encabezados comunes para conocer los encabezados y parámetros que usan los clústeres.

Método Solicitud de URI
GET https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/applications/{application Name}?api-version={api-version}

Respuesta

El cuerpo de la respuesta es una matriz de detalles de la aplicación HDInsight o un único detalle de la aplicación HDInsight si se proporciona applicationName. A continuación se muestra un ejemplo de detalle de la aplicación.

Código de respuesta: HTTP 200 (OK) al finalizar correctamente la operación.

Ejemplo de respuesta:

{  
	"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"  
			}  
		]  
	}

Eliminar

Quita una aplicación de HDInsight del clúster.

Solicitud

Consulte Parámetros y encabezados comunes para conocer los encabezados y parámetros que usan los clústeres.

Método Solicitud de URI
ELIMINAR https://management.azure.com/subscriptions/{subscription Id}/resourceGroups/{resourceGroup Name}/providers/Microsoft.HDInsight/clusters/{cluster name}/applications/{application Name}?api-version={api-version}

Respuesta

La operación devolverá 202 (Aceptado) si la solicitud se completa correctamente

Código de estado: 202 Aceptado.

  • Se actualizó por última vez el