ListTagsForResources - 查询标签--访问控制-火山引擎

文档中心

立即注册

导航

ListTagsForResources - 查询标签

最近更新时间：2024.10.30 16:54:19首次发布时间：2024.10.29 21:28:52

查询指定用户或角色的标签列表。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListTagsForResources	要执行的操作，取值：ListTagsForResources。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
ResourceType	String	是	User	需要查询的身份类型。User代表用户，Role代表角色。
ResourceNames.N	Array of String	否	Bob	需要查询的身份名称。
TagFilters.N.Key	Array of String	否	department	按标签过滤的标签键。多个Key之间为“与”关系，同一个Key的不同Value为“或”关系。匹配模式为精确匹配。注：标签和身份名称不能同时进行过滤。
TagFilters.N.Values.N	Array of String	否	dev	按标签过滤的标签值。多个Key之间为“与”关系，同一个Key的不同Value为“或”关系。匹配模式为精确匹配。注：标签和身份名称不能同时进行过滤。
NextToken	String	否	TDZLsdWEZDldsfEADSFdsWXZsdEWdfwXKOkdeybNSA	分页起始索引。首次请求时无需传递。
MaxResults	String	否	10	请求的最大返回数。默认为1000。

返回参数

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

参数	类型	示例值	描述
ResourceTags	Array of Object	请参考数据结构内具体参数示例值。	身份标签的数据结构。
NextToken	String	EIWsxhwSJKsOsWoPnXxahxVsdfwDfXeodfE	分页起始索引。

请求示例

GET /?Action=ListTagsForResources&Version=2018-01-01&ResourceType=User HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20241030T073616Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241030/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024103015362210115420917824B802",
    "Action": "ListTagsForResources",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "ResourceTags": [
      {
        "ResourceType": "user",
        "ResourceName": "Bob",
        "TagKey": "department",
        "TagValue": "dev"
      }
    ],
    "NextToken": "EIWsxhwSJKsOsWoPnXxahxVsdfwDfXeodfE"
  }
}

错误码

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

状态码	错误码	错误信息	说明
404	UserNotExist	User '{user}' does not exist.	用户不存在。
404	RoleNotExist	Role '{role}' does not exist.	角色不存在。