全部产品
Search
文档中心

弹性伸缩:TagResources

更新时间:May 09, 2024

调用API TagResources为指定的弹性伸缩资源列表统一创建并绑定标签,可以帮助您更好地管理和分类资源,通过标签了解资源使用情况,提高资源利用率。

接口说明

  • 伸缩组最多支持绑定20个标签。

    说明 绑定标签前,阿里云会校验资源已有标签数量。超过限制值时返回报错信息。

  • 如果Tag.N.Propagate参数设置为true时,伸缩组设置的标签只会同步传播到伸缩组中即将新创建的实例上,而不会传播到已经在伸缩组中运行的实例上。
  • 如果伸缩配置设置了标签,且将伸缩组设置的标签进行传播,则即将新创建的实例标签预期如下:
    • 包含伸缩配置与伸缩组设置传播的所有标签。
    • 如果伸缩配置设置的标签与伸缩组传播的标签具有相同的标签键,则伸缩组传播的标签会被伸缩配置设置的标签覆盖。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String TagResources

系统规定参数。取值:TagResources

RegionId String cn-hangzhou

资源所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

ResourceType String scalinggroup

资源类型定义,目前仅支持伸缩组。取值:scalinggroup。

ResourceId.N String asg-2zej7nf7hea77k5a****

资源ID。N的取值范围:1~50。

Tag.N.Key String TestKey

资源的标签键。N的取值范围:1~20。

一旦输入该值,则不允许为空字符串。最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

Tag.N.Value String TestValue

资源的标签值。N的取值范围:1~20。

输入该值时,可以为空字符串。最多支持128个字符,不能包含http://或者https://

Tag.N.Propagate Boolean false

标识该标签是否为可传播标签,取值范围:

  • true:伸缩组上的标签只会传播到即将新创建的实例上,不会传播到已经在伸缩组中运行的实例上。
  • false:伸缩组上的标签不会传播到实例上。

默认值:false。

返回数据

名称

类型

示例值

描述

RequestId String 74C4E313-8570-479F-8791-DC25360D****

请求ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=TagResources
&RegionId=cn-hangzhou
&ResourceType=scalinggroup
&ResourceId=["asg-2zej7nf7hea77k5a****"]
&Tag=[{"Key":"TestKey","Value":"TestValue","Propagate":false}]
&公共请求参数

正常返回示例

XML格式

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

<TagResourcesResponse>
    <RequestId>74C4E313-8570-479F-8791-DC25360D****</RequestId>
</TagResourcesResponse>

JSON格式

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

{
  "RequestId" : "74C4E313-8570-479F-8791-DC25360D****"
}

错误码

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