帮你快速理解、总结文档立即下载
文档中心>API 中心>高性能计算平台>队列相关接口>创建注册码

创建注册码

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

本页目录：

1. 接口描述

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

本接口(GenerateRegisterCode)用于为队列创建一个注册码，注册码用于IDC机器的注册纳管。

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

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

2. 输入参数

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

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

集群ID。


示例值：hpc-kywo***a
QueueName 否 String

队列名称。


示例值：compute
ExpireSeconds 否 Integer

指定生成的注册码的过期时间, 单位为秒

取值范围：[1, 604800]

默认值：604800


示例值：3600

3. 输出参数

参数名称 类型 描述
RegisterCode String

集群队列的注册码,用于机器注册进入队列时使用

默认值：无


示例值：***0***3mwSIs**l*M****D0**9uI****md9**c3*1*j*AAN**DMn**3**PJz*m*9*vudEt-*7j
ExpireAt Integer

注册码的过期时间, unix时间戳格式


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

4. 示例

示例1 为集群指定队列生成注册码

输入示例

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

{
    "ClusterId": "hpc-kywo***a",
    "QueueName": "compute",
    "ExpireSeconds": 3600
}

输出示例

{
    "Response": {
        "ExpireAt": 1778041412,
        "RegisterCode": "***********************0*******3*m*w*SIs******l*********M****D*0**************9uI************md***9*****c3*********1*********j****A***A*N****DM**n******3**P*Jz*********m*****9*****vudEt-**7j*",
        "RequestId": "c7be8eb1-046a-4b48-9b29-535543cb9a3f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
DryRunOperation DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
InvalidParameter.Malformed 参数格式有误。
InvalidParameterValue.NotSupported 不支持该参数值。
InvalidParameterValue.ParametersNotSupported 字段不支持此值。
InvalidParameterValue.TooLong 参数长度过长。
MissingParameter 缺少参数错误。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceNotFound.ClusterId 集群不存在。
ResourceNotFound.Queue 无法找到指定队列。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
UnsupportedOperation.ClusterStatusNotSupport 该集群当前状态不支持该操作。
中国站