TagResources--云监控-火山引擎

文档中心

立即注册

导航

TagResources

最近更新时间：2025.04.14 15:23:32首次发布时间：2025.04.14 14:43:15

为资源批量绑定标签。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=TagResources&Version=2018-01-01

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	TagResources	接口名称。当前 API 的名称为 `TagResources`。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 `2018-01-01`。
ResourceIds	Array of String	否	["188906***48"]	绑定标签的资源列表，当前为告警策略 ID 列表。
ResourceType	String	否	rule	绑定标签的资源类型，当前仅支持`rule`，即告警策略。
Tags	Array of ResourceTag	否	-	与资源绑定的标签详情。

ResourceTag

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Key	String	否	doc	标签键。支持中文、英文大写字母、英文小写字母、数字和空格。支持以下特殊字符`_.:/=+-@`。不能以空格为开头或结尾。 `volc:`和`/sys:`为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的`volc:`和`/sys:`。标签键的长度需为 1～128 个字符。
Value	String	否	demo	标签值。支持中文、英文大写字母、英文小写字母、数字和空格。支持以下特殊字符`_.:/=+-@`。不能以空格为开头或结尾。标签键的长度需为 0～255 个字符。

Key

String

否

doc

标签键。

支持中文、英文大写字母、英文小写字母、数字和空格。
支持以下特殊字符_.:/=+-@。
不能以空格为开头或结尾。
volc:和/sys:为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的volc:和/sys:。
标签键的长度需为 1～128 个字符。

Value

String

否

demo

标签值。

支持中文、英文大写字母、英文小写字母、数字和空格。
支持以下特殊字符_.:/=+-@。
不能以空格为开头或结尾。
标签键的长度需为 0～255 个字符。

请求示例

POST https://open.volcengineapi.com?Action=TagResources&Version=2018-01-01
Content-Type: application/json
{
    "ResourceIds": [
        "188906***48"
    ],
    "ResourceType": "rule",
    "Tags": [
        {
            "Key": "doc",
            "Value": "demo"
        }
    ]
}

返回参数

参数	类型	示例值	描述
Data	Object of TagResourcesResp	-	返回内容。

TagResourcesResp

参数	类型	示例值	描述
FailedResources	Array of String	["188906***12"]	绑定标签失败的资源 ID 列表。仅在请求失败时不为空。
SucceedResources	Array of String	["188906***48"]	绑定标签成功的资源 ID 列表。

返回示例

{
    "ResponseMetadata": {
        "Action": "TagResources",
        "Region": "cn-beijing",
        "Service": "Volc_Observe",
        "Version": "2018-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Data": {
            "FailedResources": [
                "188906***12"
            ],
            "SucceedResources": [
                "188906***48"
            ]
        }
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码。