删除标签

最近更新时间:2018-06-04 11:10:00

删除标签(DeleteTags)

描述

为指定资源删除指定标签。

删除标签时,需要指定待删除标签的资源类型及其资源Id,可指定标签分类(可缺省)和标签名称/值(可缺省);删除标签成功,返回成功,否则返回报错信息。

约束1:在删除标签时,如果不指定标签分类和标签名称/值,则相应资源身上的全部标签被删除。

约束2:在删除标签时,如果指定标签分类但不指定标签名称/值,则只要相应资源上的标签分类与输入标签分类匹配成功,相应标签即被删除;如果标签名称/值为空字符串,则只有资源上的标签分类匹配且标签名称/值为空字符串才会被删除。

约束3:这个openAPI通常在DescribeTags后面被调用,因此如果找不到指定资源上的指定标签,不会特殊返回出错信息。

返回API概览

请求参数

名称 类型 必须 长度限制(字符) 参数格式 描述
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:DeleteTags
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 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不存在

示例(调用成功)

给实例删除两个标签,其中一个标签只指定标签分类,另一个标签既指定标签名分类也指定标签名称/值

请求示例

https://tag.api.ksyun.com/?Action=DeleteTags
&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
&公共请求参数

返回示例

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

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

免费注册