全部产品
Search
文档中心

检索分析服务Elasticsearch版:TagResources

更新时间:Sep 21, 2023

调用TagResources,创建标签资源关系。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/tags HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

Object Body

要创建的资源及标签信息。

ResourceIds Array of String Body ["es-cn-aaa","es-cn-bbb"]

资源ID列表。采用JSON数组格式,最多支持20个子项。

Tags Array Body

标签。最多可创建20个标签。

key String Body env

标签键。

value String Body IT

标签值。

ResourceType String Body INSTANCE

资源类型,固定为INSTANCE。

说明
  • Tags中如果存在key,则必须存在value(可以为空字符串),否则报错InvalidParameter.TagKey。
  • 当传入的键值对重复时,会报错Duplicate.TagKey。
  • 如果在自定义Tags之前已经存在相同的Tag key,则之前的Tag key的value值会被覆盖。

返回数据

名称

类型

示例值

描述

Result Boolean true

返回结果:

  • true:标签资源关系创建成功。
  • false:标签资源关系创建失败。
RequestId String 3D8795D9-8FF5-46B2-86E6-E3B407*******

请求ID。

示例

请求示例

POST /openapi/tags HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
    "ResourceIds":["es-cn-oew1q8bev0002****","es-cn-09k1ptccp0009****"],
    "Tags": [
        {
            "key": "env",
            "value": "IT"
        }
    ],
    "ResourceType": "INSTANCE"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "27627E6B-E26A-406F-B6E1-0247882C****"
}

错误码

访问错误中心查看更多错误码。