取得

稼働状況を取得します。

Request Interface

HTTP Request

GET /service/status

Parameter

リクエストパラメータはありません。

Authorization

Management Console の [API キー管理] 画面の「スコープ」で、「サービス稼働状況」の「取得」を選択する必要があります。

Response Interface

リクエストが正常に処理された場合、以下の JSON フォーマットでレスポンスを返却します。

{
    "totalSize":6,
    "fetchSize":6,
    "startIndex":0,
    "maxResults":6,
    "totalStatus":"0",
    "serviceStatus":[
        {
            "region":"California",
            "endpoint":"california-service1.webconnect.hulft.com",
            "status":"0"
        },
            .
            .
            .
        {
            "region":"Tokyo",
            "endpoint":"service2.tokyo.webconnect.hulft.com",
            "status":"0"
        },
    "dataTransferSiteStatus":[
        {
            "region":"California",
            "endpoint":"california-ap.webconnect.hulft.com",
            "status":"0"
        },
            .
            .
            .
        {
            "region":"Tokyo",
            "endpoint":"service-ap.tokyo.webconnect.hulft.com",
            "status":"0"
        }
    ]
}

Property Name

Value

Description

totalSize

integer

The total number of data (endpoints of Agent, CLI and Data Transfer Site)

fetchSize

integer

The number of the obtained data

startIndex

integer

Index of the first row of a data to retrieve

maxResults

integer

The maximum number of indexes included in a response data

totalStatus

sting

Operation status of the HULFT-WebConnect service (0: Operating normally, 1: Service disruption, 9: Performance issues)

serviceStatus

array

Array of the elements described below

region

string

Region of the access point to HULFT-WebConnect of Agent / CLI

endpoint

string

Access point to HULFT-WebConnect of Agent / CLI

status

string

Access point status (0: Operating normally, 1: Service disruption, 9: Performance issues)

dataTransferSiteStatus

array

Array of the elements described below

region

string

Region of the access point to HULFT-WebConnect of Data Transfer Site

endpoint

string

Access point to HULFT-WebConnect of Data Transfer Site

status

string

Access point status (0: Operating normally, 1: Service disruption, 9: Performance issues)

Examples

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/service/status");
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        connection.setRequestMethod("GET");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/service/status',
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});