查询资源池的所有标签
功能介绍
查询资源池所有标签接口用于获取用户当前项目下资源池的所有标签信息,默认查询所有工作空间,但无权限的工作空间不会返回标签数据。该接口适用于以下场景:当需要管理、分类或统计资源池的标签信息时,用户可通过此接口获取资源池的标签数据。使用该接口的前提条件是用户具有访问资源池的权限且资源池已存在。调用接口成功后,系统将返回用户当前项目下所有可访问工作空间的资源池标签信息。若用户无权限访问资源池、资源池不存在或项目未创建,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/pools/tags
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
参数解释:指定每一页查询返回的最大条目数,默认为200。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
offset |
否 |
Integer |
参数解释:分页列表的起始页,默认为0。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
tags |
Array of PoolTag objects |
参数解释:资源标签的列表。 |
状态码: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}/pools/tags
响应示例
状态码:200
查询项目下指定资源类型的所有标签。
{
"tags" : [ {
"key" : "model_version",
"values" : [ "0.1", "0.2" ]
}, {
"key" : "conda_version",
"values" : [ "10.2", "11.0" ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询项目下指定资源类型的所有标签。 |
|
400 |
参数非法。 |
|
401 |
鉴权失败。 |
|
403 |
权限不足。 |
错误码
请参见错误码。