查询Notebook资源类型下的标签
功能介绍
查询Notebook资源类型下的标签接口用于获取用户当前project下Notebook实例的标签信息。该接口适用于以下场景：用户需要管理或统计Notebook资源时，可通过此接口查询特定标签或所有标签的Notebook实例。使用该接口的前提条件是用户已登录系统并具有访问权限，同时可指定工作空间或默认查询所有工作空间。调用该接口后，系统将返回指定Notebook实例的标签列表，包括标签名称、标签值等信息。若用户无权限，则返回相应的异常信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/notebooks/tags
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID，获取方法请参见获取项目ID和名称。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
tags |
Array of CombineTmsTags objects |
参数解释：标签的融合结构，相同key合并。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释：标签的key。 取值范围：长度限制为128个字符，支持任意语种字母、数字、空格，以及_ . : = + - @特殊字符，但首尾不能含有空格，不能以_sys_开头。 |
|
values |
Array of strings |
参数解释：相同key的标签value合并后的列表。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：ModelArts错误码。 取值范围：不涉及。 |
|
error_msg |
String |
参数解释：具体错误信息。 取值范围：不涉及。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：ModelArts错误码。 取值范围：不涉及。 |
|
error_msg |
String |
参数解释：具体错误信息。 取值范围：不涉及。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：ModelArts错误码。 取值范围：不涉及。 |
|
error_msg |
String |
参数解释：具体错误信息。 取值范围：不涉及。 |
请求示例
https://{endpoint}/v1/{project_id}/notebooks/tags
响应示例
状态码：200
查询项目下Notebook实例类型下的标签，正常返回。
{
"tags" : [ {
"key" : "model_version",
"values" : [ "0.1", "0.2" ]
}, {
"key" : "conda_version",
"values" : [ "10.2", "11.0" ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询项目下Notebook实例类型下的标签，正常返回。 |
|
400 |
参数非法。 |
|
401 |
鉴权失败。 |
|
403 |
权限不足。 |
错误码
请参见错误码。
