GetTags - 查询标签键值对--资源管理-火山引擎

文档中心

立即注册

导航

GetTags - 查询标签键值对

最近更新时间：2025.06.25 14:19:10首次发布时间：2023.08.24 21:41:31

查询标签键值对

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetTags	要执行的操作，取值：GetTags。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
MaxResults	Integer	否	10	获取的资源数量。传参值必须在[0,1000]区间
TagKeys.N	Array of String	否	tagkey	标签键列表。最多允许传入10个标签键
TagType	String	否	system	查询的标签类型。可传值：system（系统标签）、custom（客户标签），不传或传其他值，则代表查询所有类型的标签
CountResources	Boolean	否	true	是否返回标签绑定的资源数量
NextToken	String	否	eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjQ2NzEsIlNpZ25hdHVyZSI6ImE0MjhkYmMzZmU3Njk1NzA5ZGJhNmQxYTU1NWQ5YjZiOTMxMjgzNTNlZGFhYzFmMWRhNjJiY2MyOGUzYWE2M2IifQ==	请求下一页资源数据的Token。不传则认为是获取第一页的数据

返回参数

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

参数	类型	示例值	描述
Tags	Array of Object	[ { "Key": "tagkey", "Value": "tagvalue", "Type": "Custom" } ]	标签结果列表
NextToken	String	eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjQ4MjIsIlNpZ25hdHVyZSI6IjBkMjJlNjM2MTZjYmJkZTBjMjQzNTQ0Nzk1OGE2M2RkMWQzMDQ3MDEwMWRhY2QxNTdmZDRiNjlkNjFkMTdlZWYifQ==	请求下一页数据的NextToken参数，返空则代表没有更多的数据

请求示例

GET /?Action=GetTags&Version=2022-06-01&MaxResults=10&TagKeys.1=tagkey&TagType=system&CountResources=true&NextToken=eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjQ2NzEsIlNpZ25hdHVyZSI6ImE0MjhkYmMzZmU3Njk1NzA5ZGJhNmQxYTU1NWQ5YjZiOTMxMjgzNTNlZGFhYzFmMWRhNjJiY2MyOGUzYWE2M2IifQ%3D%3D HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20250623T040842Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250623/cn-beijing/tag/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250623120859238037137253B9828B",
    "Action": "GetTags",
    "Version": "2022-06-01",
    "Service": "tag",
    "Region": "cn-beijing"
  },
  "Result": {
    "Tags": [
      {
        "Key": "3t9uwT6Z",
        "Value": "LTou6x9Bq",
        "Type": "1rX",
        "ResourcesNum": 452
      }
    ],
    "NextToken": "eyJOZXh0SW5mbyI6IntcIklEXCI6NzgzODg2MzV9IiwiU2lnblRpbWUiOjE2OTIyNjQ4MjIsIlNpZ25hdHVyZSI6IjBkMjJlNjM2MTZjYmJkZTBjMjQzNTQ0Nzk1OGE2M2RkMWQzMDQ3MDEwMWRhY2QxNTdmZDRiNjlkNjFkMTdlZWYifQ=="
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	Invalid.%s	The parameter %s is invalid.	请求参数不合法。具体不合法参数见错误描述信息，请参阅API文档查看对应参数的传参要求
400	InvalidParameter.%s	The specified parameter %s is invalid.	请求参数不合法。具体不合法参数见错误描述信息，请参阅API文档查看对应参数的传参要求
400	InvalidParameter.%s.%s	The specified parameter %s.%s is invalid.	请求参数不合法。具体不合法参数见错误描述信息，请参阅API文档查看对应参数的传参要求
500	InternalError	The request processing has failed because of an internal error.	服务内部系统错误。往往是由服务内部组件异常、网络异常或服务自身bug导致，请及时联系相关管理员进行排查确认