tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAllScenes

Last updated: 2023-12-04 16:31:52

    1. API Description

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

    This API is used to query the list of scenes in all regions.

    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: DescribeAllScenes.
    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
    SceneInfoSet Array of SceneInfo List of scenes
    TotalCount Integer Total count 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 information of scenes in all regions

    Input Example

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

{
    "Limit": 10,
    "Offset": 0
}

    Output Example

    {
    "Response": {
        "RequestId": "22cef196-4013-493e-8acb-33a2cb629869",
        "TotalCount": 3,
        "SceneInfoSet": [
            {
                "SceneId": "lhsc-1ubg0exh",
                "DisplayName": "Test modify1",
                "Description": "Test test1"
            },
            {
                "SceneId": "lhsc-h69tuf89",
                "DisplayName": "Test",
                "Description": "Test test"
            },
            {
                "SceneId": "lhsc-1bbbtj87",
                "DisplayName": "31",
                "Description": "31"
            }
        ]
    }
}

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy