更新时间:2024-03-27 GMT+08:00

查询资源标签

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

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

resource_type

String

资源类型。

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

枚举值:

  • migration
  • sync
  • cloudDataGuard
  • subscription
  • backupMigration
  • replay

resource_id

String

资源ID,即DRS任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

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

缺省值:application/json

X-Auth-Token

String

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

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

tags

Array of objects

标签列表。

详情请参见表4

表4 tags字段数据结构说明

参数

参数类型

描述

key

String

标签键。

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

最小长度:1

最大长度:128

value

String

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

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

最大长度:255

请求示例

查询同步任务标签。

 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

错误码

请参见错误码