1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
用户更新集成信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateUserKey。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值：asf2342-afds |
| Name | 否 | String | 用户密钥名称 示例值：密钥对1 |
| KeyID | 否 | String | 用户密钥对标识，前半部分用户填写，后半部分平台按照一定规则生成 示例值：poiuas8_098asdfaf |
| Description | 否 | String | 密钥对描述 示例值：这是个密钥对 |
| AuthTypeCode | 否 | String | 授权类型code 示例值：asdfd |
| Ext | 否 | String | 根据授权类型的不同，ext会有不同的子结构 示例值：{"aa":"bb"} |
| Business | 否 | String | 业务类型，integration：从集成中心来的，默认为空，表示是从授权管理中心来的 示例值：integration |
| RuntimeConfig | 否 | AgentRuntimeConfig | 创建集成时创建对应的示例代码云函数需要的参数 |
| DemoCodeFunctionName | 否 | String | 创建集成时创建对应的示例代码云函数需要的函数名 示例值：wx-pay-test-f6j0jhst-demo-scfweb |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UpdateResult | Integer | 更新记录条数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 用户更新密钥对
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateUserKey
<公共请求参数>
{
"Name": "创建密钥对",
"KeyID": "adsrte-af342rfasdf",
"AuthTypeCode": "code_template",
"EnvId": "af13qfas-rasdfasdf",
"Ext": ""
}输出示例
{
"Response": {
"RequestId": "3b8b63a8-1b70-11f0-9cf9-fa6cef78999d",
"UpdateResult": 1
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ThirdServiceError | 请求第三方服务，第三方服务返回报错信息 |
| InternalError | 内部错误。 |
| InternalError.Database | 数据库错误。 |
| InternalError.Timeout | 服务超时。 |
| InvalidParameter | 参数格式或类型错误，如 Uin、EnvId、Domain 缺失或非法。 |
| InvalidParameter.EnvId | 环境ID非法。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
