OpenAPI¶

观测云支持通过调用 Open API 接口获取和更新工作空间数据。

关于 API 详细清单，可参考 观测云 OpenAPI 文档库。

认证方式¶

在调用 API 接口前，需要先创建 API Key 作为认证方式。

接口采用 API Key 作为认证方式，通过请求头中的 DF-API-KEY 字段验证请求的有效性，并确定请求所属的工作空间（基于该 API Key 所属的工作空间）。

所有 GET 请求（用于数据查询和获取）仅需在请求头中提供 DF-API-KEY 作为认证凭证。

请求结构¶

示例：删除仪表板（POST 请求）

curl -X POST "https://openapi.guance.com/api/v1/dashboard/dsbd_922428e594ba44ce87229b8ca3007a90/delete" \
-H "Content-Type: application/json" \
-H "DF-API-KEY: ${DF_API_KEY}"

示例：验证接口（GET 请求）

curl -X GET "https://openapi.guance.com/api/v1/validate" \
-H "Content-Type: application/json" \
-H "DF-API-KEY: ${DF_API_KEY}"

注意：系统简化了 HTTP 请求方式，仅使用 GET 和 POST 两种。GET 用于数据获取类请求（如“获取仪表板列表”），POST 用于数据变更类请求（如“创建仪表板”或“删除仪表板”）。

接入地址 Endpoint¶

注意：私有部署版也支持 openapi 接入，具体以实际部署的 Endpoint 为准。

接口路由地址规范¶

接口路由一般遵循以下命名规范：

例如：

• 仪表板列表获取：/api/v1/dashboard/list
• 创建一个仪表板：/api/v1/dashboard/create
• 获取一个仪表板：/api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/get
• 删除一个仪表板：/api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/delete
• 修改一个仪表板：/api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/modify
• 主机对象列表获取：/api/v1/object/host/list
• 进程对象列表获取：/api/v1/object/process/list

注意：路由中的 v1 为接口版本号，每个发布版本的接口，都需要向前兼容。如有不兼容的接口变更或重大业务调整，需增加版本号。

返回结果¶

接口返回遵循 HTTP 请求响应规范：

• 正常请求返回 HTTP 状态码 200
• API Key 验证失败返回 HTTP 状态码 403
• 服务端无法处理或未知错误返回 HTTP 状态码 500
• 其他错误（如无权限访问数据或找不到操作对象）分别返回 403 和 404 等。具体错误定义见下文。

响应结果示例¶

{
    "code":200,
    "content":{

    },
    "pageInfo": {
        "count": 20,
        "pageIndex": 1,
        "pageSize": 100,
        "totalCount": 10
    },
    "errorCode":"",
    "message":"",
    "success":true,
    "traceId":"3412000720344969928"
}

公共响应结果参数¶

公共错误定义¶

更多关于 API 接口列表，可参考 OpenAPI 文档库。