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

获取桶列表

功能介绍

获取桶列表(包含当前空间桶和引用空间桶)。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/buckets

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

String

参数解释

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

project_id

String

参数解释

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

约束限制

不涉及

取值范围

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

默认取值

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

count

Integer

参数解释

桶个数。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

buckets

Array of ProjectBucketRsp objects

参数解释

桶列表。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表4 ProjectBucketRsp

参数

参数类型

描述

eihealth_project_id

String

参数解释

空间编号。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

eihealth_project_name

String

参数解释

空间名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

type

String

参数解释

桶类型。

约束限制

不涉及

取值范围

  • real:空间桶

  • quote:引用桶

默认取值

不涉及

quote_root

Boolean

参数解释

是否引用桶根路径。

约束限制

不涉及

取值范围

  • true:引用桶根路径

  • false:非引用桶根路径

默认取值

不涉及

请求示例

获取桶列表。

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

响应示例

状态码:200

OK

{
  "count" : 1,
  "buckets" : [ {
    "eihealth_project_id" : "a1decfc3-ef88-4dd3-9c23-62d05c26b288",
    "eihealth_project_name" : "test-project-01",
    "type" : "real"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档