tencent cloud



Last updated: 2023-05-22 15:38:44

1. API Description

Domain name for API request: lighthouse.tencentcloudapi.com.

This API is used to query the list of scenes.

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: DescribeScenes.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region No String Common Params. This parameter is not required for this API.
SceneIds.N No Array of String List of scene IDs
Offset No Integer Offset. Default value: 0
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100

3. Output Parameters

Parameter Name Type Description
SceneSet Array of Scene List of scenes
TotalCount Integer Total number of scenes
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying scenes

Input Example

Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScenes
<Common request parameters>

    "Limit": 10,
    "Offset": 0

Output Example

    "Response": {
        "SceneSet": [
                "SceneId": "lhsc-abcd1235",
                "DisplayName": "Test1",
                "Description": "Test test1",
        "TotalCount": 1,
        "RequestId": "4836c744-4de2-44c0-ba5c-096ccf8c923f"

5. Developer Resources


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
AuthFailure Error with CAM signature/authentication.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.InvalidSceneIdMalformed Invalid scene ID
InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
MissingParameter Missing parameter.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support