文档中心 全球应用加速 API 文档 规则相关接口 查询转发规则相关源站信息

查询转发规则相关源站信息

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

1. 接口描述

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

本接口(DescribeRuleRealServers)用于查询转发规则相关的源站信息, 包括该规则可绑定的源站信息和已绑定的源站信息。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRuleRealServers
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
RuleId String 转发规则ID

3. 输出参数

参数名称 类型 描述
TotalCount Integer 可绑定的源站个数
RealServerSet Array of RealServer 可绑定的源站信息列表
BindRealServerTotalCount Integer 已绑定的源站个数
BindRealServerSet Array of BindRealServer 已绑定的源站信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询转发规则相关源站信息

查询转发规则相关源站信息

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeRuleRealServers
&RuleId=rule-hh5xg2yd
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 2,
    "RealServerSet": [
      {
        "ProjectId": 0,
        "RealServerId": "rs-04v3s12c",
        "RealServerName": "",
        "RealServerIP": "4.4.4.4"
      },
      {
        "ProjectId": 0,
        "RealServerId": "rs-04v3s12t",
        "RealServerName": "",
        "RealServerIP": "119.28.69.101"
      }
    ],
    "BindRealServerTotalCount": 2,
    "RequestId": "aca97028-559f-4cfb-9c33-3fc2baed13b8",
    "BindRealServerSet": [
      {
        "RealServerStatus": 1,
        "RealServerPort": 234,
        "RealServerId": "rs-04v3s12c",
        "DownIPList": [],
        "RealServerWeight": 1,
        "RealServerIP": "4.4.4.4"
      },
      {
        "RealServerStatus": 1,
        "RealServerPort": 424,
        "RealServerId": "rs-10vtt5en",
        "DownIPList": [],
        "RealServerWeight": 1,
        "RealServerIP": "5.5.5.6"
      }
    ]
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误
ResourceNotFound 资源不存在