批量添加资源标签 - BatchCreateV2ResourceTags
功能介绍
资源批量添加标签。此接口为同步接口,无配套使用接口。创建时,不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/{resource_type}/{resource_id}/tags/create
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:项目ID。获取方法,请参见获取项目ID。 约束限制:不涉及。 取值范围:长度为1~36的英文字符、数字和中划线的组合。 默认取值:不涉及。 |
| resource_type | 是 | Object | 参数解释:端点引擎类型列表。 约束限制:不能为空。 取值范围: 默认取值:不涉及。 |
| resource_id | 是 | String | 参数解释:标签关联的资源ID。 约束限制:不能为空。 取值范围:长度为32~36的英文字符、数字和中划线的组合。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token。 约束限制:不涉及。 取值范围:长度不超过65534个字符。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tags | 否 | Array of V2ResourceTag objects | 参数解释:批量新增请求体标签列表。 约束限制:最多20个标签。 |
| sys_tags | 否 | Array of SystemTag objects | 参数解释:系统标签列表。 约束限制:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释:资源标签的键。 约束限制:不涉及。 取值范围:长度1~128的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。 默认取值:不涉及。 |
| value | 否 | String | 参数解释:资源标签的值。 约束限制:不涉及。 取值范围:长度0~255的多语言字母、空格、数字、下划线、点、冒号、斜杠、等号、加号、减号、@符号组合。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释:系统标签键。 约束限制:不涉及。 取值范围:_sys_enterprise_project_id,企业项目ID。 默认取值:不涉及。 |
| value | 是 | String | 参数解释:系统标签值。企业项目ID,获取方法,请参见获取企业项目ID。 约束限制:不涉及。 取值范围:长度为1~64个字符。 默认取值:不涉及。 |
响应参数
状态码:204
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | AnyType | 请求成功。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
状态码:408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为0~4096个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~512个字符。 |
| solution_msg | String | 参数解释:解决方案。 取值范围:长度为0~4096个字符。 |
请求示例
批量添加资源的标签,具体请求示例如下。
POST /v2/{project_id}/{resource_type}/{resource_id}/tags/create
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
} ],
"sys_tags" : [ {
"key" : "_sys_enterprise_project_id",
"value" : "01049549-82cd-xxxx-xxxx-ddb94350c125"
} ]
} 响应示例
状态码:400
请求参数错误。
{
"error_code" : "AIDataLake.00010151",
"error_msg" : "Parameter value is invalid.",
"solution_msg" : "Please input valid parameter value."
} 状态码:401
未授权。
{
"error_code" : "APIGW.0301",
"error_msg" : "Incorrect IAM authentication information: decrypt token fail.",
"solution_msg" : "Check whether the IAM authentication information is correct."
} 状态码:403
禁止访问。
{
"error_code" : "AIDataLake.00010150",
"error_msg" : "The operation is not allowed.",
"solution_msg" : "Check whether the operation is allowed in the current status."
} 状态码:404
资源未找到。
{
"error_code" : "AIDataLake.00010009",
"error_msg" : "No resources found.",
"solution_msg" : "Enter correct resource and project IDs."
} 状态码:408
请求超时。
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
} 状态码:500
内部服务器错误。
{
"error_code" : "AIDataLake.00011001",
"error_msg" : "Internal error.",
"solution_msg" : "Contact technical support or try again later."
} 状态码
| 状态码 | 描述 |
|---|---|
| 204 | 请求成功。 |
| 400 | 请求参数错误。 |
| 401 | 未授权。 |
| 403 | 禁止访问。 |
| 404 | 资源未找到。 |
| 408 | 请求超时。 |
| 500 | 内部服务器错误。 |