文档首页/ 自动驾驶云服务 Octopus/ API参考/ API/ 数据仓库自定义属性/ 获取数据仓库自定义属性列表
更新时间：2024-02-06 GMT+08:00
查看PDF
分享

获取数据仓库自定义属性列表

功能介绍

获取数据仓库自定义属性列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id，获取方法请参见获取项目ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询偏移量

最小值：0

缺省值：0

limit

否

Integer

返回个数上限

最小值：1

最大值：50

缺省值：10

key

否

String

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

最小长度：0

最大长度：256

value

否

String

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

最小长度：0

最大长度：256

order

否

String

排序类型

缺省值：CREATE_TIME

枚举值：

  • 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

属性值

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

响应示例

状态码： 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" : 100,
      "offset" : 0,
      "limit" : 1
    }
  }
}

状态码

状态码

描述

200

查询成功

400

参数校验失败

500

系统内部错误

错误码

请参见错误码。

相关文档