帮你快速理解、总结文档立即下载

用户获取指定集成的详情信息

最近更新时间:2026-10-23 02:59:55
我的收藏

1. 接口描述

接口请求域名: tcb.tencentcloudapi.com 。

用户获取集成详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:GetOneUserKey。
Version 是 String 公共参数,本接口取值:2018-06-08。
Region 否 String 公共参数,本接口不需要传递此参数。
EnvId 是 String

环境ID


示例值:asf2342-afds
KeyID 否 String

用户密钥对标识,前半部分用户填写,后半部分平台按照一定规则生成


示例值:poiuas8_098asdfaf
Business 否 String

业务场景来源,默认不传,表示来源授权中心,integration表示来源集成中心,当从集成中心请求时必传integration


示例值:integration
NeedPwd 否 Boolean

是否需要加密字段的值,true:是,false:否,默认不传,不需要

默认值:false

当为true时,返回加密字段的值,前端进行按约定解密


示例值:false

3. 输出参数

参数名称 类型 描述
UserKeyInfo APIsUserKeyInfo

单个密钥对详情页

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 用户获取密钥对详情

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetOneUserKey
<公共请求参数>

{
    "EnvId": "tcb-paas-e2e-main-vfc3g64mbqt7",
    "KeyID": "create_key_2"
}

输出示例

{
    "Response": {
        "RequestId": "0b403204-36c4-11f0-857c-fa6cef78999d",
        "UserKeyInfo": {
            "AuthTypeCode": "PublicAccountOpenService",
            "AuthTypeName": "公众号开放能力",
            "BindServiceList": {
                "Apis": [],
                "Mcp": []
            },
            "Description": "",
            "Ext": "{\"appId\":\"wx2fc2dd428840ae3d\",\"appsecret\":\"\"}",
            "KeyID": "create_key_2",
            "Name": "更新密钥对",
            "Status": "已发布"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InternalError.Database 数据库错误。
InternalError.Timeout 服务超时。
InvalidParameter 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。
InvalidParameter.EnvId 环境ID非法。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。