获取实例绑定的标签

最近更新时间:2019-07-24 15:08:56

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(DescribeTagsOfInstanceIds)用于获取云数据库实例的标签信息。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTagsOfInstanceIds
Version String 公共参数,本接口取值:2017-03-20
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例列表。
Offset Integer 偏移量。
Limit Integer 每页返回多少个标签。

3. 输出参数

参数名称 类型 描述
Offset Integer 偏移量。
Limit Integer 每页返回多少个标签。
Rows Array of TagsInfoOfInstance 实例标签信息。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例标签信息

获取实例标签信息

输入示例

https://cdb.tencentcloudapi.com/?Action=DescribeTagsOfInstanceIds
&InstanceIds.0=cdb-uns231ns
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "Offset": 0,
    "Limit": 10,
    "Rows": [
      {
        "InstanceId": "cdb-uns231ns",
        "Tags": [
          {
            "TagKey": "test",
            "TagValue": "1231"
          }
        ]
      }
    ]
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
CdbError 后端错误或者流程错误。
InternalError.CdbCgwError 系统内部错误。
InternalError.CosError 获取文件信息失败。
InvalidParameter 参数错误。
OperationDenied 不允许进行操作。