接口功能介绍
为指定文件系统实例添加标签,支持添加单个和多个标签。
接口约束
1.只能为已创建的文件系统绑定标签,刚创建的文件系统需要等待1-2分钟后才能绑定标签
2.单个实例最多添加10个标签
3.每个资源下的标签键是唯一的,不可绑定相同标签键。 如果尝试添加已有标签键,则对应的标签值会更新为新值。 例如:某资源先绑定了 city:shanghai,后续如果绑定city:newyork,则city:shanghai自动被解绑;修改标签键等同于解绑旧标签键值的同时绑定新标签键
4.当输入的是当前账号下不存在的标签时,将创建新的标签并为实例绑定
5.在一次请求中,不允许出现相同的key
6.当前仅部分资源池支持使用标签管理功能,具体参见产品能力地图
URI
POST /v4/sfs/update-label
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sfsUID | 是 | String | 弹性文件唯一资源id | 0b55feb9-1331-5934-bf66-9155b7371731 | |
regionID | 是 | String | 资源池(区域)ID | 332232eb-63aa-465e-9028-52e5123866f0 | |
labelList | 是 | Array of Objects | 标签和相应的操作类型 | LabelList |
表 LabelList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
key | 是 | String | 标签键。不能为空首字符不能为空格,长度不超过32个字符 | hello | |
value | 是 | String | 标签值。不能为空首字符不能为空格,长度不超过32个字符 | world | |
operateType | 是 | String | 操作类型 绑定 BIND 解绑 UNBIND | BIND |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
returnObj | Object | 返回对象 | returnObj | |
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | String | 响应描述,一般为英文描述 | 参考[响应示例] | |
description | String | 响应描述,一般为中文描述 | 参考[响应示例] | |
errorCode | String | 业务细分码,为 product.module.code 三段式码.参考[结果码],出错时才返回 | 参考[结果码] | |
error | String | 业务细分码,为Product.Module.Code三段式码大驼峰形式,出错时才返回 | 参考[结果码] |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
code | String | 返回状态码(800为成功,其他为失败) | 800 | |
success | Boolean | true为成功,false为失败 | true |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsUID":"0b55feb9-1331-5934-bf66-9155b7371731",
"labelList":
[
{
"key":"hezzzzzz",
"value":"llllll",
"operateType":"BIND"
},
{
"key":"test_key2",
"value":"test_value2",
"operateType":"UNBIND"
}
]
}
响应示例
{
"returnObj": {"code": "800", "success": true},
"message": "success",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码