Health Check
curl --request GET \
--url https://secureai.hiperai.ai/api/external/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}導入 & セットアップ
健康診断
Check if the API is running and healthy. No authentication required.
GET
/
health
Health Check
curl --request GET \
--url https://secureai.hiperai.ai/api/external/health \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/health"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}健康診断
API が実行中で正常であるかどうかを確認します。認証は必要ありません。エンドポイント
GET /health
説明
このエンドポイントを使用すると、SecureAI 外部 API が実行されており、正常であることを確認できます。このエンドポイントには認証は必要ありません。リクエスト
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
応答
成功の応答 (200)
{
"success": true,
"status": "healthy",
"timestamp": "2024-01-15T10:30:00.000Z",
"version": "1.0.0"
}
応答フィールド
| フィールド | タイプ | 説明 | 例 |
|---|---|---|---|
success | ブール値 | ヘルスチェックが成功した場合は常に true | true |
status | 文字列 | API の健全性ステータス | "healthy" |
timestamp | 文字列 | ISO 8601 形式の現在のサーバーのタイムスタンプ | "2024-01-15T10:30:00.000Z" |
version | 文字列 | 現在の API バージョン | "1.0.0" |
使用例
JavaScript/Node.js
const response = await fetch('https://{customer.name}.hiperai.ai/api/external/health');
const data = await response.json();
console.log('API Status:', data.status);
パイソン
import requests
response = requests.get('https://{customer.name}.hiperai.ai/api/external/health')
data = response.json()
print('API Status:', data['status'])
cURL
curl -X GET "https://{customer.name}.hiperai.ai/api/external/health"
注意事項
- このエンドポイントは認証を必要としません
- このエンドポイントを使用して API の可用性を監視します
- 応答には、互換性チェックのための現在の API バージョンが含まれます