查询某一类资源下的标签 - ListV2ServiceTags
功能介绍
该接口适用于需要获取用户当前项目中某一类资源(如指定的Service)的标签信息的场景,例如在资源管理和监控中,用户可以通过查询标签来了解各类资源的分类和属性。通过调用此接口,用户可以获取指定Service在所有工作空间中的标签列表,但无权限的工作空间标签数据将被过滤不返回。用户必须具有足够的权限,且目标资源需存在。查询成功后,返回指定Service的标签列表;若失败,返回具体的错误信息。常见异常包括权限验证错误、资源不存在错误和参数验证错误。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts::listTags
List
-
-
modelarts:tag:list
-
URI
GET /v2/{project_id}/modelarts-service-v2/tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 账号的项目ID。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释: 工作空间ID,workspaceId将会被设置为null。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tags | Array of CombineTmsTags objects | 参数解释: 标签的融合结构,相同key合并。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签的key。 取值范围: 不涉及。 |
| 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}/v2/{project_id}/modelarts-service-v2/tags 响应示例
状态码:200
查询项目下指定资源类型的所有标签,正常返回。
{
"tags" : [ {
"key" : "model_version",
"values" : [ "0.1", "0.2" ]
}, {
"key" : "conda_version",
"values" : [ "10.2", "11.0" ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询项目下指定资源类型的所有标签,正常返回。 |
| 400 | 参数非法。 |
| 401 | 鉴权失败。 |
| 403 | 权限不足。 |
错误码
请参见错误码。