文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面标签/ 查询桌面标签
更新时间：2024-09-05 GMT+08:00
查看PDF
分享

查询桌面标签

功能介绍

查询指定桌面的标签信息

调试

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

URI

GET /v2/{project_id}/desktops/{desktop_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

desktop_id

是

String

桌面id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

Content-Type

否

String

发送的实体的MIME类型

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of Tag objects

标签
表4 Tag

参数

参数类型

描述

key

String

标签的键，不能为空，最大长度128个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value

String

标签的值，最大长度43个unicode字符。大小写字母，数字，可以包含中划线“-”，下划线“_”，不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

状态码： default

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

/v2/{project_id}/desktops/{desktop_id}/tags

{
  "tags" : [ {
    "key" : "string",
    "values" : [ "string" ]
  } ]
}

响应示例

无

状态码

状态码

描述

200

查询桌面标签

default

异常响应

错误码

请参见错误码。

父主题： 桌面标签

相关文档