数字身份管控平台（员工版）获取应用信息-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： eiam.tencentcloudapi.com 。

获取一个应用的信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
本文档展示的是V1签名的参数说明，腾讯云建议您使用安全系数更高的V3签名算法，使用签名方法 v3 时，公共参数需要统一放到 HTTP Header 请求头部中，详情。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeApplication。
Version	是	String	公共参数，本接口取值：2021-04-20。
Region	否	String	公共参数，本接口不需要传递此参数。
ApplicationId	否	String	应用id，是应用的全局唯一标识，与ClientId参数不能同时为空。
ClientId	否	String	客户端id，与ApplicationId参数不能同时为空。

3. 输出参数

参数名称	类型	描述
KeyId	String	密钥id。注意：此字段可能返回 null，表示取不到有效值。
DisplayName	String	应用展示名称，长度限制：64个字符。默认与应用名字相同。注意：此字段可能返回 null，表示取不到有效值。
LastModifiedDate	String	应用最后修改时间，符合 ISO8601 标准。注意：此字段可能返回 null，表示取不到有效值。
ClientId	String	客户端id。注意：此字段可能返回 null，表示取不到有效值。
ApplicationType	String	应用类型，即创建应用时所选择的应用模板类型。注意：此字段可能返回 null，表示取不到有效值。
CreatedDate	String	应用创建时间，符合 ISO8601 标准。注意：此字段可能返回 null，表示取不到有效值。
ApplicationId	String	应用id，是应用的全局唯一标识。注意：此字段可能返回 null，表示取不到有效值。
TokenExpired	Integer	令牌有效时间，单位为秒。注意：此字段可能返回 null，表示取不到有效值。
ClientSecret	String	客户端secret。注意：此字段可能返回 null，表示取不到有效值。
PublicKey	String	公钥信息。注意：此字段可能返回 null，表示取不到有效值。
AuthorizeUrl	String	授权地址。注意：此字段可能返回 null，表示取不到有效值。
IconUrl	String	应用图标图片访问地址。注意：此字段可能返回 null，表示取不到有效值。
SecureLevel	String	安全等级。注意：此字段可能返回 null，表示取不到有效值。
AppStatus	Boolean	应用状态。注意：此字段可能返回 null，表示取不到有效值。
Description	String	描述。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

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

{
    "ApplicationId": "xxx"
}

输出示例

{
  "Response": {
    "RequestId": "efe4663a-f71b-498d-a270-0cca0c69f743",
    "ApplicationId": "52edd4a7-cd07-4ab1-8f33-8bb537179ba2",
    "DisplayName": "测试API网关应用",
    "CreatedDate": "2020-05-28T02:09:57.343+00:00",
    "LastModifiedDate": "2020-11-26T03:41:21.891+00:00",
    "ApplicationType": "API",
    "TokenExpired": "4800",
    "ClientId": "xxx",
    "ClientSecret": "xxx",
    "KeyId": "xxx",
    "PublicKey": "{\"kty\":\"RSA\",\"kid\":\"xxx\",\"use\":\"sig\",\"alg\":\"RS256\",\"n\":\"xxx\",\"e\":\"AQAB\"}",
    "AuthorizeUrl": "https://xxx.com/auth/oauth2/authorize?client_id=xxx&response_type=code&state=xxx",
    "IconUrl": "https://online-xxxxxxx.cos.ap-shenzhen-fsi.myqcloud.com/xxxxxxxx/...",
    "SecureLevel": "1",
    "AppStatus": true,
    "Description": "xxxxxxxxxxxxx"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.AppNotExist	应用不存在。
FailedOperation.OperationError	操作失败。
InvalidParameterValue.ParameterIllegal	参数不合法。

获取应用信息

本页目录：