文档首页/ 自动驾驶云服务 Octopus/ API参考/ API/ 通用存储自定义属性/ 获取通用存储自定义属性列表-GetDataWarehouseCustomAttributeList
更新时间：2026-04-30 GMT+08:00
查看PDF
分享

获取通用存储自定义属性列表-GetDataWarehouseCustomAttributeList

功能介绍

获取通用存储自定义属性列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    octopus:dataWarehouse:list

    List

    workspace *

    -

    -

    -

URI

GET /v1.0/{project_id}/common/warehouses/custom-attributes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

只能用小写字母 a-z 和数字 0-9组成，且长度为32个字符

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：

工作空间id

约束限制：

不涉及

取值范围：

小写带横杠UUID或小写无横杠UUID或单个0

默认取值：

不涉及

offset

否

Integer

参数解释：

查询偏移量

约束限制：

与limit配合使用

取值范围：

最小值为0

默认取值：

0

limit

否

Integer

参数解释：

返回个数上限

约束限制：

与offset配合使用

取值范围：

最小值为1，最大值为50

默认取值：

10

key

否

String

参数解释：

根据自定义属性key值模糊查询

约束限制：

不涉及

取值范围：

只能用中文字符、大小写英文字母、数字、“_”、“-”组成，且长度为[0~256]个字符

默认取值：

不涉及

value

否

String

参数解释：

根据自定义属性value值模糊查询

约束限制：

不涉及

取值范围：

只能用中文字符、大小写英文字母、数字、“_”、“-”组成，且长度为[0~256]个字符

默认取值：

不涉及

order

否

String

参数解释：

排序类型

约束限制：

不涉及

取值范围：

  • KEY：按自定义属性key值升序排列

  • CREATE_TIME：按自定义属性创建时间降序排列

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

payload

CustomAttributePayload object

参数解释：

实际返回信息

meta_info

MetaInfo object

参数解释：

元数据
表5 CustomAttributePayload

参数

参数类型

描述

list

Array of CustomAttribute objects

参数解释：

自定义属性列表

page_info

PageInfo object

参数解释：

分页信息
表6 CustomAttribute

参数

参数类型

描述

id

String

参数解释：

id

取值范围：

不涉及

key

String

参数解释：

属性名称

取值范围：

不涉及

value

String

参数解释：

属性值

取值范围：

不涉及

workspace_id

String

参数解释：

工作空间id

取值范围：

不涉及

project_id

String

参数解释：

项目id

取值范围：

不涉及

create_at

Long

参数解释：

创建时间，UTC标准时间毫秒时间戳

取值范围：

不涉及
表7 PageInfo

参数

参数类型

描述

total

Long

参数解释：

资源总数

取值范围：

不涉及

offset

Long

参数解释：

查询偏移量

取值范围：

不涉及

limit

Long

参数解释：

返回个数上限

取值范围：

不涉及
表8 MetaInfo

参数

参数类型

描述

current_time

String

参数解释：

请求时间，UTC时间格式，时间为UTC标准时间

取值范围：

不涉及

请求示例

获取通用存储自定义属性列表

GET https://{endpoint}/v1.0/{project_id}/common/warehouses/custom-attributes?offset=0&limit=10&key=my_key&value=my_value&order=CREATE_TIME&workspace_id=0

响应示例

状态码：200

查询成功

获取通用存储自定义属性列表

{
  "meta_info" : {
    "current_time" : "2024-01-02T02:04:22Z"
  },
  "payload" : {
    "list" : [ {
      "id" : "fda663d2-bf55-4a88-8084-bfab11999ca5",
      "key" : "KEY",
      "value" : "VALUE",
      "project_id" : "PROJECT_ID",
      "create_at" : 1700464517072
    } ],
    "page_info" : {
      "total" : 1,
      "offset" : 0,
      "limit" : 1
    }
  }
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码。

相关文档