ListTagResources - 查询资源的标签列表--弹性伸缩-火山引擎

文档中心

立即注册

导航

ListTagResources - 查询资源的标签列表

最近更新时间：2024.05.16 10:34:05首次发布时间：2023.08.28 16:18:12

查询伸缩组的用户标签。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListTagResources	要执行的操作，取值：ListTagResources。
Version	String	是	2020-01-01	API的版本，取值：2020-01-01。
ResourceType	String	是	scalinggroup	资源类型。取值： scalinggroup：伸缩组。
ResourceIds.N	Array of String	否	scg-ybmssdnnhn5pkgyd****	资源ID。您可以调用DescribeScalingGroups 接口查询伸缩组ID。参数 - N：表示资源的序号，支持多选。取值范围：1~20。
TagFilters.N.Key	Array of String	否	k1	精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围：1~128。参数 - N：表示标签键的序号。取值：1～50。多个标签键之间用&分隔。 `TagFilters`用于精确查找绑定了指定标签的弹性伸缩资源，由一个键值对组成。仅指定本参数时，返回关联该标签键的所有资源。同时指定多个标签键时，返回同时满足所有标签键的资源。
TagFilters.N.Value	Array of String	否	v1	精确查找弹性伸缩资源时使用的标签值。标签值可以为空字符串，长度取值范围：1~128。参数 - N：表示标签值的序号。取值范围：1～50。多个标签值之间用&分隔。指定本参数时，则必须指定TagFilters.N.Key。
NextToken	String	否	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq**	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	10	分页查询时设置的每页行数，取值范围为1~100，默认为10。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq****	本次调用返回的查询凭证值，返回为空表示该页为末页。
TagResources	Array of TagResource	--	由资源及其标签组成的集合。

请求示例

GET /?Action=ListTagResources&ResourceType=scalinggroup&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T113358Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202405071934021141332092558A1FE4",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq****",
    "TagResources": [
      {
        "ResourceType": "scalinggroup",
        "ResourceId": "scg-ybmssdnnhn5pkgyd****",
        "TagKey": "k1",
        "TagValue": "v1"
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。