如何使用 OpenAPI
如何调用控制台 OpenAPI
- 在调用控制台 OpenAPI 前,需要用户在平台右上角,点击个人中心-访问令牌-新增,创建访问令牌用于授权
- 在调用控制台 OpenAPI 前,确保已获取 API 所需的访问令牌,并加入到请求 Header 中
- OpenAPI 文档中只展示相对路径,如
/openapi/v1/administrators
,不展示实际请求路径。需 要将你的控制台访问地址作为与路径拼凑起来,形成完整地址。如http://192.168.2.225:7070/openapi/v1/administrators
OpenAPI 文档约定格式
控制台 OpenAPI 文档格式主要如下:
请求:
基本信息: 介绍 API 是干什么的
请求方法: 介绍 API 所需要的请求方法(POST、PUT、DELETE、GET等)
请求参数: API 所使用的路径参数和查询参数的简要说明
请求体: 这部分参数需要放在 HTTP 请求的 Body 中,一般为 JSON 格式
请求体示例: 对应 API 的成功请求参数的样例
响应:
响应体: 一次 API 调用后,HTTP 响应中 Body 部分的内容
响应体示例: API 成功请求结果的样例
OpenAPI 通用参数说明
以下参数是在调用平台时,经常会使用到的路径参数的说明。
名称 | 位置 | 类型 | 中文名 | 说明 |
---|---|---|---|---|
team_id | path | string | 团队ID | 标识某一个团队的ID,32位字符串 |
app_id | path | int | 应用ID | 标识某个应用,整型 |
service_id | path | string | 组件ID | 标识某一个组件的ID,32位字符串 |
region_name | path | string | 集群唯一标识 | 标识某个集群的名称,在企业下唯一,用户自定义值 |
user_id | path | int | 用户ID | 标识某一个用户的ID,整型 |