全部产品
Search

搜索本产品

    云服务器 ECS：ListTagResources - 查询资源标签

    文档中心

    云服务器 ECS：ListTagResources - 查询资源标签

    更新时间：Oct 09, 2024

    查询一个或多个EBS资源已经绑定的标签信息，或查询指定的非默认资源组内的资源ID及标签信息。

    接口说明

    请求中至少指定以下任一参数，以确定查询对象。

    • ResourceId.N
    • Tag.N（Tag.N.Key与Tag.N.Value）

    同时指定Tag.N和ResourceId.N参数时，返回结果中仅包含同时满足这两个条件的 EBS 资源。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    ResourceIdarray否

    资源 ID，最多包含 50 个子项。

    ResourceIdstring否

    资源 ID，N 的取值范围为 1~50。

    		pair-cn-c4d2t7f****
    Tagarray<object>否

    标签列表，最多包含 20 个子项

    Tagobject否
    Keystring否

    精确查找 EBS 资源时使用的标签键。标签键长度的取值范围为 1~128。N 的取值范围为 1~20。

    Tag.N参数使用说明：用于精确查找绑定了指定标签的 EBS 资源，由一个键值对组成。

    • 仅指定Tag.N.Key时，则返回关联该标签键的所有资源。

    • 仅指定Tag.N.Value，则报错InvalidParameter.TagValue。

    • 同时指定多个标签键值对时，仅同时满足所有标签键值对的 EBS 资源会被查找到。

    		tag-key
    Valuestring否

    精确查找 EBS 资源时使用的标签值。标签值长度的取值范围为 1~128。N 的取值范围为 1~20。

    		tag-value
    NextTokenstring否

    下一个查询开始 Token。

    		token123
    RegionIdstring是

    资源所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    		cn-hangzhou
    ResourceTypestring是

    资源类型定义。取值范围：

    • dedicatedblockstoragecluster：专属块存储集群。
    • diskreplicapair：异步复制关系。
    • diskreplicagroup：一致性复制组。
    		diskreplicagroup
    ClientTokenstring否

    保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多详情，请参见如何保证幂等性。

    		0c593ea1-3bea-11e9-b96b-88e9fe63****

    返回参数

    名称类型描述示例值
    object

    ListTagResourcesResponse

    NextTokenstring

    下一个查询开始 Token。

    		caeba0bbb2be03f84eb48b699f0a****
    TagResourcesarray<object>

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

    TagResourceobject
    TagKeystring

    资源的标签键。

    		TestKey
    TagValuestring

    资源的标签值。

    		TestValue
    ResourceIdstring

    资源 ID。

    		pair-cn-c4d2t7f****
    ResourceTypestring

    资源类型定义。可能值：

    • dedicatedblockstoragecluster：专属块存储集群。
    • diskreplicapair：异步复制关系。
    • diskreplicagroup：一致性复制组。
    		pair
    RequestIdstring

    请求 ID。

    		484256DA-D816-44D2-9D86-B6EE4D5B****

    示例

    正常返回示例

    JSON格式

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "TagResources": [
    {
      "TagKey": "TestKey",
      "TagValue": "TestValue",
      "ResourceId": "pair-cn-c4d2t7f****",
      "ResourceType": "pair"
    }
  ],
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5B****"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameterThe parameter %s is invalid.参数错误
    400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.参数冲突
    400InvalidParameter.FormatSpecified parameter format is not valid.返回值格式不正确（Format 不支持）。返回格式支持 XML 与 JSON，默认为 XML。
    400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
    400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键，请保持键的唯一性。
    400NumberExceed.ResourceIdsThe ResourceIds parameter number is exceed , Valid : 50参数“ResourceIds”中包含的“ResourceId”不能超过 50 个。
    400NumberExceed.TagsNumberExceed.Tags标签个数超过最大限制，本操作最多可以操作 20 个标签。
    400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.资源标签已达上限。
    400IdempotentParameterMismatchThe specified parameter has changed while using an already used clientToken.如果您提供了一个已经使用过的ClientToken，但其他请求参数有变化。
    403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
    403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
    403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.您的账户余额不足。
    403LastTokenProcessingThe last token request is processing.相同clientToken的请求正在执行，请稍后再重试。
    403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.当前用户无权限创建SLR。
    403OperationDeniedThe operation is not allowed.当前操作不允许执行。
    404InvalidApi.NotFoundSpecified api is not found, please check your url and method.找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确，请注意确认大小写。
    404InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的RegionId不存在。
    404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.指定的资源不存在，请检查参数ResourceId是否正确。
    404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.指定的资源类型不存在。
    404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
    504RequestTimeoutThe request is timeout, please try again later.该请求超时，请稍后再重试。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史