首页 云数据库 MongoDB API参考指南 API目录 标签管理 DescribeTags - 查询已有标签列表

DescribeTags - 查询已有标签列表

查询目标地域中所有的标签信息。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
RegionId string

地域ID。您可以通过调用DescribeRegions接口查询。

cn-hangzhou
ResourceType string

资源类型,取值固定为INSTANCE

INSTANCE
ResourceGroupId string

资源组ID。

dds-bp17e7a04960****
NextToken string

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

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

返回参数

名称 类型 描述 示例值
object

返回信息。

NextToken string

下一个查询开始Token。

说明 如果一次查询没有返回全部结果,则会返回本参数,您可以后续查询中传入本参数的值以继续查询。
212db86****
RequestId string

请求ID。

EEDBE38F-5CF5-4316-AAC2-35817BA60D68
Tags array

标签信息。

object

标签信息。

TagValues array

标签的值。

string

标签的值。

3.4环境
TagKey string

标签的键。

测试组

示例

正常返回示例

JSON格式

{
  "NextToken": "212db86****",
  "RequestId": "EEDBE38F-5CF5-4316-AAC2-35817BA60D68",
  "Tags": [
    {
      "TagValues": [
        "3.4环境"
      ],
      "TagKey": "测试组"
    }
  ]
}

错误码

Http code 错误码 错误信息 描述
400 InvalidTagKey.Malformed The specified parameter 'Tag.n.Key' or 'TagKey.n' is not valid. -
400 InvalidTagValue.Malformed The specified parameter 'Tag.n.Value' is not valid. -
400 InvalidParameter.ResourceId The specified parameter 'ResourceId.n' is not valid. -
400 MissParameter.TagOrResourceId The parameter 'Tag.n'' or 'ResourceId.n' is needed. -
400 InvalidParameter.Scope The specified parameter 'Scope' is not valid. -
400 NumberExceed.ResourceIds The ResourceIds parameter's number is exceed. -
400 NumberExceed.Tags The Tags parameter's number is exceed. -
400 Duplicate.TagKey The specified parameter 'Tag.n.Key' is duplicated. -
400 InvalidParameter.ResourceType The specified parameter 'ResourceType' is not valid. -
404 InvalidDbInstanceId.NotFound Specified instance does not exist. 该实例不存在,原因可能是该实例已经释放,请刷新页面。

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

阿里云首页 云数据库 MongoDB 版 相关技术圈