查询资源标签 - ShowV2ServiceTags
功能介绍
该接口适用于需要获取资源(如模型、数据集、服务等)的标签信息的场景,例如在资源管理或分类中,用户可以通过查询标签来了解资源的用途、状态或其他属性。通过调用此接口,用户可以通过资源ID获取指定资源的所有标签列表。用户必须具有足够的权限,且目标资源需存在。查询成功后,返回资源的标签列表;若失败,返回具体的错误信息。常见异常包括权限验证错误、资源不存在错误和参数验证错误。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v2/{project_id}/modelarts-service-v2/{resource_id}/tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 账号的项目ID。 默认取值: 不涉及。 |
| resource_id | 是 | String | 参数解释: 待创建标签的资源ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释: 工作空间ID,workspaceId将会被设置为null。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tags | Array of TmsTag objects | 参数解释: 资源标签返回列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键字段。 约束限制: 不涉及。 取值范围: 长度为1~128,标签的键可以包含任意语种字母、数字、空格,以及_ . : = + - @特殊字符,但首尾不能含有空格,不能以_sys_开头。 默认取值: 不涉及。 |
| value | String | 参数解释: 标签值字段。 约束限制: 字母、数字、下划线、点、斜杠、等号、加号、减号和@符号。 取值范围: 长度为0~255。 默认取值: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
请求示例
查询资源标签。
https://{endpoint}/v2/{project_id}/service/a55eba18-1ebf-4e9a-8229-d2d3b593a3dc/tags 响应示例
状态码:200
正常查询返回。
{
"tags" : [ {
"key" : "test",
"value" : "service-gpu"
}, {
"key" : "model_version",
"value" : "0.1"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 正常查询返回。 |
| 400 | 请求参数不合法。 |
| 401 | 鉴权非法。 |
| 403 | 权限不足。 |
| 404 | 资源未找到。 |
错误码
请参见错误码。