更新时间:2025-07-08 GMT+08:00
分享

置顶空间

功能介绍

置顶空间。

URI

PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/top

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

String

参数解释

平台空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

最小长度:1

最大长度:128

project_id

String

参数解释

项目ID,您可以从获取项目ID中获取。

约束限制

不涉及

取值范围

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值

不涉及

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

最小长度:1

最大长度:32768

表3 请求Body参数

参数

是否必选

参数类型

描述

is_top

Boolean

参数解释

是否置顶。

约束限制

不涉及

取值范围

  • true: 表示置顶。

  • false: 表示取消置顶。

默认取值

不涉及

响应参数

状态码:200

OK

请求示例

空间更新为置顶状态。

https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/top

{
  "is_top" : true
}

响应示例

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档