CreateTags--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

CreateTags

最近更新时间：2024.11.01 18:49:26首次发布时间：2023.03.03 16:32:18

调用 CreateTags 接口为一个或多个资源添加标签。

调试

API Explorer

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

去调试

注意事项

标签的更多信息，请参见标签概述。
单个资源最多可以添加50个标签，单次调用该接口最多支持添加20个标签。
为同一个资源重复添加相同标签键的标签，则新标签值会自动覆盖原标签值。
“删除中”的资源不允许添加标签。

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	CreateTags	要执行的操作，取值：CreateTags。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ResourceType	String	是	volume	资源类型，取值： volume：云盘。
ResourceIds.N	String	是	ResourceIds.1=vol-76pwr6rilv8lzwxv**&ResourceIds.2=vol-76pwr6rilv8lzwxv**	需要绑定标签的资源ID。说明如下： ResourceIds.N：`N`表示资源的序号，取值范围：1～50。多个资源之间用`&`分隔。
Tags.N.Key	String	是	Tags.1.Key=tag	需要创建的标签键。 Tags.N.Key：`N`表示标签键的序号。取值范围：1～20。多个标签键之间用`&`分隔。命名规则如下：不能以任何大小写形式的`volc:`或`sys:`开头，`volc:`或`sys:`开头为系统预留标签键，禁止创建。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度限制在1～128个字符之间。
Tags.N.Value	String	否	Tags.1.Value=test	标签的标签值。 Tags.N.Value：`N`表示标签值的序号。取值范围：1～20。多个标签值之间用`&`分隔。命名规则如下：只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。允许为空，长度限制在0～256个字符之间。

返回数据

名称	类型	示例值	描述
OperationDetails	Array of Struct	-	操作详情，详情为空表示创建成功。

请求示例

GET /?Action=CreateTags&Version=2020-04-01&ResourceType=volume&ResourceIds.1=vol-76pwr6rilv8lzwxv*****&ResourceIds.2=vol-76pwr6rilv8lzwxv****&Tags.1.Key=tag&Tags.1.Value=test HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

成功返回示例

{
    "ResponseMetadata": {
        "RequestId": "202303031059488DC8442420A69FB06C4E",
        "Action": "CreateTags",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "OperationDetails": []
    }
}

失败返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230303112058C237F8584025A6A60F6C",
        "Action": "CreateTags",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing",
        "Error": {
            "Code": "ErrPartTagFailed",
            "Message": "部分资源创建Tag失败"
        }
    },
    "Result": null
}

错误码

HttpCode	错误码	错误信息
400	ErrTagServiceUnable	tag服务禁用
400	ErrTagNotFound	tag参数为空
400	InvalidTagKeyConflict	tag参数重复
400	ErrInvalidTagCount	tag数量过多
400	ErrInvalidTagKey	tag key非法
400	ErrInvalidTagValue	tag value非法
400	ErrTagKeyNotFound	tag key为空
400	ErrInvalidResourceIdNotFound	resource id为空
400	ErrMaximumResourceIds	resource id数量过多
400	ErrResourceTypeNotFound	resource type为空
400	ErrResourceTypeUnknown	resource type未知
400	ErrInvalidTagKeyCount	tag key数量过多
400	ErrInvalidAccountId	account id非法
400	ErrSystemTagExceedQuota	system tag已达上限
400	ErrCustomTagExceedQuota	custom tag已达上限
400	ErrResourceExcluded	资源状态错误
400	ErrResourceNotFound	资源不存在
400	ErrPartTagFailed	部分资源创建Tag失败
400	ErrCallTagPlatform	访问tag平台失败
400	ErrQueryTagDB	db 持久化失败