ListTagResources - 查询资源标签--企业组织-火山引擎

文档中心

导航

ListTagResources - 查询资源标签

最近更新时间：2025.06.23 22:21:53首次发布时间：2025.06.20 10:37:48

查询资源所附加的全部标签，支持标签按资源类型、资源ID、标签进行过滤。

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListTagResources	要执行的操作，取值：ListTagResources。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
ResourceType	String	是	account	资源类型: account, unit
ResourceIds.N	Array of String	否	ResourceIds.1=200xxx&ResourceIds.2=201xxxx	资源id，ResourceType 为 account 时传组织成员账号account_id, ResourceType 为 unit 时需要传组织单元 id 参数 - N：表示标签键的序号，取值范围：1～50。
TagFilters.N.Key	Array of String	否	TagFilters.1.Key=k1	根据标签查询资源时指定的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔，不允许重复。
TagFilters.N.Values.N	Array of String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2	根据标签查询资源时指定的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～10。多个标签值之间用&分隔。如果传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的标签。
PageSize	Integer	否	10	翻页每页大小
PageNumber	Integer	否	1	翻页页码,整数,起始值为1,默认值为1

返回参数

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

参数	类型	示例值	描述
TotalCount	Long	100	查询结果的总数
ResourceTags	Array of Object	"ResourceTags":[ { "ResourceType":"account", "ResourceId":"1", "TagKey":"key", "TagValue":"value" } ]	资源 Tag 列表
PageSize	Integer	10	翻页每页大小
PageNumber	Integer	1	翻页页码,整数,起始值为1,默认值为1

请求示例

GET /?Action=ListTagResources&Version=2022-01-01&ResourceType=account&ResourceIds.1=200xxx&ResourceIds.2=201xxxx&TagFilters.1.Key=k1&TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2
Host: https://open.volcengineapi.com
X-Date: 20250606T034949Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250606/cn-beijing/organization/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202506061152000320550161586343A8",
    "Action": "ListTagResources",
    "Version": "2022-01-01",
    "Service": "organization",
    "Region": "cn-beijing"
  },
  "Result": {
    "ResourceTags": [
      {
        "ResourceType": "account",
        "ResourceId": "20xxx0001",
        "Key": "Key",
        "Value": "LfFDtQ"
      }
    ],
    "Offset": 1,
    "Limit": 10,
    "Total": 10
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParam	The parameter %v[%v] is invalid.	参数不合法
400	ErrOrgNotExist	Org not exist.	企业组织不存在。
400	InvalidResourceId	resource not exists	资源 id 对应资源不存在
500	InternalError	Unknown internal error: %v	未知错误，根据错误信息判断详情