更新时间:2026-07-29 GMT+08:00
分享

查询资源标签 - ListInstanceTags

功能介绍

查询指定实例的标签信息。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/{resource_type}/{resource_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

resource_type

String

参数解释

DRS资源类型,用于指定需要操作标签的资源所属的业务类型。不同资源类型对应不同的DRS任务类型,查询标签时需根据实际任务类型传入对应值。

约束限制

不涉及。

取值范围

  • migration:实时迁移
  • sync:实时同步
  • cloudDataGuard:实时灾备
  • subscription:数据订阅
  • backupMigration:备份迁移
  • replay:录制回放

默认取值

不涉及。

resource_id

String

参数解释

资源ID,即DRS任务ID。用于唯一标识一个DRS任务资源,在标签管理接口中用于定位需要查询标签的具体任务。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

X-Auth-Token

String

参数解释

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制:

不涉及。

取值范围:

  • en-us:英语
  • zh-cn:中文

默认取值:

en-us

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

tags

Array of objects

参数解释

资源标签列表,包含该实例下所有标签的键值对信息。详情请参见表4

约束限制

不涉及。

取值范围

不涉及。

表4 tags字段数据结构说明

参数

参数类型

描述

key

String

参数解释

标签键。

约束限制

  • 长度为1-128个unicode字符。
  • 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。

取值范围

不涉及。

value

String

参数解释

标签值,删除标签时非必填。

约束限制

  • 最大长度255个unicode字符。
  • 可以包含任何语种字母、数字、空格和_.:=+-@。

取值范围

不涉及。

请求示例

查询同步任务标签。

 https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/sync/e6842695-3ade-4937-827b-ff92776jb20a/tags

响应示例

状态码:200

OK

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value3"
  } ]
}

状态码

状态码

描述

200

OK

其他状态请参见状态码

错误码

请参见错误码

相关文档