tencent cloud

Low-code Interactive Classroom

LCIC 정책
개인 정보 보호 정책
계약 데이터 처리 및 보안 계약
Service Agreement
Service Level Agreement
문서Low-code Interactive Classroom

DescribeUser

포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-30 21:46:41

1. API Description

Domain name for API request: lcic.intl.tencentcloudapi.com.

This API is used to obtain user profile.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeUser.
Version Yes String Common Params. The value used for this API: 2022-08-17.
Region No String Common Params. This parameter is not required.
UserId Yes String User ID

3. Output Parameters

Parameter Name Type Description
SdkAppId Integer The application ID.
UserId String User ID
Name String Username
Avatar String URL of user profile photo.
OriginId String User's Id in the client system
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 This API is used to obtain user profile.

Input Example

POST / HTTP/1.1
Host: lcic.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUser
<Common request parameters>

{
    "UserId": "xx"
}

Output Example

{
    "Response": {
        "Name": "xx",
        "UserId": "xx",
        "Avatar": "xx",
        "SdkAppId": 1,
        "RequestId": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
ResourceNotFound.User The user does not exist.
다음 주제: 개인 정보 보호 정책

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백