DescribeScenes

Download PDF

Last updated:2026-03-05 16:27:10

DescribeScenes

Last updated: 2026-03-05 16:27:10

Download PDF

1. API Description

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

This API is used to query scenario details.

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-10-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
SceneIds.N	No	Array of String	Scene ID array. The maximum per request is 100. Parameters must not specify both `SceneIds` and `Filters` simultaneously.
Filters.N	No	Array of Filter	Filter criteria - scene-id - String - required: no - (filter condition) filter by the scene id. -scene-name - String - required: no - (filtering conditions) filter by scenario name. -created-by - String - required: no - (filter criteria) filter by scene creator, currently only support TAT, representing public scenarios. The maximum number of `Filters` per request is 10, and that of `Filter.Values` is 5. the `SceneIds` and `Filters` parameters cannot be specified at the same time.
Limit	No	Integer	Number of returned results, defaults to 20 with a maximum value of 100. for further introduction about `Limit`, see relevant sections in the API overview.
Offset	No	Integer	Offset. The default value is `0`. For more information on `Offset`, see the relevant section in API Introduction.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of eligible scenarios.
SceneSet	Array of Scene	List of scenario details.
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 Query Scenario

Input Example

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

{
    "SceneIds": [
        "sc-12345678"
    ],
    "Offset": 0,
    "Limit": 20
}

Output Example

{
    "Response": {
        "RequestId": "eb973a12-71e3-4c0c-b1d8-4b863e5f5daf",
        "TotalCount": 1,
        "SceneSet": [
            {
                "SceneId": "sc-12345678",
"SceneName": "Ops scenario"
                "CreatedBy": "TAT",
                "CreatedTime": "2020-11-02T02:48:11+00:00",
                "UpdatedTime": "2020-11-02T02:48:11+00:00"
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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.
InvalidFilter	Invalid Filter
InvalidParameter	Invalid parameter.
InvalidParameter.ConflictParameter	Conflicting parameters.
InvalidParameterValue	Invalid parameter value.
InvalidParameterValue.InvalidFilter	Invalid filter.
InvalidParameterValue.InvalidSceneId	Invalid scenario ID.
InvalidParameterValue.InvalidSceneName	Invalid scenario name.
LimitExceeded.FilterValueExceeded	Too many `Filter` values.
UnauthorizedOperation.CamAuthFailed	CAM authentication failed.
UnauthorizedOperation.MFAExpired	The Multi-factor authentication (MFA) code expired.
UnauthorizedOperation.MFANotFound	Multi-factor authentication (MFA) does not exist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud