帮你快速理解、总结文档立即下载
文档中心>高性能计算平台>API 文档>集群相关接口>生成IDC集群节点注册命令

生成IDC集群节点注册命令

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

本页目录：

1. 接口描述

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

本接口 (GenerateRegisterCommand) 用于生成IDC集群的节点注册命令。

  • 返回的注册命令可直接在IDC机器上以root身份执行，将该机器纳管进指定的IDC集群。
  • 当Proxy=true时，系统会先确保集群专线代理就绪（自动开启终端节点并轮询至ACTIVE），再签发注册码并渲染带代理VIP的注册命令；若在超时窗口内代理仍未就绪，将返回FailedOperation.ProxyNotReady。
  • 当Proxy=false时，IDC机器需可直连集群，直接签发注册码并渲染注册命令。
  • VpcId与SubnetId需同时指定或同时不指定；仅当Proxy=true且集群未绑定VPC时二者必填。当Proxy=false时二者不生效，若仍传入将返回InvalidParameterValue.ParametersNotSupported。
  • 若集群此前已开启专线代理并绑定了VPC/子网，本次传入的VpcId/SubnetId与已绑定值不一致时，将返回UnsupportedOperation.VpcAlreadyBound（不支持改绑）。
  • 仅支持IDC类型集群，对非IDC集群调用将返回InvalidParameterValue.ParametersNotSupported。

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

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

2. 输入参数

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

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

IDC集群ID，形如hpc-xxxxxxxx。


示例值：hpc-12345678
Proxy 否 Boolean

是否通过内网专线代理连接。

  • true：IDC机器需经PrivateLink代理接入
  • false：IDC机器可直连（默认值）


    • 示例值：true
    VpcId 否 String

    私有网络ID，形如vpc-xxx。仅当Proxy=true且集群未绑定VPC时必填。与SubnetId需同时指定或同时不指定。


    示例值：vpc-aaaa1234
    SubnetId 否 String

    私有网络子网ID，形如subnet-xxx。仅当Proxy=true且集群未绑定VPC时必填。与VpcId需同时指定或同时不指定。


    示例值：subnet-bbbb5678
    QueueName 否 String

    注册码绑定的队列名称。不指定时由系统取集群默认队列。


    示例值：compute
    ExpireSeconds 否 Integer

    注册码有效期，单位：秒。默认值为604800（7天）。


    示例值：604800

    3. 输出参数

    参数名称 类型 描述
    RegisterCommand String

    渲染好的节点注册命令，可直接在IDC机器上以root身份执行。


    示例值：curl -sSL http://xxx/register.sh | bash -s -- --code eyJ...
    RegisterCode String

    节点注册码。作为不透明凭证使用，请妥善保管，仅在节点注册纳管时传入。


    示例值：eyJhbGciOiJIUzI1NiJ9...
    ExpireAt Integer

    注册码到期的Unix时间戳，单位：秒。


    示例值：1755676800
    Proxy Boolean

    回显本次是否走内网专线代理。


    示例值：true
    EndPointVip String

    代理终端节点VIP地址。当Proxy=true且终端节点就绪时非空。


    示例值：10.0.0.1
    EndPointStatus String

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

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


    • 示例值：ACTIVE
    ClusterId String

    回显集群ID。


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

    4. 示例

    示例1 生成IDC集群节点注册命令（直连）

    为可直连的IDC集群生成节点注册命令。

    输入示例

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

{
    "ClusterId": "hpc-12345678"
}

    输出示例

    {
    "Response": {
        "RegisterCommand": "curl -sSL http://xxx/register.sh | bash -s -- --code eyJ...",
        "RegisterCode": "eyJhbGciOiJIUzI1NiJ9...",
        "ExpireAt": 1755676800,
        "Proxy": false,
        "ClusterId": "hpc-12345678",
        "RequestId": "b2ac2379-6453-4eab-8f63-7ade00cb67b0"
    }
}

    示例2 生成IDC集群节点注册命令（走专线代理）

    为IDC集群生成经专线代理接入的节点注册命令。

    输入示例

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

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

    输出示例

    {
    "Response": {
        "RegisterCommand": "curl -sSL http://xxx/register.sh | bash -s -- --code eyJ...",
        "RegisterCode": "eyJhbGciOiJIUzI1NiJ9...",
        "ExpireAt": 1755676800,
        "Proxy": true,
        "EndPointVip": "10.0.0.1",
        "EndPointStatus": "ACTIVE",
        "ClusterId": "hpc-12345678",
        "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. 错误码

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

    错误码 描述
    FailedOperation.ProxyNotReady FailedOperation.ProxyNotReady
    InternalError 内部错误。
    InvalidParameter.Combination 参数组合冲突。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.ParametersNotSupported 字段不支持此值。
    MissingParameter 缺少参数错误。
    ResourceNotFound.Cluster ResourceNotFound.Cluster
    UnsupportedOperation.VpcAlreadyBound UnsupportedOperation.VpcAlreadyBound
    中国站