接口请求域名： tat.intl.tencentcloudapi.com 。
接口用于创建注册码。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateRegisterCode。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Description | 否 | String | 注册码描述。最大长度为 128 字符。 |
| InstanceNamePrefix | 否 | String | 注册实例名称前缀。最大长度为 32 字符。 |
| RegisterLimit | 否 | Integer | 该注册码允许注册的实例数目。默认值为 10，最小值为 1，最大值为 10000。 |
| EffectiveTime | 否 | Integer | 该注册码的有效时间，单位为小时。默认值为 4。 - 若传入值小于等于 99999，则以小时为单位设置有效时间。 - 若传入值大于 99999，则设置为长期有效。 |
| IpAddressRange | 否 | String | 限制注册码只能从 IpAddressRange 所描述公网出口进行注册。 默认为空，即无任何限制。 取值应为标准 IPv4 或 CIDRv4 格式。例如 192.168.1.1 或 192.168.0.0/16。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RegisterCodeId | String | 注册码ID。 |
| RegisterCodeValue | String | 注册码值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
创建注册码-带参数。
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRegisterCode
<公共请求参数>
{
"Description": "webserver",
"InstanceNamePrefix": "webserver",
"RegisterLimit": 10,
"EffectiveTime": 4,
"IpAddressRange": "192.168.10.1/10"
}
{
"Response": {
"RegisterCodeId": "9b5rb72b-418f-4a81-b32e-f8bc80eef678",
"RegisterCodeValue": "21e9b871e123427dbee18b0cf3e0d766f91d81a9902843b7b046d7b9ffb9d45a",
"RequestId": "3f5bf8de-a51a-4ac0-8d95-ad56702cab1f"
}
}
创建注册码-无参数。
POST / HTTP/1.1
Host: tat.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.TooLarge | 参数取值过大。 |
| InvalidParameterValue.TooLong | 长度超过限制。 |
| InvalidParameterValue.TooSmall | 参数取值过小。 |
| ResourceNotFound.RoleNotFound | 角色不存在。 |
| UnauthorizedOperation.AssumeRoleUnauthorized | 角色扮演未授权。 |
文档反馈