API 中心
用户之声——提建议·赢好礼> HOT
文档中心 > API 中心 > 微服务引擎 TSE > 微服务引擎相关接口 > 查询引擎实例访问地址

查询引擎实例访问地址

最近更新时间：2024-03-12 01:59:11

我的收藏

本页目录：

1. 接口描述

接口请求域名： tse.tencentcloudapi.com 。

查询引擎实例访问地址

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSREInstanceAccessAddress。
Version 是 String 公共参数，本接口取值：2020-12-07。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, na-toronto, sa-saopaulo 。
InstanceId 否 String 注册引擎实例Id
示例值：sre-12345678
VpcId 否 String VPC ID
示例值：vpc-xxxxxxxx
SubnetId 否 String 子网ID
示例值：subnet-xxxxx
Workload 否 String 引擎其他组件名称（pushgateway、polaris-limiter）
示例值：pushgateway
EngineRegion 否 String 部署地域
示例值：ap-beijing

3. 输出参数

参数名称 类型 描述
IntranetAddress String 内网访问地址
示例值：10.1.8.15
InternetAddress String 公网访问地址
示例值：10.0.0.1
EnvAddressInfos Array of EnvAddressInfo apollo多环境公网ip
ConsoleInternetAddress String 控制台公网访问地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：10.0.0.1
ConsoleIntranetAddress String 控制台内网访问地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：10.0.0.1
InternetBandWidth Integer 客户端公网带宽
注意：此字段可能返回 null，表示取不到有效值。
示例值：10
ConsoleInternetBandWidth Integer 控制台公网带宽
注意：此字段可能返回 null，表示取不到有效值。
示例值：10
LimiterAddressInfos Array of PolarisLimiterAddress 北极星限流server节点接入IP
注意：此字段可能返回 null，表示取不到有效值。
CLBMultiRegion CLBMultiRegion InternetAddress 的公网 CLB 多可用区信息
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询引擎实例访问地址

输入示例

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

{
    "InstanceId": "sre-12345678"
}

输出示例

{
    "Response": {
        "IntranetAddress": "abc",
        "InternetAddress": "abc",
        "EnvAddressInfos": [
            {
                "EnvName": "abc",
                "EnableConfigInternet": true,
                "ConfigInternetServiceIp": "abc",
                "ConfigIntranetAddress": "abc",
                "EnableConfigIntranet": true,
                "InternetBandWidth": 0
            }
        ],
        "ConsoleInternetAddress": "abc",
        "ConsoleIntranetAddress": "abc",
        "InternetBandWidth": 0,
        "ConsoleInternetBandWidth": 0,
        "LimiterAddressInfos": [
            {
                "IntranetAddress": "abc"
            }
        ],
        "CLBMultiRegion": {
            "CLBMultiZoneFlag": true,
            "CLBMasterZone": "abc",
            "CLBSlaveZone": "abc"
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.InternalError 服务内部错误。
InternalError.QueryError 查询内部错误。
InvalidParameterValue.BadRequestFormat 请求格式不正确。
InvalidParameterValue.QueryError 无效请求参数，查询失败。
ResourceNotFound 资源不存在。
中国站