连通性测试

功能说明

验证开放平台服务是否可访问，以及 API Key 是否有效。成功后返回服务端时间和 API Key 所属租户编号。

调用说明

地址：

https://www.shudacloud.com/api/open-api/platform/ping

方式：GET

接口编码：platform:ping

鉴权方式：在请求 Header 中传入 X-API-Key。无需传入 tenant-id，服务端会根据 API Key 自动识别所属租户。

本页参数和返回值来自测试环境真实调试；请求示例中的域名已按生产环境填写。当前示例 API Key 仅在测试环境有效。

请求参数

该接口没有 URL Query 参数和请求体。

返回数据

示例

请求示例

curl --request GET \
  --url "https://www.shudacloud.com/api/open-api/platform/ping" \
  --header "X-API-Key: qop_f9f5d23ff4c84e2aa513e37d08780022"

正常返回示例

{
  "code": 0,
  "msg": "",
  "data": {
    "ok": true,
    "serverTime": 1784601668124,
    "tenantId": "449352795579cf33305092ec3e127ae0"
  }
}

常见异常

开放接口的业务异常通常仍返回 HTTP 200，请以响应体中的 code 判断调用是否成功。