更新词库信息(仅名称/描述) - UpdateLexicons
功能介绍
功能介绍:更新词库的名称和描述信息,不支持修改词库类型。词库名称为必填项。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/content-check/lexicons/{lexicons_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识资源所属的华为云项目,用于隔离不同的租户资源。可通过用户控制台的“我的凭证”页面或调用IAM服务接口获取对应的项目ID 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 由IAM服务接口返回,为固定长度的32个字符,由数字和字母组成 默认取值: 不涉及 |
| lexicons_id | 是 | String | 参数解释: 词库的ID,唯一的资源标识,用于定位要操作的具体词库。可通过调用创建词库接口的返回值获取,或通过查询词库列表接口获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 字符类型,长度不超过64个字符 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 词库名称 约束限制: 满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]*" 取值范围: 字符类型,长度不超过64个字符 默认取值: 不涉及 |
| lexicon_desc | 否 | String | 参数解释: 词库描述 约束限制: 满足正则匹配"^[a-zA-Z0-9\(\)\(\)\-\_\u4E00-\u9FA5 ]*$" 取值范围: 字符类型,长度不超过512个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权和标识调用方身份。通过调用IAM服务“查询用户Token”接口获取,Token值为响应消息头中X-Subject-Token对应的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 词库名称 约束限制: 满足正则匹配"^[a-zA-Z\u4e00-\u9fa5]+[0-9a-zA-Z\u4e00-\u9fa5_-]*" 取值范围: 字符类型,长度不超过64个字符 默认取值: 不涉及 |
| lexicon_desc | 否 | String | 参数解释: 词库描述 约束限制: 满足正则匹配"^[a-zA-Z0-9()\(\)-_\u4E00-\u9FA5 ]*$" 取值范围: 字符类型,长度不超过512个字符 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| lexicon_id | String | 参数解释: 词库ID 取值范围: 不涉及 |
| entry_count | Integer | 参数解释: 词条数量 取值范围: 不涉及 |
| updated_at | Long | 参数解释: 更新时间,Unix时间戳,单位毫秒 取值范围: 0 ~ 9999999999999(Unix时间戳,单位毫秒) |
请求示例
更新词库名称与描述
{
"name" : "content-check-blacklist-copyright",
"lexicon_desc" : "版权侵权敏感词库"
} 响应示例
状态码:200
{
"lexicon_id" : "1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a",
"entry_count" : 0,
"updated_at" : 1787392800000
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新成功 |
错误码
请参见错误码。