文档中心 全球应用加速 API 文档 其他接口 根据标签拉取资源列表

根据标签拉取资源列表

最近更新时间:2019-08-09 19:18:45

1. 接口描述

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

本接口(DescribeResourcesByTag)用于根据标签来查询对应的资源信息,包括通道,通道组和源站。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeResourcesByTag
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
TagKey String 标签键。
TagValue String 标签值。
ResourceType String 资源类型,其中:
Proxy表示通道;
ProxyGroup表示通道组;
RealServer表示源站。
不指定该字段则查询该标签下所有资源。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 资源总数
ResourceSet Array of TagResourceInfo 标签对应的资源列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据标签拉取资源列表

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeResourcesByTag
&TagKey=testkey
&TagValue=test
&ResourceType=Proxy
&<公共请求参数>

输出示例

{
  "Response": {
    "ResourceSet": [
      {
        "ResourceType": "Proxy",
        "ResourceId": "link-12345678"
      }
    ],
    "TotalCount": 1,
    "RequestId": "5c680029-66b2-4be8-9630-7bd316ce70dd"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DuplicatedRequest 重复的请求,请检查ClientToken的值。
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误
ResourceNotFound 资源不存在
UnknownParameter 未知参数错误