文档

ListTagResources - 查询资源标签

更新时间:

查询指定资源标签。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nlb:ListTagResourcesRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceTypestring

资源类型。取值:

  • loadbalancer:网络型负载均衡实例。
  • securitypolicy:安全策略。
  • servergroup:服务器组。
  • listener:监听。
loadbalancer
ResourceIdarray

资源 ID。

string

资源 ID。

nlb-nrnrxwd15en27r****
Tagobject []

标签。

Keystring

标签键。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

env
Valuestring

标签值。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

product
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~50,默认值为 50

20
RegionIdstring

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

查询资源标签。

RequestIdstring

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
TagResourcesobject []

由资源及其标签组成的集合,包含了资源 ID、资源类型和标签键值等信息。

ResourceIdstring

资源 ID。

nlb-nrnrxwd15en27r****
ResourceTypestring

资源类型,取值:

  • loadbalancer:网络型负载均衡实例。
  • securitypolicy:安全策略。
  • servergroup:服务器组。
loadbalancer
RegionNostring

地域信息。

cn-hangzhou
AliUidlong

用户 UID。

1429****39299349
TagKeystring

标签键。

env
TagValuestring

标签值。

product
Scopestring

标签可见范围。

public
Categorystring

标签类型。取值:

  • Custom:自定义标签。
  • System:系统标签。
  • All:全部标签。
All
TotalCountinteger

列表条目数。

10
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TagResources": [
    {
      "ResourceId": "nlb-nrnrxwd15en27r****",
      "ResourceType": "loadbalancer",
      "RegionNo": "cn-hangzhou",
      "AliUid": 0,
      "TagKey": "env",
      "TagValue": "product",
      "Scope": "public",
      "Category": "All"
    }
  ],
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

错误码

HTTP status code错误码错误信息描述
400SystemBusySystem is busy, please try again later.系统繁忙,请稍后重试
400IllegalParam.resourceTypeThe param of resourceType is illegal.参数resourceType非法。请检查参数resourceType的输入值。
400MissingParam.%sThe parameter of %s is missing.参数%s缺失,请检查输入参数。
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.securitypolicyThe specified resource of securitypolicy is not found.找不到指定的安全策略资源。请检查输入参数。
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.找不到指定的负载均衡器资源,请检查输入参数。
404ResourceNotFound.listenerThe specified resource %s is not found.资源%s不存在。
404ResourceNotFound.serverGroupThe specified resource of serverGroup is not found.找不到指定的服务器组资源,请检查输入参数。

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

变更历史

变更时间变更内容概要操作
2023-10-30OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-10-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
    新增错误码:400
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:403
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:403
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    新增错误码:403
2023-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    删除入参:Page
    删除入参:PageSize
2023-06-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:404