更新资源标签--内容分发网络-火山引擎

文档中心

立即注册

导航

更新资源标签

最近更新时间：2024.06.28 19:18:53首次发布时间：2022.02.15 21:49:57

通过 API 请求更新指定加速域名的标签组，修改完成后，域名所携带的标签会变更为当次提交的标签组。标签可用于域检索、数据查询筛选等场景。

使用限制

节流限制：您每秒最多可以发送 20 个请求。

一个加速域名最多可拥有 10 个标签，标签由键值对组成，不能重复。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=UpdateResourceTags&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `UpdateResourceTags`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Resources	String[]	是	需要新增标签的加速域名列表，最多可填充 50 个域名。	`www.example.com`
ResourceTags	Object[]	是	需要添加的标签内容，一次最多可新增 10 个标签。若域名本身已有标签，由于整体域名仅支持 10 个标签，可能出现超出限制的情况，会导致报错。

响应正文

由于该 API 没有响应参数，响应正文只有包含请求元数据的 ResponseMetadata 结构体，没有 Result 结构体。

请求示例

POST https://cdn.volcengineapi.com/?Action=UpdateResourceTags&Version=2021-03-01
{  
    "Resources":[  
        "www.example1.com",  
        "www.example2.com"  
    ],  
    "ResourceTags":[  
        {  
            "Key":"testuserKey",  
            "Value":"testuserValue"  
        }  
    ]  
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202112021518060102121500340D014E83",
    "Action": "UpdateResourceTags",
    "Version": "2021-03-01",
    "Service": "CDN",
    "Region": "cn-north-1"
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。