当前位置:主页 > 查看内容

全球应用加速 查询源站信息 - API 文档

发布时间:2021-10-12 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: gaap.tencentcloudapi.com 。 本接口(DescribeRealServers)用于查询源站信息,可以根据项目名查询所有的源站信息,此外支持指定IP或者域名的源站模糊查询。 默认接口请求频率限制:20次/秒。 推荐使用 API Explorer 点击调试 A……

1. 接口描述

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

本接口(DescribeRealServers)用于查询源站信息,可以根据项目名查询所有的源站信息,此外支持指定IP或者域名的源站模糊查询。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRealServers。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,本接口不需要传递此参数。
ProjectId Integer 查询源站的所属项目ID,-1表示所有项目
SearchValue String 需要查询的源站IP或域名,支持模糊匹配
Offset Integer 偏移量,默认值是0
Limit Integer 返回数量,默认为20个,最大值为50个
TagSet.N Array of TagPair 标签列表,当存在该字段时,拉取对应标签下的资源列表。
最多支持5个标签,当存在两个或两个以上的标签时,满足其中任意一个标签时,源站会被拉取出来。
Filters.N Array of Filter 过滤条件。filter的name取值(RealServerName,RealServerIP)

3. 输出参数

参数名称 类型 描述
RealServerSet Array of BindRealServerInfo 源站信息列表
TotalCount Integer 查询得到的源站数量
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询源站信息

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeRealServers
&ProjectId=0
&SearchValue='1.1.1.1'
&<公共请求参数>

输出示例

{
  "Response": {
    "RealServerSet": [
      {
        "RealServerId": "rs123",
        "RealServerIP": "1.1.1.1",
        "RealServerName": "rsname",
        "ProjectId": 0,
        "TagSet": []
      }
    ],
    "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。

  • Tencent Cloud SDK 3.0 for Python
  • Tencent Cloud SDK 3.0 for Java
  • Tencent Cloud SDK 3.0 for PHP
  • Tencent Cloud SDK 3.0 for Go
  • Tencent Cloud SDK 3.0 for NodeJS
  • Tencent Cloud SDK 3.0 for .NET
  • Tencent Cloud SDK 3.0 for C++
  • Tencent Cloud SDK 3.0 for Ruby

命令行工具

  • Tencent Cloud CLI 3.0

6. 错误码

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

错误码 描述
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceUnavailable 资源不可用。
UnknownParameter 未知参数错误。

本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!
上一篇:安装 - 对象存储 OSS 下一篇:没有了

推荐图文

  • 周排行
  • 月排行
  • 总排行

随机推荐