1. 接口描述
接口请求域名： ivld.tencentcloudapi.com 。
更新自定义人物信息，包括姓名，简要信息，分类信息等
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateCustomPerson。 |
| Version | 是 | String | 公共参数，本接口取值：2021-09-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| PersonId | 是 | String | 待更新的自定义人物Id 示例值：person-a1b2c3 |
| Name | 否 | String | 更新后的自定义人物名称，如为空则不更新 示例值：李四 |
| BasicInfo | 否 | String | 更新后的自定义人物简介，如为空则不更新 示例值：喜剧明星 |
| CategoryId | 否 | String | 更新后的分类信息，如为空则不更新 示例值：自定义分类Id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| PersonId | String | 成功更新的自定义人物Id 示例值：person-a1b2c3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新人物姓名与基本信息
输入示例
POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateCustomPerson
<公共请求参数>
{
"PersonId": "person-Axgo3FYc",
"BasicInfo": "新测试基本信息",
"Name": "测试姓名B"
}输出示例
{
"Response": {
"PersonId": "person-Axgo3FYc",
"RequestId": "78b360f1-fe7a-4576-8ab4-d48d06d44572"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UserInvalidStatus | 用户状态异常。 |
| AuthFailure.UserNotFound | 用户无权限。 |
| AuthFailure.UserStopArrear | 用户已欠费停服。 |
| InternalError.DBConnectionError | 内部DB连接失败。 |
| InternalError.InnerError | 内部错误。 |
| InvalidParameter.InvalidCategoryId | 自定义人物类型ID不合法。 |
| InvalidParameter.InvalidName | 名称不合法。 |
| InvalidParameter.InvalidParam | 输入字段 %!s(MISSING) 不合法。 |
| InvalidParameter.InvalidPersonId | 人物ID不合法。 |
| ResourceNotFound.RecordNotFound | 记录不存在。 |
| UnauthorizedOperation.UnauthorizedProduct | 用户未激活该产品。 |