デジタル郵便受けの稼働状況監視

デジタル郵便受けは稼働状況のヘルスチェックエンドポイントを公開しています。以下のprotoファイルを使用してgRPCリクエストをこのエンドポイントに送信することで、xIDアプリのデジタル郵便受けの稼働状況を確認でき、稼働状況の監視に利用できます。

gRPCサーバー

grpc://xenon.smartpost.jp:443

protoファイル

以下のコードをコピーし、デジタル郵便受け監視用のprotoファイルに転記してください。

Health/Check メソッドでデジタル郵便受けの稼働状況を確認できます。

healthcheck.proto

syntax = "proto3";

package xenon;

import "google/protobuf/empty.proto";

service Health {
    rpc Check(HealthCheckRequest) returns (HealthCheckResponse);
}

message HealthCheckRequest {
    string service = 1;
}

message HealthCheckResponse {
    enum ServingStatus {
        SERVING = 0;
        NOT_SERVING = 1;
    }
    ServingStatus status = 1;
}

レスポンス

xIDアプリのデジタル郵便受けが正常に稼働している場合、以下のレスポンスが返却されます。

0 OK

{
    "status": "SERVING"
}

何らかの理由により、デジタル郵便受けのサービス提供が停止している場合は、以下のレスポンスが返却されます。

13 INTERNAL

{
    "status": "NOT_SERVING"
}