1. 接口描述
接口请求域名： tat.tencentcloudapi.com 。
接口用于创建注册码。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateRegisterCode。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Description | 否 | String | 注册码描述。 示例值：此注册码用于注册托管实例。 |
| InstanceNamePrefix | 否 | String | 注册实例名称前缀。 示例值：register-test |
| RegisterLimit | 否 | Integer | 该注册码允许注册的实例数目。默认限制为10个。 示例值：100 |
| EffectiveTime | 否 | Integer | 该注册码的有效时间，单位为小时。默认为4小时。 示例值：2 |
| IpAddressRange | 否 | String | 该注册码限制tat_agent只能从IpAddressRange所描述公网出口进行注册。默认不做限制。 示例值：133.12.234.0/24 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RegisterCodeId | String | 注册码ID。 示例值：d0b7xxxx-a6xx-40x9-898x-44c9f508axxx |
| RegisterCodeValue | String | 注册码值。 示例值：5xx127965b0b498195xxxxx80ad926c53e1xxxx3d85e41e0ad93555941111111 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建注册码-带参数
创建注册码-带参数。
输入示例
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRegisterCode
<公共请求参数>
{
"Description": "test",
"InstanceNamePrefix": "test",
"RegisterLimit": 0,
"EffectiveTime": 0,
"IpAddressRange": "192.168.10.1/10"
}输出示例
{
"Response": {
"RegisterCodeId": "9b5rb72b-418f-4a81-b32e-f8bc80eef678",
"RegisterCodeValue": "21e9b871e123427dbee18b0cf3e0d766f91d81a9902843b7b046d7b9ffb9d45a",
"RequestId": "3f5bf8de-a51a-4ac0-8d95-ad56702cab1f"
}
}示例2 创建注册码-无参数
创建注册码-无参数。
输入示例
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRegisterCode
<公共请求参数>
{}输出示例
{
"Response": {
"RegisterCodeId": "9b5rb72b-418f-4a81-b32e-f8bc80eef678",
"RegisterCodeValue": "21e9b871e123427dbee18b0cf3e0d766f91d81a9902843b7b046d7b9ffb9d45a",
"RequestId": "2e8bf8de-a51a-4ac0-8d95-ad56702cab1f"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.TooLong | 长度超过限制。 |
| ResourceNotFound.RoleNotFound | 角色不存在。 |
| UnauthorizedOperation.AssumeRoleUnauthorized | 角色扮演未授权。 |