全部产品
Search

搜索本产品

    云数据库 Tair（兼容 Redis®）：ListTagResources - 查询标签列表

    文档中心

    云数据库 Tair（兼容 Redis®）：ListTagResources - 查询标签列表

    更新时间：Nov 06, 2024

    查询云数据库 Tair（兼容 Redis）实例和标签的绑定关系。

    接口说明

    该 API 对应的控制台操作请参见根据标签筛选实例和查看实例绑定的标签。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    实例所属的地域 ID。

    		cn-hangzhou
    ResourceTypestring是

    资源类型，取值固定为 INSTANCE。

    		INSTANCE
    NextTokenstring否

    下一个查询开始 Token，用来返回更多结果。

    说明 第一次查询不需要提供本参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的 NextToken 值以继续查询。
    		212db86sca4384811e0b5e8707ec2****
    ResourceIdarray否

    实例 ID 列表。

    说明
  • 本参数和 Tag 参数两者中必须传入一项。
    •
    string否

    实例 ID。

    		r-bp1zxszhcgatnx****
    Tagarray<object>否

    实例的标签信息。本参数和 ResourceId 参数两者中必须传入一项。

    object否
    Keystring否

    标签的键。

    		demokey
    Valuestring否

    标签的值。

    		demovalue

    返回参数

    名称类型描述示例值
    object

    对象。

    NextTokenstring

    如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的 token 继续查询。

    		212db86sca4384811e0b5e8707ec2****
    RequestIdstring

    请求 ID。

    		47A514A1-4B77-4E30-B4C5-2A880650****
    TagResourcesarray<object>

    实例和标签的信息。

    TagResourceobject

    对象。

    TagValuestring

    标签的值。

    		demovalue
    ResourceTypestring

    资源类型。返回值固定为ALIYUN::KVSTORE::INSTANCE，即云数据库 Tair（兼容 Redis）实例。

    		ALIYUN::KVSTORE::INSTANCE
    ResourceIdstring

    资源 ID，即实例的 ID。

    		r-bp1zxszhcgatnx****
    TagKeystring

    标签的键。

    		demokey

    示例

    正常返回示例

    JSON格式

    {
  "NextToken": "212db86sca4384811e0b5e8707ec2****",
  "RequestId": "47A514A1-4B77-4E30-B4C5-2A880650****",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "demovalue",
        "ResourceType": "ALIYUN::KVSTORE::INSTANCE",
        "ResourceId": "r-bp1zxszhcgatnx****",
        "TagKey": "demokey"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidTagKey.MalformedThe specified parameter Tag.n.Key or TagKey.n is not valid.-
    400InvalidTagValue.MalformedThe specified parameter Tag.n.Value is not valid.-
    400InvalidParameter.ResourceIdThe specified parameter ResourceId.n is not valid.-
    400MissParameter.TagOrResourceIdThe parameter Tag.n or ResourceId.n is needed.参数Tag和ResourceId不能全部为空，至少传入其中一种
    400InvalidParameter.ScopeThe specified parameter Scope is not valid.-
    400NumberExceed.ResourceIdsThe ResourceIds parameter number is exceed.-
    400NumberExceed.TagsThe Tags parameter number is exceed.-
    400Duplicate.TagKeyThe specified parameter Tag.n.Key is duplicated.-
    400InvalidParameter.ResourceTypeThe specified parameter ResourceType is not valid.-
    404InvalidDbInstanceId.NotFoundSpecified instance does not exist.指定的实例不存在

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