接口请求域名: tag.intl.tencentcloudapi.com 。
用于查询已建立的标签列表。
默认接口请求频率限制:60次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTags。 |
| Version | 是 | String | 公共参数,本接口取值:2018-08-13。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TagKey | 否 | String | 标签键,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签 |
| TagValue | 否 | String | 标签值,与标签键同时存在或同时不存在,不存在时表示查询该用户所有标签 |
| Offset | 否 | Integer | 数据偏移量,默认为 0, 必须为Limit参数的整数倍 |
| Limit | 否 | Integer | 每页大小,默认为 15,最大1000 |
| CreateUin | 否 | Integer | 创建者用户 Uin,不传或为空只将 Uin 作为条件查询 |
| TagKeys.N | 否 | Array of String | 标签键数组,与标签值同时存在或同时不存在,不存在时表示查询该用户所有标签,当与TagKey同时传递时只取本值 |
| ShowProject | 否 | Integer | 是否展现项目标签。1:展示 0:不展示 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 结果总数 |
| Offset | Integer | 数据位移偏量 |
| Limit | Integer | 每页大小 |
| Tags | Array of TagWithDelete | 标签列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
https://tag.intl.tencentcloudapi.com/?Action=DescribeTags
&TagKey=testTagKey
&TagValue=testTagValue
&<公共请求参数>
{
"Response": {
"TotalCount": 1,
"Offset": 0,
"Limit": 15,
"Tags": [
{
"TagKey": "key1",
"TagValue": "val1",
"CanDelete": 1
}
],
"RequestId": "0eebf6af-7ae1-44ec-9cae-3752e8bb911a"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameterValue.UinInvalid | Uin参数不合法。 |
文档反馈