1. 接口描述
接口请求域名: lkeap.tencentcloudapi.com 。
用于修改已有的属性标签。 使用场景:当需要更改属性标签的名称或描述时使用,比如将“售后”标签改为“售前”。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyAttributeLabel。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-shanghai 。 |
| KnowledgeBaseId | 是 | String | 说明:知识库ID 备注:通过创建知识库接口(DeleteKnowledgeBase)得到知识库ID(KnowledgeBaseId) 示例值:34b46fe81750343723503 |
| AttributeId | 是 | String | 说明:属性ID 备注:通过CreateAttributeLabel接口创建属性时会生成AttributeId,通过ListAttributeLabels接口可查询得到AttributeId、AttributeKey、AttributeName以及LabelId、LabelName的对应关系 示例值:1830996257459865531 |
| AttributeKey | 是 | String | 说明:属性标识, 备注:仅支持英文字符,不支持数字,支持下划线。最大支持40个英文字符,如style 示例值:stlye |
| AttributeName | 是 | String | 说明:属性名称 备注:支持中英文字符。最大支持80个中英文字符,如风格 示例值:风格 |
| Labels.N | 否 | Array of AttributeLabelItem | 说明:标签ID(LabelId)以及标签名(LabelName) 备注: - 不填写LabelId,默认在当前AttributeId下新增标签值(LabelName); - 若填写该AttributeId下的LabelId以及LabelName,则为修改该LabelId对应的标签值 |
| DeleteLabelIds.N | 否 | Array of String | 说明:删除的标签id 示例值:["157622"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改属性标签
修改属性标签
输入示例
POST / HTTP/1.1
Host: lkeap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAttributeLabel
<公共请求参数>
{
"KnowledgeBaseId": "4901991032",
"AttributeId": "1830993312966182848",
"AttributeKey": "style",
"AttributeName": "风格",
"Labels": [
{
"LabelId": "1830993312978765760",
"LabelName": "主流"
},
{
"LabelId": "1830993312978765761",
"LabelName": "现代"
}
]
}
输出示例
{
"Response": {
"RequestId": "04ba0a85-161a-408a-9c80-029601af9775"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。