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 |
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 -X GET "https://{customer.name}.hiperai.ai/api/external/health"
注释
- 该端点不需要身份验证
- 使用此端点监控API可用性
- 响应包括当前 API 版本以进行兼容性检查