更新时间:2024-12-20 GMT+08:00
分享

查询资源标签

功能介绍

查询资源标签。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET https://localhost.com/v1/{project_id}/fabric-workspace/{workspace_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

  • 参数解释:项目ID。获取方法,请参见获取项目ID

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

workspace_id

String

  • 参数解释:工作空间ID。

  • 约束限制:不涉及。

  • 取值范围:获取方法,请参见获取工作空间ID

  • 默认取值:不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

  • 参数解释:偏移量,表示从此偏移量开始查询。

  • 约束限制:不涉及。

  • 取值范围:offset大于等于0。

  • 默认取值:默认为0。

limit

Integer

查询记录数默认为1000,limit最多为1000,不能为负数,最小值为1。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

  • 参数解释:租户Token。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

  • 参数解释:请求ID。

  • 约束限制:不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表5 响应Body参数

参数

参数类型

描述

tags

Array of ResourceTag objects

资源标签列表。

sys_tags

Array of SystemTag objects

系统标签列表。

表6 ResourceTag

参数

参数类型

描述

key

String

  • 参数解释:键。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

value

String

  • 参数解释:值。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表7 SystemTag

参数

参数类型

描述

key

String

  • 参数解释:键。

  • 约束限制:固定值。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

value

String

  • 参数解释:企业项目ID。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 408

表10 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

请求示例

响应示例

状态码

状态码

描述

200

workspace下标签信息。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码

相关文档