创建标签

最近更新时间:2019-12-27 15:32:20

创建标签(CreateTags)

描述

为指定资源创建新标签或者覆盖更新旧标签。

创建或者更新标签时,需要指定标签分类、标签名称/值、待创建或更新标签的资源类型及其资源Id;创建或者更新标签成功,返回成功,否则返回报错信息。

约束1:每个资源最多拥有20个标签。

约束2:每个资源身上的标签分类不能重复。

返回API概览

请求参数

名称 类型 必须 长度限制(字符) 参数格式 描述
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:CreateTags
Resource.N Resource 数组 必选参数,待创建或者更新标签的资源对象数组(列表)
Tag.N Tag 数组 必选参数,新创建或者更新覆盖的标签对象数组(列表),其中每个标签的分类和名称必须被设置,如果暂未确定标签名称,可将标签名称设置为“空字符串”

返回元素(调用成功)

名称 类型 描述
Return Boolean 调用成功返回true

错误码(调用不成功)

错误代码(Code) 错误消息(Message) HTTP 状态码 中文描述(语义)
MissingParameter A required parameter for the specified action is not supplied. 400 忘记必选参数%s,具体参数名在%s说明
InvalidParameter An invalid parameter in Tags[number]: "%s", must be one of: Key, Value 400 标签[数字]的参数%s不合法,应为Key或者Value
InvalidParameter An invalid parameter in Resources[number]: "%s", must be one of: Type,Id 400 资源[数字]的参数%s不合法,应为Type或者Id
InvalidParameterValue Tags[number] value cannot be null, use empty string instead. 400 标签[数字]的名称不能为空,请使用空字符串代替
InvalidParameterValue An invalid or out-of-range resource type value %s for Resources[number] was supplied. 400 资源[数字]的资源类型输入值%s无效、不合法或者超出范围,具体输入值在%s说明
NoSuchResourceId The input ‘ResourceId’ %s of Resources[number] does not exist. 409 资源[数字]的资源标识%s不存在
TagLimitExceeded The request was rejected because it attempted to create tags beyond limit for Resources[number]. 409 资源[数字]拥有的标签数量超过限制(每个资源最多10个标签)

示例(调用成功)

给实例添加(覆盖更新)两个标签,其中一个标签只有标签分类没有标签名称/值,另一个标签既有标签分类也有标签名称/值

请求示例

https://tag.api.ksyun.com/?Action=CreateTags
&Resource.1.Type=kec-instance
&Resource.1.Id=314bbaa0-6ea3-4042-ae58-4d499a0a607b
&Tag.1.Key=Department
&Tag.1.Value=Testing
&Tag.2.Key=Usage
&Tag.2.Value=
&公共请求参数

返回示例

  • XML格式
<CreateTagsResponse xmlns="https://tag.ksyun.com/doc/2016-03-04/">
    <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
    <Return>true</Return>
</CreateTagsResponse>
  • JSON示例
{
  "RequestId":"7a62c49f-347e-4fc4-9331-6e8eEXAMPLE",
  "Return":"true"
}

金山云,开启您的云计算之旅

免费注册