根据标签拉取资源列表

最近更新时间:2024-03-12 01:31:57

我的收藏

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
TotalCount Integer 资源总数
示例值:1
ResourceSet Array of TagResourceInfo 标签对应的资源列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcesByTag
<公共请求参数>

{
    "ResourceType": "Proxy",
    "TagKey": "testkey",
    "TagValue": "test"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation.DuplicatedRequest 重复的请求,请检查ClientToken的值。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnknownParameter 未知参数错误。