Help Center/ MapReduce Service/ Developer Guide (LTS)/ Manager Management Development Guide/ More Information/ External Interfaces/ Java API
Updated on 2022-11-18 GMT+08:00
View PDF

Java API

Typical APIs

Table 1 describes the typical methods of developing FusionInsight Manager REST APIs.

Table 1 restApiDemo.src.rest.BasicAuthAcces

Method

Description

loginAndAccess (String webUrl,String userName,String password,String userTLSVersion)
  • webUrl

    URL of the cluster home page, which is obtained from the UserInfo.properties configuration file.

  • userName

    Username for logging in to the FusionInsight system, which is obtained from the UserInfo.properties configuration file.

  • password

    Password of the account userName, which is obtained from the UserInfo.properties configuration file.

  • userTLSVersion

    TSL version.

Return type: HttpClient

Return: HttpClient
  • The Java API implements basic authentication for login and returns the HttpClient after login. This way, only one API is invoked during the login, simplifying the usage process.
  • The API input parameters are obtained from the configuration file UserInfo.properties. Users need to set the parameters in the file. The Java API also invokes multiple methods of the BasicAuthAccess class.
Table 2 restApiDemo.src.rest.BasicAuthAcces.HttpManager

Method

Description

sendHttpGetRequest(HttpClient httpClient, String operationUrl, String operationName)
  • Parameter type: HttpClient

    httpCient: result returned after the login authentication is complete.

  • operationUrl

    URL of the httpGet operation.

  • operationName

    The operation name.

sendHttpPostRequest(HttpClient httpClient, String operationUrl, String jsonFilePath, String operationName)
  • Parameter type: HttpClient

    httpCient: result returned after the login authentication is complete.

  • operationUrl

    URL of the httpPost operation.

  • jsonFilePath

    JSON file corresponding to the httpPost operation.

  • operationName

    The operation name.

sendHttpPostRequestWithString(HttpClient httpClient, String operationUrl, String jsonString, String operationName)
  • Parameter type: HttpClient

    httpCient: result returned after the login authentication is complete.

  • operationUrl

    URL of the httpPost operation.

  • jsonString

    JSON string format corresponding to the httpPost operation.

  • operationName

    The operation name.

sendHttpPutRequest(HttpClient httpclient, String operationUrl, String jsonFilePath, String operationName)
  • Parameter type: HttpClient

    httpCient: result returned after the login authentication is complete.

  • operationUrl

    URL of the httpPut operation.

  • jsonFilePath

    JSON file corresponding to the httpPut operation.

  • operationName

    The operation name.

sendHttpPutRequestWithString(HttpClient httpclient, String operationUrl, String jsonString, String operationName)
  • Parameter type: HttpClient

    httpCient: result returned after the login authentication is complete.

  • operationUrl

    URL of the httpPut operation.

  • jsonString

    JSON string format corresponding to the httpPut operation.

  • operationName

    The operation name.

sendHttpDeleteRequest(HttpClient httpClient, String operationUrl, String jsonString, String operationName)
  • Parameter type: HttpClient

    httpCient: result returned after the login authentication is complete.

  • operationUrl

    URL of the httpDelete operation.

  • jsonString

    JSON string format corresponding to the httpDelete operation.

  • operationName

    The operation name.
  • APIs in the table are used to send HTTP requests. To invoke the APIs, users only need to provide the URLs corresponding to each type of operations, and JSON files corresponding to the operations or JSON string formats. In this way, no intermediate execution code is required, reducing the code compilation workload and simplifying operation procedures.
  • The APIs return the command ID corresponding to the requests. Based on the command IDs, users can query the command execution progress.
Parent topic: External Interfaces