帮你快速理解、总结文档立即下载
文档中心>API 中心>高性能计算平台>集群相关接口>查询IDC集群专线代理状态

查询IDC集群专线代理状态

最近更新时间：2026-09-04 02:01:02
我的收藏

本页目录：

1. 接口描述

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

本接口 (DescribeClusterDedicatedProxy) 用于查询IDC集群专线/VPN代理的状态。

  • 返回终端节点（EndPoint）的当前状态，包括是否就绪、VIP地址等信息。
  • 若代理未开通，EndPointReady返回false，EndPointStatus为UNKNOWN。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeClusterDedicatedProxy。
Version 是 String 公共参数，本接口取值：2023-03-21。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-nanjing, ap-shanghai 。
ClusterId 是 String

集群ID。


示例值：hpc-12345678

3. 输出参数

参数名称 类型 描述
Enabled Boolean

代理是否已开通。true表示已开通，false表示从未开通。


示例值：true
EndPointId String

终端节点ID。未开通代理时为空。


注意：此字段可能返回 null，表示取不到有效值。
示例值：vpce-12345678
EndPointVip String

终端节点VIP地址。未开通代理时为空。


注意：此字段可能返回 null，表示取不到有效值。
示例值：10.0.0.1
EndPointReady Boolean

终端节点是否就绪。true表示已就绪可用，false表示未就绪或未开通。


示例值：true
EndPointStatus String

终端节点状态。取值范围：

  • ACTIVE：已激活
  • BINDCHANGE：变更中
  • BINDINGCREATE：创建中
  • BINDINGDELETE：删除中
  • ABNORMAL：异常
  • UNKNOWN：未知
  • ASSUME_ROLE_FAILED：授权失败


    • 注意：此字段可能返回 null，表示取不到有效值。
    示例值：ACTIVE
    LastKnownStatus String

    上次同步的终端节点状态（DB记录值）。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：ACTIVE
    EndPointServiceId String

    终端节点服务ID。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：vpcsvc-xxx
    VpcId String

    私有网络ID。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：vpc-aaaa1234
    SubnetId String

    子网ID。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：subnet-bbbb5678
    CreateTime String

    代理创建时间。未开通时为空。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2026-06-01 10:00:00
    LastSyncTime String

    上次状态同步时间。cron未同步过时为null。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2026-06-11 14:00:00
    RealtimeQueryTime String

    本次实时查询时间。未开通时为空。


    注意：此字段可能返回 null，表示取不到有效值。
    示例值：2026-06-11 14:56:39
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询已开通代理的IDC集群

    查询一个已开通专线代理的IDC集群的代理状态信息。

    输入示例

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

{
    "ClusterId": "hpc-12345678"
}

    输出示例

    {
    "Response": {
        "Enabled": true,
        "EndPointId": "vpce-12345678",
        "EndPointVip": "10.0.0.1",
        "EndPointReady": true,
        "EndPointStatus": "ACTIVE",
        "LastKnownStatus": "ACTIVE",
        "EndPointServiceId": "vpcsvc-xxx",
        "VpcId": "vpc-aaaa1234",
        "SubnetId": "subnet-bbbb5678",
        "CreateTime": "2026-06-01 10:00:00",
        "LastSyncTime": "2026-06-11 14:00:00",
        "RealtimeQueryTime": "2026-06-11 14:56:39",
        "RequestId": "b2ac2379-6453-4eab-8f63-7ade00cb67b0"
    }
}

    示例2 查询未开通代理的IDC集群

    查询一个未开通专线代理的IDC集群。

    输入示例

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

{
    "ClusterId": "hpc-87654321"
}

    输出示例

    {
    "Response": {
        "Enabled": false,
        "EndPointReady": false,
        "RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue 参数取值错误。
    ResourceNotFound.Cluster ResourceNotFound.Cluster
    中国站