Partilhar via

API REST do aplicativo no Azure HDInsight

Create

Cria um novo nó no cluster (conhecido como nó de borda) e instala um aplicativo nesse nó.

Pedido

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

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

O exemplo a seguir mostra o corpo da solicitação para instalar aplicativos em um cluster HDInsight baseado em 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"  
	}  
}
Nome do elemento Obrigatório Tipo Descrição
nome Yes Cordão Especifica o nome do aplicativo. O nome deve ser especificado como clusterName/applicationName. O nome do aplicativo deve ser exclusivo por cluster.
tipo Yes Cordão Especifica o tipo do recurso.
Propriedades Yes Tipo Complexo Especifica as propriedades do cluster.

Propriedades

Nome do elemento Obrigatório Tipo Descrição
computeProfile Yes Tipo Complexo Descreve a VM na qual o aplicativo será executado
InstallScriptActions Yes Tipo Complexo Descreve as ações de script de instalação para o aplicativo. Pelo menos um script deve ser especificado e os scripts devem ser idempotentes, o que significa que os scripts podem ser chamados repetidamente enquanto produzem o mesmo resultado.
UninstallScriptActions Não Tipo Complexo Descreve as ações de script de desinstalação para o aplicativo. Este parâmetro é opcional, mas todas as ações de script de desinstalação especificadas devem ser idempotentes (o que significa que os scripts podem ser chamados repetidamente enquanto produzem o mesmo resultado).
HttpEndpoint Não Tipo Complexo Descreve quais pontos de extremidade no aplicativo devem ser endereçáveis pela Internet.
tipo de aplicação Yes Cordão Este elemento é sempre o valor "CustomApplication"

computeProfile

Este elemento deve conter exatamente uma função

Nome do elemento Obrigatório Tipo Descrição
Função Yes Tipo Complexo Especifica informações sobre funções no cluster
função
Nome do elemento Obrigatório Tipo Descrição
nome Yes Cordão O nome deve ser especificado como "edgenode"
targetInstanceCount Yes Número inteiro Este elemento deve ser definido como 1
hardwareProfile Yes Tipo Complexo Especifica informações sobre o perfil de hardware para o edgenode
hardwareProfile
Nome do elemento Obrigatório Tipo Descrição
vmTamanho Yes Cordão Especifica o tamanho da VM. Consulte as opções de configuração do HDInsight (uma vez neste link, role para baixo até Níveis de preços do Nó) para obter os tamanhos válidos

InstallScriptActions

Nome do elemento Obrigatório Tipo Descrição
Nome Yes Cordão Especifica o nome da ação de script. Deve ser exclusivo em todas as ações de script persistentes no cluster
Uri Yes Cordão Localização acessível publicamente do script. Todos os scripts especificados devem ser idempotentes, o que significa que os scripts podem ser chamados repetidamente enquanto produzem o mesmo resultado.
Parâmetros Não Cordão Conjunto opcional de parâmetros para passar para o script
Funções Yes Matriz de cadeias de caracteres Descreve a função para o script ser executado. Os valores válidos são: headnode, workernode, zookeepernode e edgenode. edgenode é a função que hospeda o aplicativo e onde seu aplicativo será executado.

UninstallScriptActions

Nome do elemento Obrigatório Tipo Descrição
Nome Yes Cordão Especifica o nome da ação de script.
Uri Yes Cordão Localização acessível publicamente do script. Todos os scripts especificados devem ser idempotentes, o que significa que os scripts podem ser chamados repetidamente enquanto produzem o mesmo resultado.
Parâmetros Não Cordão Conjunto opcional de parâmetros para passar para o script
Funções Yes Matriz de cadeias de caracteres Descreve a função para o script ser executado. Os valores válidos são: headnode, workernode, zookeepernode e edgenode. edgenode é a função que hospeda o aplicativo e onde seu aplicativo será executado.

HttpEndpoint

Nome do elemento Obrigatório Tipo Descrição
subDomainSuffix Yes Cordão Uma cadeia de caracteres alfanumérica de três caracteres usada para criar o nome DNS usado para acessar o aplicativo. O nome DNS terá o formato: *.apps.azurehdinsight.net. Esse nome deve ser exclusivo por cluster.
destinationPorto Yes Número inteiro A porta para encaminhar o tráfego HTTP para no edgenode que hospeda seu aplicativo.
accessModes Não Matriz de cadeias de caracteres Metadados sobre o ponto de extremidade. Se o ponto de extremidade hospedar uma página da Web, especifique a página da Web como um modo de acesso. Caso contrário, a matriz deve estar vazia ou não estar presente na carga útil. Esse elemento permite que o portal do Azure exiba links diretos para seu aplicativo.

Resposta

Se a validação for concluída e a solicitação for aceita, a operação retornará 200 (OK).

Código de status: 200 OK

Obter

Obtém detalhes sobre um aplicativo HDInsight.

Pedido

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

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

Resposta

Corpo da resposta é uma matriz de detalhes do aplicativo HDInsight ou um único detalhe do aplicativo HDInsight se applicationName for fornecido. Abaixo está um exemplo de detalhes da aplicação.

Código de resposta: HTTP 200 (OK) após a conclusão bem-sucedida da operação.

Resposta de exemplo:

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

Remove um aplicativo HDInsight do cluster.

Pedido

Consulte Parâmetros e cabeçalhos comuns para cabeçalhos e parâmetros usados por clusters.

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

Resposta

A operação retornará 202 (Aceito) se a solicitação for concluída com sucesso

Código de status: 202 Aceito.

  • Last updated on