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

开启IDC集群专线代理

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

本页目录：

1. 接口描述

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

本接口 (EnableClusterDedicatedProxy) 用于开启IDC集群的专线/VPN代理。

  • 开启后，系统将自动创建VPC终端节点（EndPoint），实现IDC集群与云上VPC的网络互通。
  • 若代理已开通，重复调用将幂等返回已有EndPoint信息。
  • SubnetId与VpcId需同时指定或同时不指定。若不指定，则使用集群已绑定的VPC和子网。

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

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

2. 输入参数

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

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

集群ID。


示例值：hpc-12345678
VpcId 否 String

私有网络ID，形如vpc-xxx。可通过调用DescribeVpcs获取。若不指定，则使用集群已绑定的VPC。


示例值：vpc-aaaa1234
SubnetId 否 String

私有网络子网ID，形如subnet-xxx。可通过调用DescribeSubnets获取。与VpcId需同时指定或同时不指定。


示例值：subnet-bbbb5678

3. 输出参数

参数名称 类型 描述
EndPointId String

终端节点ID。


示例值：vpce-12345678
EndPointVip String

终端节点VIP地址。


示例值：10.0.0.1
EndPointReady Boolean

终端节点是否就绪。true表示已就绪，false表示未就绪。


示例值：true
EndPointStatus String

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

  • ACTIVE：已激活
  • BINDCHANGE：变更中
  • BINDINGCREATE：创建中
  • BINDINGDELETE：删除中


    • 示例值：ACTIVE
    VpcId String

    私有网络ID。


    示例值：vpc-aaaa1234
    SubnetId String

    子网ID。


    示例值：subnet-bbbb5678
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 开启IDC集群专线代理

    开启IDC集群的专线/VPN代理，在指定VPC和子网中创建终端节点。

    输入示例

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

{
    "ClusterId": "hpc-12345678",
    "VpcId": "vpc-aaaa1234",
    "SubnetId": "subnet-bbbb5678"
}

    输出示例

    {
    "Response": {
        "EndPointId": "vpce-12345678",
        "EndPointVip": "10.0.0.1",
        "EndPointReady": true,
        "EndPointStatus": "ACTIVE",
        "VpcId": "vpc-aaaa1234",
        "SubnetId": "subnet-bbbb5678",
        "RequestId": "b2ac2379-6453-4eab-8f63-7ade00cb67b0"
    }
}

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.CreateEndpointFailed InternalError.CreateEndpointFailed
    InternalError.EndpointServiceWhitelistFailed InternalError.EndpointServiceWhitelistFailed
    InvalidParameterValue 参数取值错误。
    ResourceNotFound.Cluster ResourceNotFound.Cluster
    UnsupportedOperation.ClusterAcceptOtherRequest 集群资源正在处理其他请求。
    UnsupportedOperation.RegionDedicatedProxyDisabled UnsupportedOperation.RegionDedicatedProxyDisabled
    UnsupportedOperation.RegionNotSupportDedicatedProxy UnsupportedOperation.RegionNotSupportDedicatedProxy
    UnsupportedOperation.VpcAlreadyBound UnsupportedOperation.VpcAlreadyBound
    中国站