TagResources - 为资源关联标签--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

TagResources - 为资源关联标签

最近更新时间：2025.05.22 20:14:00首次发布时间：2024.11.20 11:13:12

为资源关联标签。

使用说明

请求频率：每秒最多调用 10 次。

请求说明

请求方式：POST
请求地址：https://private-zone.volcengineapi.com/?Action=TagResources?Version=2022-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	TagResources	要执行的操作，取值：TagResources。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
Tags	Array of Object	否	[{"Key":"key1", "Value":"value1"},{"Key":"key2", "Value":"value2"}]	域名所属的一个或多个标签。一个资源最多能关联 50 个标签。
ResourceType	String	是	zone	资源类型。 zone：域名。 endpoint：终端节点。 rule：转发规则。
ResourceIds	Array of String	是	["101", "102", "103"]	资源 ID。数组的最大长度为 50。
ProjectName	String	否	default	项目名称。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://private-zone.volcengineapi.com/?Action=TagResources&Version=2022-06-01

{
  "ResourceType": "zone",
  "ResourceIds": [
    "101"
  ],
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    },
    {
      "Key": "key2",
      "Value": "value2"
    }
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221214140553EC822FFD341E9C19EF59",
        "Action": "TagResources",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    }

}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrLimitExceeded	you've reached the limit on the number of %s that you can operate at one time	已达到单次可操作数量的上限
400	ErrServiceTagNotSupport	service tag is not support	服务标签不允许操作
400	ErrResourceNotFound	the specified resource does not exist.	指定的资源不存在
400	ErrDuplicatedTagKeys	duplicate tag keys	重复的标签键
400	ErrTagResourceFailed	%v	添加标签失败
500	ErrInternalServer	server internal error	服务内部错误