tencent cloud

14天试用边缘安全加速平台 EO 限时免费

Feedback

Cloud Application Rendering

DestroySession

Last updated: 2024-11-27 14:37:29

1. API Description

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

This API is used to terminate a session. If cloud-based streaming has been enabled for this session, the cloud-based streaming will end upon session termination.

A maximum of 100 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: DestroySession.
Version Yes String Common Params. The value used for this API: 2022-01-10.
Region No String Common Params. This parameter is not required for this API.
UserId Yes String Unique user ID, which is customized by you and is not parsed by CAR. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.

3. Output Parameters

Parameter Name Type Description
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 Terminating a Session

Input Example

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



{
    "UserId": "abc"
}

Output Example

{
    "Response": {
        "RequestId": "fcf4146f-64d3-496c-88dc-d12f832de313"
    }
}

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.
FailedOperation.ProcessTimeout Processing timed out.
InternalError Internal error.
InvalidParameter.JsonParseError JSON parsing error.
ResourceUnavailable.AccessFailed Failed to access the concurrency instance.
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
中国香港
+852 800 906 020 (免费)
美国
+1 844 606 0804 (免费)
英国
+44 808 196 4551 (免费)
加拿大
+1 888 605 7930 (免费)
澳大利亚
+61 1300 986 386 (免费)
EdgeOne 热线
+852 300 80699
更多本地服务热线陆续新增中