更新时间:2024-03-14 GMT+08:00
分享

批量添加或删除资源标签

功能介绍

批量添加删除资源标签。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v5/{project_id}/jobs/{resource_type}/{job_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

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

resource_type

String

资源类型。

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

job_id

String

任务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
表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

操作标识(区分大小写):

  • 创建时为“create”
  • 删除时为“delete”

枚举值:

  • create
  • delete

tags

Array of objects

标签列表。最多添加20个标签。

详情请参见表4

表4 tags字段数据结构说明

参数

是否必选

参数类型

描述

key

String

标签键。

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

最小长度:1

最大长度:128

value

String

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

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

最大长度:255

响应参数

请求示例

  • 批量添加标签示例:
    https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/sync/ada96925-ceb7-4fa7-8b6f-a344f84jb201/tags/action
    
    {
      "action" : "create",
      "tags" : [ {
        "key" : "aaa",
        "value" : "bbb"
      }, {
        "key" : "test",
        "value" : "test111"
      } ]
    }
  • 批量删除标签示例:
    https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/sync/ada96925-ceb7-4fa7-8b6f-a344f84jb201/tags/action
    
    {
      "action" : "delete",
      "tags" : [ {
        "key" : "aaa",
        "value" : "bbb"
      }, {
        "key" : "test",
        "value" : "test111"
      } ]
    }

响应示例

状态码: 204

No Content

状态码

状态码

描述

204

No Content

错误码

请参见错误码

相关文档